|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
| Packages that use Representation | |
|---|---|
| org.restlet.data | Information exchanged by components. |
| org.restlet.engine.adapter | Adapters between low-level HTTP calls and high-level Restlet Request and Response objects. |
| org.restlet.engine.application | Supports Restlet applications. |
| org.restlet.engine.component | Supports Restlet components. |
| org.restlet.engine.connector | Integration with Java URLConnection class. |
| org.restlet.engine.converter | Supports the converter service. |
| org.restlet.engine.header | Supports HTTP header parsing and formatting. |
| org.restlet.engine.io | Supports input and output work. |
| org.restlet.engine.local | Supports local connectors and resources. |
| org.restlet.engine.resource | Supports resources. |
| org.restlet.engine.util | General utilities. |
| 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. |
| Uses of Representation in org.restlet.data |
|---|
| Methods in org.restlet.data that return Representation | |
|---|---|
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). |
| Constructors in org.restlet.data with parameters of type Representation | |
|---|---|
Form(Representation webForm)
Constructor. |
|
Form(Representation webForm,
boolean decode)
Constructor. |
|
ReferenceList(Representation uriList)
Constructor from a "text/uri-list" representation. |
|
| Uses of Representation in org.restlet.engine.adapter |
|---|
| Methods in org.restlet.engine.adapter that return Representation | |
|---|---|
Representation |
HttpRequest.getEntity()
Returns the representation provided by the client. |
protected Representation |
Call.getRepresentation(InputStream stream)
Returns the representation wrapping the given stream. |
protected Representation |
Call.getRepresentation(ReadableByteChannel channel)
Returns the representation wrapping the given channel. |
Representation |
ServerCall.getRequestEntity()
Returns the request entity if available. |
Representation |
ClientCall.getResponseEntity(Response response)
Returns the response entity if available. |
| Methods in org.restlet.engine.adapter with parameters of type Representation | |
|---|---|
void |
HttpRequest.setEntity(Representation entity)
|
protected void |
ServerCall.writeResponseBody(Representation entity,
OutputStream responseEntityStream)
Effectively writes the response body. |
| Uses of Representation in org.restlet.engine.application |
|---|
| Subclasses of Representation in org.restlet.engine.application | |
|---|---|
class |
DecodeRepresentation
Representation that decodes a wrapped representation if its encoding is supported. |
class |
EncodeRepresentation
Content that encodes a wrapped content. |
class |
RangeRepresentation
Representation that exposes only a range of the content of a wrapped representation. |
| Methods in org.restlet.engine.application that return Representation | |
|---|---|
Representation |
Decoder.decode(Representation representation)
Decodes a given representation if its encodings are supported by NRE. |
Representation |
Encoder.encode(ClientInfo client,
Representation representation)
Encodes a given representation if an encoding is supported by the client. |
protected Representation |
StatusFilter.getDefaultRepresentation(Status status,
Request request,
Response response)
Returns a representation for the given status. In order to customize the default representation, this method can be overridden. |
protected Representation |
StatusFilter.getRepresentation(Status status,
Request request,
Response response)
Returns a representation for the given status. In order to customize the default representation, this method can be overridden. |
| Methods in org.restlet.engine.application with parameters of type Representation | |
|---|---|
boolean |
Decoder.canDecode(Representation representation)
Indicates if a representation can be decoded. |
Representation |
Decoder.decode(Representation representation)
Decodes a given representation if its encodings are supported by NRE. |
Representation |
Encoder.encode(ClientInfo client,
Representation representation)
Encodes a given representation if an encoding is supported by the client. |
| Constructors in org.restlet.engine.application with parameters of type Representation | |
|---|---|
DecodeRepresentation(Representation wrappedRepresentation)
Constructor. |
|
EncodeRepresentation(Encoding encoding,
Representation wrappedRepresentation)
Constructor. |
|
RangeRepresentation(Representation wrappedRepresentation)
Constructor. |
|
RangeRepresentation(Representation wrappedRepresentation,
Range range)
Constructor. |
|
| Uses of Representation in org.restlet.engine.component |
|---|
| Constructors in org.restlet.engine.component with parameters of type Representation | |
|---|---|
ComponentXmlParser(Component component,
Representation xmlConfiguration)
Constructor. |
|
| Uses of Representation in org.restlet.engine.connector |
|---|
| Methods in org.restlet.engine.connector that return Representation | |
|---|---|
protected Representation |
HttpUrlConnectionCall.getRepresentation(InputStream stream)
|
| Uses of Representation in org.restlet.engine.converter |
|---|
| Methods in org.restlet.engine.converter that return Representation | |
|---|---|
abstract Representation |
ConverterHelper.toRepresentation(Object source,
Variant target,
Resource resource)
Converts a regular Java object into a Representation. |
Representation |
DefaultConverter.toRepresentation(Object source,
Variant target,
Resource resource)
|
| Methods in org.restlet.engine.converter with parameters of type Representation | ||
|---|---|---|
static
|
ConverterUtils.getBestHelper(Representation source,
Class<T> target,
Resource resource)
Returns the best converter helper matching the given parameters. |
|
abstract
|
ConverterHelper.score(Representation source,
Class<T> target,
Resource resource)
Scores the affinity of this helper with the source class. |
|
|
DefaultConverter.score(Representation source,
Class<T> target,
Resource resource)
|
|
abstract
|
ConverterHelper.toObject(Representation source,
Class<T> target,
Resource resource)
Converts a Representation into a regular Java object. |
|
|
DefaultConverter.toObject(Representation source,
Class<T> target,
Resource resource)
|
|
| Uses of Representation in org.restlet.engine.header |
|---|
| Methods in org.restlet.engine.header that return Representation | |
|---|---|
static Representation |
HeaderUtils.extractEntityHeaders(Iterable<Header> headers,
Representation representation)
Extracts entity headers and updates a given representation or create an empty one when at least one entity header is present. |
| Methods in org.restlet.engine.header with parameters of type Representation | |
|---|---|
static void |
HeaderUtils.addEntityHeaders(Representation entity,
Series<Header> headers)
Adds the entity headers based on the Representation to the
Series. |
static void |
HeaderUtils.addNotModifiedEntityHeaders(Representation entity,
Series<Header> headers)
Adds the entity headers based on the Representation to the
Series when a 304 (Not Modified) status is returned. |
static Representation |
HeaderUtils.extractEntityHeaders(Iterable<Header> headers,
Representation representation)
Extracts entity headers and updates a given representation or create an empty one when at least one entity header is present. |
static void |
RangeReader.update(String value,
Representation representation)
Parse the Content-Range header value and update the given representation. |
static String |
ContentType.writeHeader(Representation representation)
Writes the HTTP "Content-Type" header. |
| Constructors in org.restlet.engine.header with parameters of type Representation | |
|---|---|
ContentType(Representation representation)
Constructor. |
|
| Uses of Representation in org.restlet.engine.io |
|---|
| Methods in org.restlet.engine.io with parameters of type Representation | |
|---|---|
static long |
IoUtils.getAvailableSize(Representation representation)
Returns the size effectively available. |
static ReadableByteChannel |
IoUtils.getChannel(Representation representation)
Returns a readable byte channel based on the given representation's content and its write(WritableByteChannel) method. |
static InputStream |
IoUtils.getStream(Representation representation)
Returns an input stream based on the given representation's content and its write(OutputStream) method. |
static String |
IoUtils.getText(Representation representation)
Converts the representation to a string value. |
| Uses of Representation in org.restlet.engine.local |
|---|
| Subclasses of Representation in org.restlet.engine.local | |
|---|---|
class |
ZipEntryRepresentation
An entry in a Zip/JAR file. |
| Methods in org.restlet.engine.local that return Representation | |
|---|---|
Representation |
DirectoryServerResource.delete()
|
protected Representation |
DirectoryServerResource.get()
|
Representation |
FileEntity.getRepresentation(MediaType defaultMediaType,
int timeToLive)
|
Representation |
ZipEntryEntity.getRepresentation(MediaType defaultMediaType,
int timeToLive)
|
abstract Representation |
Entity.getRepresentation(MediaType defaultMediaType,
int timeToLive)
Returns a representation of this local entity. |
Representation |
DirectoryServerResource.handle()
|
Representation |
DirectoryServerResource.put(Representation entity)
|
| Methods in org.restlet.engine.local with parameters of type Representation | |
|---|---|
Representation |
DirectoryServerResource.put(Representation entity)
|
| Uses of Representation in org.restlet.engine.resource |
|---|
| Methods in org.restlet.engine.resource with parameters of type Representation | |
|---|---|
AnnotationInfo |
AnnotationUtils.getAnnotation(List<AnnotationInfo> annotations,
Method restletMethod,
Form query,
Representation entity,
MetadataService metadataService,
ConverterService converterService)
Returns the first annotation descriptor matching the given Restlet method. |
boolean |
AnnotationInfo.isCompatible(Method restletMethod,
Form queryParams,
Representation requestEntity,
MetadataService metadataService,
ConverterService converterService)
Indicates if the annotated method described is compatible with the given parameters. |
boolean |
AnnotationInfo.isCompatibleRequestEntity(Representation requestEntity,
MetadataService metadataService,
ConverterService converterService)
Indicates if the given request entity is compatible with the annotated method described. |
| Uses of Representation in org.restlet.engine.util |
|---|
| Methods in org.restlet.engine.util with parameters of type Representation | |
|---|---|
static Parameter |
FormUtils.getFirstParameter(Representation post,
String name)
Reads the first parameter with the given name. |
static Object |
FormUtils.getParameter(Representation form,
String name)
Reads the parameters with the given name. If multiple values are found, a list is returned created. |
static void |
FormUtils.getParameters(Representation post,
Map<String,Object> parameters)
Reads the parameters whose name is a key in the given map. If a matching parameter is found, its value is put in the map. If multiple values are found, a list is created and set in the map. |
static void |
FormUtils.parse(Form form,
Representation post,
boolean decode)
Parses a post into a given form. |
| Constructors in org.restlet.engine.util with parameters of type Representation | |
|---|---|
FormReader(Representation representation)
Constructor. In case the representation does not define a character set, the UTF-8 character set is used. |
|
FormReader(Representation representation,
boolean decode)
Constructor. In case the representation does not define a character set, the UTF-8 character set is used. |
|
| Uses of Representation in org.restlet.representation |
|---|
| Subclasses of Representation in org.restlet.representation | |
|---|---|
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 Serializable>
Representation based on a serializable Java object. It supports binary representations of JavaBeans using the ObjectInputStream and ObjectOutputStream classes. |
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. |
| Constructors in org.restlet.representation with parameters of type Representation | |
|---|---|
BufferingRepresentation(Representation bufferedRepresentation)
Constructor. |
|
DigesterRepresentation(Representation wrappedRepresentation)
Constructor. By default, the instance relies on the Digest.ALGORITHM_MD5
digest algorithm. |
|
DigesterRepresentation(Representation wrappedRepresentation,
String algorithm)
Constructor. |
|
ObjectRepresentation(Representation serializedRepresentation)
Constructor reading the object from a serialized representation. |
|
ObjectRepresentation(Representation serializedRepresentation,
ClassLoader classLoader)
Constructor reading the object from a serialized representation. |
|
ObjectRepresentation(Representation serializedRepresentation,
ClassLoader classLoader,
boolean variantObjectBinarySupported,
boolean variantObjectXmlSupported)
Constructor reading the object from a serialized representation. |
|
| Uses of Representation in org.restlet.resource |
|---|
| Methods in org.restlet.resource that return Representation | |
|---|---|
protected Representation |
ServerResource.delete()
Deletes the resource and all its representations. |
Representation |
ClientResource.delete()
Deletes the target 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(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. |
protected Representation |
ServerResource.get()
Returns a full representation. |
Representation |
ClientResource.get()
Represents the resource using content negotiation to select the best variant based on the client preferences. |
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. |
abstract Representation |
Resource.handle()
Handles the call composed of the current context, request and response. |
Representation |
ServerResource.handle()
Handles any call to this resource. |
Representation |
ClientResource.handle()
Handles the call by invoking the next handler. |
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. |
protected Representation |
ServerResource.head()
Returns a representation whose metadata will be returned to the client. |
Representation |
ClientResource.head()
Represents the resource using content negotiation to select the best variant based on the client preferences. |
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. |
protected Representation |
ServerResource.options()
Indicates the communication options available for this resource. |
Representation |
ClientResource.options()
Describes the resource using content negotiation to select the best variant based on the client preferences. |
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(Object entity)
Patches a resource with the given object as delta state. |
Representation |
ClientResource.patch(Object entity,
MediaType mediaType)
Patches a resource with the given object 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(). |
Representation |
ClientResource.patch(Representation entity)
Patches a resource with the given representation as delta state. |
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(Object entity)
Posts an object entity. |
Representation |
ClientResource.post(Object entity,
MediaType mediaType)
Posts an object entity. |
protected Representation |
ServerResource.post(Representation entity)
Posts a representation to the resource at the target URI reference. |
Representation |
ClientResource.post(Representation entity)
Posts a representation. |
protected Representation |
ServerResource.post(Representation entity,
Variant variant)
Posts a representation to the resource at the target URI reference. |
Representation |
ClientResource.put(Object entity)
Puts an object entity. |
Representation |
ClientResource.put(Object entity,
MediaType mediaType)
Puts an object entity. |
protected Representation |
ServerResource.put(Representation entity)
Creates or updates a resource with the given representation as new state to be stored. |
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 representation,
Variant variant)
Creates or updates a resource with the given representation as new state to be stored. |
Representation |
Resource.toRepresentation(Object source,
Variant target)
Converts an object into a representation based on client preferences. |
| Methods in org.restlet.resource with parameters of type Representation | ||
|---|---|---|
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. |
|
protected Representation |
ServerResource.patch(Representation entity)
Apply a patch entity to the current representation of the resource retrieved by calling ServerResource.get(). |
|
Representation |
ClientResource.patch(Representation entity)
Patches a resource with the given representation as delta state. |
|
protected Representation |
ServerResource.patch(Representation entity,
Variant variant)
Apply a patch entity to the current representation of the resource retrieved by calling ServerResource.get(). |
|
protected Representation |
ServerResource.post(Representation entity)
Posts a representation to the resource at the target URI reference. |
|
Representation |
ClientResource.post(Representation entity)
Posts a representation. |
|
protected Representation |
ServerResource.post(Representation entity,
Variant variant)
Posts a representation to the resource at the target URI reference. |
|
protected Representation |
ServerResource.put(Representation entity)
Creates or updates a resource with the given representation as new state to be stored. |
|
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 representation,
Variant variant)
Creates or updates a resource with the given representation as new state to be stored. |
|
|
Resource.toObject(Representation source,
Class<T> target)
Converts a representation into a Java object. |
|
| Uses of Representation in org.restlet.routing |
|---|
| Methods in org.restlet.routing that return Representation | |
|---|---|
protected Representation |
Redirector.rewrite(Representation initialEntity)
Optionally rewrites the response entity returned in the Redirector.MODE_SERVER_INBOUND and Redirector.MODE_SERVER_OUTBOUND modes. |
| Methods in org.restlet.routing with parameters of type Representation | |
|---|---|
protected Representation |
Redirector.rewrite(Representation initialEntity)
Optionally rewrites the response entity returned in the Redirector.MODE_SERVER_INBOUND and Redirector.MODE_SERVER_OUTBOUND modes. |
| Uses of Representation in org.restlet.service |
|---|
| Methods in org.restlet.service that return Representation | |
|---|---|
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)
Returns a representation for the given status. In order to customize the default representation, this method can be overridden. |
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(Object source)
Converts a regular Java object into a Representation. |
Representation |
ConverterService.toRepresentation(Object source,
Variant target,
Resource resource)
Converts a regular Java object into a Representation. |
| Methods in org.restlet.service with parameters of type Representation | ||
|---|---|---|
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. |
|
Object |
ConverterService.toObject(Representation source)
Converts a Representation into a regular Java object. |
|
|
ConverterService.toObject(Representation source,
Class<T> target,
Resource resource)
Converts a Representation into a regular Java object. |
|
| Uses of Representation in org.restlet.util |
|---|
| Subclasses of Representation in org.restlet.util | |
|---|---|
class |
WrapperRepresentation
Representation wrapper. |
| Methods in org.restlet.util that return Representation | |
|---|---|
Representation |
WrapperRequest.getEntity()
Returns the entity representation. |
Representation |
WrapperResponse.getEntity()
Returns the entity representation. |
Representation |
WrapperRepresentation.getWrappedRepresentation()
Returns the wrapped representation. |
| Methods in org.restlet.util with parameters of type Representation | |
|---|---|
void |
WrapperRequest.setEntity(Representation entity)
Sets the entity representation. |
void |
WrapperResponse.setEntity(Representation entity)
Sets the entity representation. |
| Constructors in org.restlet.util with parameters of type Representation | |
|---|---|
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. |
|
|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||