Package org.exoplatform.services.rest.impl.header

Class MediaTypeHelper

java.lang.Object
org.exoplatform.services.rest.impl.header.MediaTypeHelper
public final class MediaTypeHelper extends Object
Version:
$Id: $
Author:
Andrey Parfonov

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT
    Default media type.
    static final javax.ws.rs.core.MediaType
    DEFAULT_TYPE
    Default media type.
    static final List<javax.ws.rs.core.MediaType>
    DEFAULT_TYPE_LIST
    List which contains default media type.
    static final Comparator<javax.ws.rs.core.MediaType>
    MEDIA_TYPE_COMPARATOR
    Compare two mimetypes.
    static final String
    WADL
    WADL media type.
    static final javax.ws.rs.core.MediaType
    WADL_TYPE
    WADL media type.

  • Method Summary

    Modifier and Type
    Method
    Description
    static List<javax.ws.rs.core.MediaType>
    createConsumesList(javax.ws.rs.Consumes mime)
    Create a list of media type for given Consumes annotation.
    static List<javax.ws.rs.core.MediaType>
    createProducesList(javax.ws.rs.Produces mime)
    Create a list of media type for given Produces annotation.
    static boolean
    isConsume(List<javax.ws.rs.core.MediaType> consumes, javax.ws.rs.core.MediaType contentType)
    Useful for checking does method able to consume certain media type.
    static float
    processQuality(List<javax.ws.rs.core.MediaType> accept, List<javax.ws.rs.core.MediaType> produces)
    Looking for accept media type with the best quality.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • MEDIA_TYPE_COMPARATOR

      public static final Comparator<javax.ws.rs.core.MediaType> MEDIA_TYPE_COMPARATOR
      Compare two mimetypes. The main rule for sorting media types is :

      • n / m
      • n / *
      • * / *

      Method that explicitly list of media types is sorted before a method that list * / *.

    • DEFAULT

      public static final String DEFAULT
      Default media type. It minds any content type.
      See Also:

    • DEFAULT_TYPE

      public static final javax.ws.rs.core.MediaType DEFAULT_TYPE
      Default media type. It minds any content type.

    • DEFAULT_TYPE_LIST

      public static final List<javax.ws.rs.core.MediaType> DEFAULT_TYPE_LIST
      List which contains default media type.

    • WADL

      public static final String WADL
      WADL media type.
      See Also:

    • WADL_TYPE

      public static final javax.ws.rs.core.MediaType WADL_TYPE
      WADL media type.

  • Method Details

    • createConsumesList

      public static List<javax.ws.rs.core.MediaType> createConsumesList(javax.ws.rs.Consumes mime)
      Create a list of media type for given Consumes annotation. If parameter mime is null then list with single element DEFAULT_TYPE will be returned.
      Parameters:
      mime - the Consumes annotation.
      Returns:
      ordered list of media types.

    • createProducesList

      public static List<javax.ws.rs.core.MediaType> createProducesList(javax.ws.rs.Produces mime)
      Create a list of media type for given Produces annotation. If parameter mime is null then list with single element DEFAULT_TYPE will be returned.
      Parameters:
      mime - the Produces annotation.
      Returns:
      ordered list of media types.

    • isConsume

      public static boolean isConsume(List<javax.ws.rs.core.MediaType> consumes, javax.ws.rs.core.MediaType contentType)
      Useful for checking does method able to consume certain media type.
      Parameters:
      consumes - list of consumed media types
      contentType - should be checked
      Returns:
      true contentType is compatible to one of consumes, false otherwise

    • processQuality

      public static float processQuality(List<javax.ws.rs.core.MediaType> accept, List<javax.ws.rs.core.MediaType> produces)
      Looking for accept media type with the best quality. Accept list of media type must be sorted by quality value.
      Parameters:
      accept - See AcceptMediaType, QualityValue
      produces - list of produces media type, See Produces
      Returns:
      quality value of best found compatible accept media type or 0.0 if media types are not compatible