|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.restlet.Restlet
org.restlet.routing.Filter
org.restlet.engine.application.Encoder
public class Encoder
Filter compressing entities. The best encoding is automatically selected
based on the preferences of the client and on the encoding supported by NRE:
GZip, Zip and Deflate.
If the Representation
has an unknown size,
it will always be a candidate for encoding. Candidate representations need to
respect media type criteria by the lists of accepted and ignored media types.
Concurrency note: instances of this class or its subclasses can be invoked by
several threads at the same time and therefore must be thread-safe. You
should be especially careful when storing state in member variables.
Field Summary |
---|
Fields inherited from class org.restlet.routing.Filter |
---|
CONTINUE, SKIP, STOP |
Constructor Summary | |
---|---|
Encoder(Context context,
boolean encodingRequest,
boolean encodingResponse,
EncoderService encoderService)
Constructor. |
Method Summary | |
---|---|
void |
afterHandle(Request request,
Response response)
Allows filtering after its handling by the target Restlet. |
int |
beforeHandle(Request request,
Response response)
Allows filtering before its handling by the target Restlet. |
Representation |
encode(ClientInfo client,
Representation representation)
Encodes a given representation if an encoding is supported by the client. |
Encoding |
getBestEncoding(ClientInfo client)
Returns the best supported encoding for a given client. |
EncoderService |
getEncoderService()
Returns the parent encoder service. |
List<Encoding> |
getSupportedEncodings()
Returns the list of supported encodings. |
boolean |
isEncodingRequest()
Indicates if the request entity should be encoded. |
boolean |
isEncodingResponse()
Indicates if the response entity should be encoded. |
Methods inherited from class org.restlet.routing.Filter |
---|
doHandle, getNext, handle, hasNext, setNext, setNext, start, stop |
Methods inherited from class org.restlet.Restlet |
---|
createFinder, finalize, getApplication, getAuthor, getContext, getDescription, getFinderClass, getLogger, getName, getOwner, handle, handle, handle, isStarted, isStopped, setAuthor, setContext, setDescription, setFinderClass, setName, setOwner |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Encoder(Context context, boolean encodingRequest, boolean encodingResponse, EncoderService encoderService)
context
- The context.encodingRequest
- Indicates if the request entities should be encoded.encodingResponse
- Indicates if the response entities should be encoded.encoderService
- The parent encoder service.Method Detail |
---|
public void afterHandle(Request request, Response response)
afterHandle
in class Filter
request
- The request to filter.response
- The response to filter.public int beforeHandle(Request request, Response response)
beforeHandle
in class Filter
request
- The request to filter.response
- The response to filter.
public Representation encode(ClientInfo client, Representation representation)
client
- The client preferences to use.representation
- The representation to encode.
public Encoding getBestEncoding(ClientInfo client)
client
- The client preferences to use.
public EncoderService getEncoderService()
public List<Encoding> getSupportedEncodings()
EncodeRepresentation.getSupportedEncodings()
static method.
public boolean isEncodingRequest()
public boolean isEncodingResponse()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |