Package org.restlet.service

Class EncoderService

java.lang.Object
org.restlet.service.Service
org.restlet.service.EncoderService
public class EncoderService extends Service
Application service automatically encoding or compressing request entities.
Author:
Jerome Louvel

  • Field Details

    • ANY_SIZE

      public static final int ANY_SIZE
      Indicates if the encoding should always occur, regardless of the size.
      See Also:

    • DEFAULT_MINIMUM_SIZE

      public static final int DEFAULT_MINIMUM_SIZE
      Indicates if the default minimum size for encoding to occur.
      See Also:

  • Constructor Details

    • EncoderService

      public EncoderService()
      Constructor.

    • EncoderService

      public EncoderService(boolean enabled)
      Constructor. The default minimum size
      Parameters:
      enabled - True if the service has been enabled.

  • Method Details

    • getDefaultAcceptedMediaTypes

      public static List<MediaType> getDefaultAcceptedMediaTypes()
      Returns the list of default encoded media types. This can be overridden by subclasses. By default, all media types are encoded (except those explicitly ignored).
      Returns:
      The list of default encoded media types.

    • getDefaultIgnoredMediaTypes

      public static List<MediaType> getDefaultIgnoredMediaTypes()
      Returns the list of default ignored media types. This can be overridden by subclasses. By default, all archive, audio, image and video media types are ignored.
      Returns:
      The list of default ignored media types.

    • canEncode

      public boolean canEncode(Representation representation)
      Indicates if a representation can be encoded.
      Parameters:
      representation - The representation to test.
      Returns:
      True if the call can be encoded.

    • createInboundFilter

      public Filter createInboundFilter(Context context)
      Description copied from class: Service
      Create the filter that should be invoked for incoming calls.
      Overrides:
      createInboundFilter in class Service
      Parameters:
      context - The current context.
      Returns:
      The new filter or null.

    • createOutboundFilter

      public Filter createOutboundFilter(Context context)
      Description copied from class: Service
      Create the filter that should be invoked for outgoing calls.
      Overrides:
      createOutboundFilter in class Service
      Parameters:
      context - The current context.
      Returns:
      The new filter or null.
      See Also:

    • getAcceptedMediaTypes

      public List<MediaType> getAcceptedMediaTypes()
      Returns the media types that should be encoded.
      Returns:
      The media types that should be encoded.

    • getIgnoredMediaTypes

      public List<MediaType> getIgnoredMediaTypes()
      Returns the media types that should be ignored.
      Returns:
      The media types that should be ignored.

    • getMinimumSize

      public long getMinimumSize()
      Returns the minimum size a representation must have before compression is done.
      Returns:
      The minimum size a representation must have before compression is done.

    • setMinimumSize

      public void setMinimumSize(long mininumSize)
      Sets the minimum size a representation must have before compression is done.
      Parameters:
      mininumSize - The minimum size a representation must have before compression is done.