Package | Description |
---|---|
org.restlet |
Core classes of the API.
|
org.restlet.data |
Information exchanged by components.
|
org.restlet.representation |
Common representation data elements.
|
org.restlet.resource |
Client and server resource classes.
|
org.restlet.routing |
Classes related to call routing.
|
org.restlet.service |
Services used by applications and components.
|
org.restlet.util |
Various utility classes.
|
Modifier and Type | Method and Description |
---|---|
Representation |
Message.getEntity()
Returns the entity representation.
|
Modifier and Type | Method and Description |
---|---|
void |
Message.setEntity(Representation entity)
Sets the entity representation.
|
Constructor and Description |
---|
Component(Representation xmlConfigRepresentation)
Deprecated.
Use XML support in the Spring extension instead.
|
Message(Representation entity)
Constructor.
|
Request(Method method,
Reference resourceRef,
Representation entity)
Constructor.
|
Request(Method method,
java.lang.String resourceUri,
Representation entity)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
Representation |
ReferenceList.getTextRepresentation()
Returns a representation of the list in the "text/uri-list" format.
|
Representation |
ReferenceList.getWebRepresentation()
Returns a representation of the list in "text/html" format.
|
Representation |
Form.getWebRepresentation()
Returns the form as a Web representation
(MediaType.APPLICATION_WWW_FORM).
|
Representation |
Form.getWebRepresentation(CharacterSet characterSet)
Returns the form as a Web representation
(MediaType.APPLICATION_WWW_FORM).
|
Constructor and Description |
---|
Form(Representation webForm)
Constructor.
|
Form(Representation webForm,
boolean decode)
Constructor.
|
ReferenceList(Representation uriList)
Constructor from a "text/uri-list" representation.
|
Modifier and Type | Class and Description |
---|---|
class |
AppendableRepresentation
Represents an appendable sequence of characters.
|
class |
BufferingRepresentation
Representation capable of buffering the wrapped representation.
|
class |
ByteArrayRepresentation
Representation wrapping a byte array.
|
class |
ChannelRepresentation
Representation based on a NIO byte channel.
|
class |
CharacterRepresentation
Representation based on a BIO character stream.
|
class |
DigesterRepresentation
Representation capable of computing a digest.
|
class |
EmptyRepresentation
Empty representation with no content.
|
class |
FileRepresentation
Representation based on a static file.
|
class |
InputRepresentation
Transient representation based on a BIO input stream.
|
class |
ObjectRepresentation<T extends java.io.Serializable>
Representation based on a serializable Java object.
|
class |
OutputRepresentation
Representation based on a BIO output stream.
|
class |
ReadableRepresentation
Transient representation based on a readable NIO byte channel.
|
class |
ReaderRepresentation
Transient representation based on a BIO characters reader.
|
class |
StreamRepresentation
Representation based on a BIO stream.
|
class |
StringRepresentation
Represents an Unicode string that can be converted to any character set
supported by Java.
|
class |
WritableRepresentation
Representation based on a writable NIO byte channel.
|
class |
WriterRepresentation
Representation based on a BIO characters writer.
|
Constructor and Description |
---|
BufferingRepresentation(Representation bufferedRepresentation)
Constructor.
|
DigesterRepresentation(Representation wrappedRepresentation)
Constructor.
|
DigesterRepresentation(Representation wrappedRepresentation,
java.lang.String algorithm)
Constructor.
|
ObjectRepresentation(Representation serializedRepresentation)
Constructor reading the object from a serialized representation.
|
ObjectRepresentation(Representation serializedRepresentation,
java.lang.ClassLoader classLoader)
Constructor reading the object from a serialized representation.
|
ObjectRepresentation(Representation serializedRepresentation,
java.lang.ClassLoader classLoader,
boolean variantObjectBinarySupported,
boolean variantObjectXmlSupported)
Constructor reading the object from a serialized representation.
|
Modifier and Type | Method and Description |
---|---|
Representation |
ClientResource.delete()
Deletes the target resource and all its representations.
|
protected Representation |
ServerResource.delete()
Deletes the resource and all its representations.
|
Representation |
ClientResource.delete(MediaType mediaType)
Deletes the target resource and all its representations.
|
protected Representation |
ServerResource.delete(Variant variant)
Deletes the resource and all its representations.
|
protected Representation |
ServerResource.describeVariants()
Describes the available variants to help client-side content negotiation.
|
protected Representation |
ServerResource.doConditionalHandle()
Handles a call by first verifying the optional request conditions and
continue the processing if possible.
|
protected Representation |
ServerResource.doHandle()
Effectively handles a call without content negotiation of the response
entity.
|
protected Representation |
ServerResource.doHandle(org.restlet.engine.resource.MethodAnnotationInfo annotationInfo,
Variant variant)
Effectively handles a call with content negotiation of the response
entity using an annotated method.
|
protected Representation |
ServerResource.doHandle(Variant variant)
Effectively handles a call with content negotiation of the response
entity.
|
protected Representation |
ServerResource.doNegotiatedHandle()
Effectively handles a call with content negotiation of the response
entity.
|
Representation |
ClientResource.get()
Represents the resource using content negotiation to select the best
variant based on the client preferences.
|
protected Representation |
ServerResource.get()
Returns a full representation.
|
Representation |
ClientResource.get(MediaType mediaType)
Represents the resource using a given media type.
|
protected Representation |
ServerResource.get(Variant variant)
Returns a full representation for a given variant.
|
Representation |
Directory.getIndexRepresentation(Variant variant,
ReferenceList indexContent)
Returns an actual index representation for a given variant.
|
Representation |
Resource.getRequestEntity()
Returns the request entity representation.
|
Representation |
Resource.getResponseEntity()
Returns the response entity representation.
|
Representation |
ClientResource.handle()
Handles the call by invoking the next handler.
|
abstract Representation |
Resource.handle()
Handles the call composed of the current context, request and response.
|
Representation |
ServerResource.handle()
Handles any call to this resource.
|
protected Representation |
ClientResource.handle(Method method)
Handles the call by cloning the prototype request, setting the method and
entity.
|
protected Representation |
ClientResource.handle(Method method,
MediaType mediaType)
Handles the call by cloning the prototype request, setting the method and
entity.
|
protected Representation |
ClientResource.handle(Method method,
Representation entity)
Handles the call by cloning the prototype request, setting the method and
entity.
|
protected Representation |
ClientResource.handle(Method method,
Representation entity,
ClientInfo clientInfo)
Handles the call by cloning the prototype request, setting the method and
entity.
|
protected Representation |
ClientResource.handle(Method method,
Representation entity,
MediaType mediaType)
Handles the call by cloning the prototype request, setting the method and
entity.
|
Representation |
ClientResource.handleInbound(Response response)
Handles the inbound call.
|
Representation |
ClientResource.head()
Represents the resource using content negotiation to select the best
variant based on the client preferences.
|
protected Representation |
ServerResource.head()
Returns a representation whose metadata will be returned to the client.
|
Representation |
ClientResource.head(MediaType mediaType)
Represents the resource using a given media type.
|
protected Representation |
ServerResource.head(Variant variant)
Returns a representation whose metadata will be returned to the client.
|
Representation |
ClientResource.options()
Describes the resource using content negotiation to select the best
variant based on the client preferences.
|
protected Representation |
ServerResource.options()
Indicates the communication options available for this resource.
|
Representation |
ClientResource.options(MediaType mediaType)
Describes the resource using a given media type.
|
protected Representation |
ServerResource.options(Variant variant)
Indicates the communication options available for this resource.
|
Representation |
ClientResource.patch(java.lang.Object entity)
Patches a resource with the given object as delta state.
|
Representation |
ClientResource.patch(java.lang.Object entity,
MediaType mediaType)
Patches a resource with the given object as delta state.
|
Representation |
ClientResource.patch(Representation entity)
Patches a resource with the given representation as delta state.
|
protected Representation |
ServerResource.patch(Representation entity)
Apply a patch entity to the current representation of the resource
retrieved by calling
ServerResource.get() . |
protected Representation |
ServerResource.patch(Representation entity,
Variant variant)
Apply a patch entity to the current representation of the resource
retrieved by calling
ServerResource.get() . |
Representation |
ClientResource.post(java.lang.Object entity)
Posts an object entity.
|
Representation |
ClientResource.post(java.lang.Object entity,
MediaType mediaType)
Posts an object entity.
|
Representation |
ClientResource.post(Representation entity)
Posts a representation.
|
protected Representation |
ServerResource.post(Representation entity)
Posts a representation to the resource at the target URI reference.
|
protected Representation |
ServerResource.post(Representation entity,
Variant variant)
Posts a representation to the resource at the target URI reference.
|
Representation |
ClientResource.put(java.lang.Object entity)
Puts an object entity.
|
Representation |
ClientResource.put(java.lang.Object entity,
MediaType mediaType)
Puts an object entity.
|
Representation |
ClientResource.put(Representation entity)
Creates or updates a resource with the given representation as new state
to be stored.
|
protected Representation |
ServerResource.put(Representation entity)
Creates or updates a resource with the given representation as new state
to be stored.
|
protected Representation |
ServerResource.put(Representation representation,
Variant variant)
Creates or updates a resource with the given representation as new state
to be stored.
|
Representation |
Resource.toRepresentation(java.lang.Object source)
Converts an object into a representation based on the default converter
service variant.
|
Representation |
Resource.toRepresentation(java.lang.Object source,
MediaType target)
Converts an object into a representation based on a given media type.
|
Representation |
Resource.toRepresentation(java.lang.Object source,
Variant target)
Converts an object into a representation based on client preferences.
|
Modifier and Type | Method and Description |
---|---|
protected org.restlet.engine.resource.MethodAnnotationInfo |
ServerResource.getAnnotation(Method method,
Form query,
Representation entity)
Returns the first annotation descriptor matching the given method.
|
protected Representation |
ClientResource.handle(Method method,
Representation entity)
Handles the call by cloning the prototype request, setting the method and
entity.
|
protected Representation |
ClientResource.handle(Method method,
Representation entity,
ClientInfo clientInfo)
Handles the call by cloning the prototype request, setting the method and
entity.
|
protected Representation |
ClientResource.handle(Method method,
Representation entity,
MediaType mediaType)
Handles the call by cloning the prototype request, setting the method and
entity.
|
Representation |
ClientResource.patch(Representation entity)
Patches a resource with the given representation as delta state.
|
protected Representation |
ServerResource.patch(Representation entity)
Apply a patch entity to the current representation of the resource
retrieved by calling
ServerResource.get() . |
protected Representation |
ServerResource.patch(Representation entity,
Variant variant)
Apply a patch entity to the current representation of the resource
retrieved by calling
ServerResource.get() . |
Representation |
ClientResource.post(Representation entity)
Posts a representation.
|
protected Representation |
ServerResource.post(Representation entity)
Posts a representation to the resource at the target URI reference.
|
protected Representation |
ServerResource.post(Representation entity,
Variant variant)
Posts a representation to the resource at the target URI reference.
|
Representation |
ClientResource.put(Representation entity)
Creates or updates a resource with the given representation as new state
to be stored.
|
protected Representation |
ServerResource.put(Representation entity)
Creates or updates a resource with the given representation as new state
to be stored.
|
protected Representation |
ServerResource.put(Representation representation,
Variant variant)
Creates or updates a resource with the given representation as new state
to be stored.
|
<T> T |
Resource.toObject(Representation source,
java.lang.Class<T> target)
Converts a representation into a Java object.
|
Modifier and Type | Method and Description |
---|---|
protected Representation |
Redirector.rewrite(Representation initialEntity)
Optionally rewrites the response entity returned in the
Redirector.MODE_SERVER_INBOUND and Redirector.MODE_SERVER_OUTBOUND modes. |
Modifier and Type | Method and Description |
---|---|
protected Representation |
Redirector.rewrite(Representation initialEntity)
Optionally rewrites the response entity returned in the
Redirector.MODE_SERVER_INBOUND and Redirector.MODE_SERVER_OUTBOUND modes. |
Modifier and Type | Method and Description |
---|---|
Representation |
ConverterService.applyPatch(Representation initial,
Representation patch)
Applies a patch representation to an initial representation in order to
obtain a modified one.
|
Representation |
ConverterService.createPatch(Representation initial,
Representation modified)
Creates a patch representation by calculating a diff between initial and
modified representations.
|
Representation |
StatusService.getRepresentation(Status status,
Request request,
Response response)
Deprecated.
|
Representation |
ConverterService.revertPatch(Representation modified,
Representation patch)
Reverts a patch representation from a modified representation in order to
obtain the initial one.
|
Representation |
ConverterService.toRepresentation(java.lang.Object source)
Converts a regular Java object into a Representation.
|
Representation |
ConverterService.toRepresentation(java.lang.Object source,
MediaType target)
Converts a regular Java object into a Representation.
|
Representation |
ConverterService.toRepresentation(java.lang.Object source,
Variant target)
Converts a regular Java object into a Representation.
|
Representation |
ConverterService.toRepresentation(java.lang.Object source,
Variant target,
Resource resource)
Converts a regular Java object into a Representation.
|
Representation |
StatusService.toRepresentation(Status status,
Request request,
Response response)
Returns a representation for the given status.
|
Representation |
StatusService.toRepresentation(Status status,
Resource resource)
Returns a representation for the given status.
|
Modifier and Type | Method and Description |
---|---|
void |
ConnectorService.afterSend(Representation entity)
Call-back method invoked by the client or server connectors just after
sending the response to the target component.
|
Representation |
ConverterService.applyPatch(Representation initial,
Representation patch)
Applies a patch representation to an initial representation in order to
obtain a modified one.
|
void |
ConnectorService.beforeSend(Representation entity)
Call-back method invoked by the client or server connectors just before
sending the response to the target component.
|
boolean |
EncoderService.canEncode(Representation representation)
Indicates if a representation can be encoded.
|
Representation |
ConverterService.createPatch(Representation initial,
Representation modified)
Creates a patch representation by calculating a diff between initial and
modified representations.
|
Representation |
ConverterService.revertPatch(Representation modified,
Representation patch)
Reverts a patch representation from a modified representation in order to
obtain the initial one.
|
java.lang.Object |
ConverterService.toObject(Representation source)
Converts a Representation into a regular Java object.
|
<T> T |
ConverterService.toObject(Representation source,
java.lang.Class<T> target,
Resource resource)
Converts a Representation into a regular Java object.
|
Modifier and Type | Class and Description |
---|---|
class |
WrapperRepresentation
Representation wrapper.
|
Modifier and Type | Method and Description |
---|---|
Representation |
WrapperResponse.getEntity()
Returns the entity representation.
|
Representation |
WrapperRequest.getEntity()
Returns the entity representation.
|
Representation |
WrapperRepresentation.getWrappedRepresentation()
Returns the wrapped representation.
|
Modifier and Type | Method and Description |
---|---|
void |
WrapperResponse.setEntity(Representation entity)
Sets the entity representation.
|
void |
WrapperRequest.setEntity(Representation entity)
Sets the entity representation.
|
Constructor and Description |
---|
ByteReadingListener(Representation source)
Default constructor.
|
ByteReadingListener(Representation source,
int bufferSize)
Constructor.
|
CharacterReadingListener(Representation source)
Default constructor.
|
CharacterReadingListener(Representation source,
int bufferSize)
Constructor.
|
ReadingListener(Representation source)
Default constructor.
|
ReadingListener(Representation source,
int bufferSize)
Constructor.
|
StringReadingListener(Representation source)
Default constructor.
|
StringReadingListener(Representation source,
int bufferSize)
Constructor.
|
WrapperRepresentation(Representation wrappedRepresentation)
Constructor.
|
Copyright © 2005-2024 Restlet.