Constructor and Description |
---|
ClientInfo(List<? extends Variant> variants)
Constructor from a list of variants.
|
Modifier and Type | Class and Description |
---|---|
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.
|
Modifier and Type | Method and Description |
---|---|
Variant |
Conneg.getPreferredVariant(List<? extends Variant> variants)
Returns the best variant representation for a given resource according
the the client preferences.
A default language is provided in case the variants don't match the client preferences. |
Modifier and Type | Method and Description |
---|---|
float |
StrictConneg.scoreVariant(Variant variant)
Scores a variant relatively to enriched client preferences.
|
abstract float |
Conneg.scoreVariant(Variant variant)
Scores a variant relatively to enriched client preferences.
|
Modifier and Type | Method and Description |
---|---|
Variant |
Conneg.getPreferredVariant(List<? extends Variant> variants)
Returns the best variant representation for a given resource according
the the client preferences.
A default language is provided in case the variants don't match the client preferences. |
Modifier and Type | Method and Description |
---|---|
List<VariantInfo> |
ConverterHelper.addVariants(Class<?> sourceClass,
Variant targetVariant,
List<VariantInfo> variants)
Returns the list of variants that can be converted from a given object
class.
|
static ConverterHelper |
ConverterUtils.getBestHelper(Object source,
Variant target,
Resource resource)
Returns the best converter helper matching the given parameters.
|
List<Class<?>> |
StatusInfoHtmlConverter.getObjectClasses(Variant source) |
abstract List<Class<?>> |
ConverterHelper.getObjectClasses(Variant source)
Returns the list of object classes that can be converted from a given
variant.
|
List<Class<?>> |
DefaultConverter.getObjectClasses(Variant source) |
static List<VariantInfo> |
ConverterUtils.getVariants(Class<?> sourceClass,
Variant targetVariant)
Returns the list of variants that can be converted from a given object
class.
|
List<VariantInfo> |
ConverterHelper.getVariants(Class<?> sourceClass,
Variant targetVariant)
Returns the list of variants that can be converted from a given object
class by a specific converter helper.
|
protected boolean |
StatusInfoHtmlConverter.isCompatible(Variant variant)
Indicates if the given variant is compatible with the media types
supported by this converter.
|
float |
StatusInfoHtmlConverter.score(Object source,
Variant target,
Resource resource) |
abstract float |
ConverterHelper.score(Object source,
Variant target,
Resource resource)
Scores the affinity of this helper with the source class.
|
float |
DefaultConverter.score(Object source,
Variant target,
Resource resource) |
Representation |
StatusInfoHtmlConverter.toRepresentation(Object source,
Variant target,
Resource resource) |
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) |
Modifier and Type | Class and Description |
---|---|
class |
ZipEntryRepresentation
An entry in a Zip/JAR file.
|
Modifier and Type | Method and Description |
---|---|
Variant |
Entity.getVariant()
Returns a variant corresponding to the extensions of this entity.
|
Modifier and Type | Method and Description |
---|---|
List<Variant> |
DirectoryServerResource.getVariants() |
protected List<Variant> |
DirectoryServerResource.getVariants(Method method)
Returns the list of variants for the given method.
|
Modifier and Type | Method and Description |
---|---|
static Collection<String> |
Entity.getExtensions(Variant variant,
MetadataService metadataService)
Returns the list of known extensions taken from a given variant.
|
static void |
Entity.updateMetadata(String entryName,
Variant variant,
boolean applyDefault,
MetadataService metadataService)
Updates some variant metadata based on a given entry name with
extensions.
|
Modifier and Type | Class and Description |
---|---|
class |
VariantInfo
Variant that is declared by an annotated Java method.
|
Modifier and Type | Method and Description |
---|---|
List<Variant> |
MethodAnnotationInfo.getRequestVariants(MetadataService metadataService,
ConverterService converterService)
Returns a list of request variants based on the annotation value.
|
List<Variant> |
MethodAnnotationInfo.getResponseVariants(MetadataService metadataService,
ConverterService converterService)
Returns a list of response variants based on the annotation value.
|
Constructor and Description |
---|
VariantInfo(Variant variant,
MethodAnnotationInfo annotationInfo)
Constructor.
|
Modifier and Type | Class and Description |
---|---|
class |
Categories
Collection of
Category entries. |
class |
Entry
Represents an individual entry, acting as a component for metadata and data
associated with the entry.
|
class |
Feed
Atom Feed Document, acting as a component for metadata and data associated
with the feed.
|
class |
Service
Represents an Atom introspection document.
|
Modifier and Type | Method and Description |
---|---|
List<Class<?>> |
AtomConverter.getObjectClasses(Variant source) |
float |
AtomConverter.score(Object source,
Variant target,
Resource resource) |
Representation |
AtomConverter.toRepresentation(Object source,
Variant target,
Resource resource) |
Modifier and Type | Class and Description |
---|---|
class |
TemplateRepresentation
FreeMarker template representation.
|
Modifier and Type | Method and Description |
---|---|
List<Class<?>> |
FreemarkerConverter.getObjectClasses(Variant source) |
float |
FreemarkerConverter.score(Object source,
Variant target,
Resource resource) |
Representation |
FreemarkerConverter.toRepresentation(Object source,
Variant target,
Resource resource) |
Modifier and Type | Class and Description |
---|---|
class |
GsonRepresentation<T>
Representation based on a JSON document.
|
Modifier and Type | Method and Description |
---|---|
List<Class<?>> |
GsonConverter.getObjectClasses(Variant source) |
float |
GsonConverter.score(Object source,
Variant target,
Resource resource) |
Representation |
GsonConverter.toRepresentation(Object source,
Variant target,
Resource resource) |
Modifier and Type | Class and Description |
---|---|
class |
FormDataSet
HTML form supporting either URL encoding or multipart encoding.
|
Modifier and Type | Method and Description |
---|---|
List<Class<?>> |
HtmlConverter.getObjectClasses(Variant source) |
float |
HtmlConverter.score(Object source,
Variant target,
Resource resource) |
Representation |
HtmlConverter.toRepresentation(Object source,
Variant target,
Resource resource) |
Modifier and Type | Class and Description |
---|---|
class |
JacksonRepresentation<T>
Representation based on the Jackson library.
|
Modifier and Type | Method and Description |
---|---|
List<Class<?>> |
JacksonConverter.getObjectClasses(Variant source) |
protected boolean |
JacksonConverter.isCompatible(Variant variant)
Indicates if the given variant is compatible with the media types
supported by this converter.
|
float |
JacksonConverter.score(Object source,
Variant target,
Resource resource) |
Representation |
JacksonConverter.toRepresentation(Object source,
Variant target,
Resource resource) |
Modifier and Type | Class and Description |
---|---|
class |
MessageRepresentation
XML representation of a JavaMail message.
|
class |
MessagesRepresentation
XML representation of a list of JavaMail messages.
|
Modifier and Type | Method and Description |
---|---|
List<Class<?>> |
JavaMailConverter.getObjectClasses(Variant source) |
float |
JavaMailConverter.score(Object source,
Variant target,
Resource resource) |
Representation |
JavaMailConverter.toRepresentation(Object source,
Variant target,
Resource resource) |
Modifier and Type | Class and Description |
---|---|
class |
JaxbRepresentation<T>
An XML representation based on JAXB that provides easy translation between
XML and JAXB element class trees.
|
Modifier and Type | Method and Description |
---|---|
List<Class<?>> |
JaxbConverter.getObjectClasses(Variant source) |
protected boolean |
JaxbConverter.isCompatible(Variant variant)
Indicates if the given variant is compatible with the media types
supported by this converter.
|
float |
JaxbConverter.score(Object source,
Variant target,
Resource resource) |
Representation |
JaxbConverter.toRepresentation(Object source,
Variant target,
Resource resource) |
Modifier and Type | Class and Description |
---|---|
class |
RowSetRepresentation
Deprecated.
Use a persistence technology such as Mybatis or Hibernate
instead.
|
Modifier and Type | Method and Description |
---|---|
List<Class<?>> |
JdbcConverter.getObjectClasses(Variant source)
Deprecated.
|
float |
JdbcConverter.score(Object source,
Variant target,
Resource resource)
Deprecated.
|
Representation |
JdbcConverter.toRepresentation(Object source,
Variant target,
Resource resource)
Deprecated.
|
Modifier and Type | Class and Description |
---|---|
class |
JibxRepresentation<T>
Deprecated.
Use an XML serialization technology such as Jackson instead.
|
Modifier and Type | Method and Description |
---|---|
List<Class<?>> |
JibxConverter.getObjectClasses(Variant source)
Deprecated.
|
protected boolean |
JibxConverter.isCompatible(Variant variant)
Deprecated.
Indicates if the given variant is compatible with the media types
supported by this converter.
|
float |
JibxConverter.score(Object source,
Variant target,
Resource resource)
Deprecated.
|
Representation |
JibxConverter.toRepresentation(Object source,
Variant target,
Resource resource)
Deprecated.
|
Modifier and Type | Class and Description |
---|---|
class |
Metadata
Represents the metadata of an OData service.
|
Modifier and Type | Class and Description |
---|---|
class |
RdfRepresentation
Generic RDF representation.
|
Modifier and Type | Method and Description |
---|---|
List<Class<?>> |
RdfConverter.getObjectClasses(Variant source) |
protected boolean |
RdfConverter.isCompatible(Variant variant)
Indicates if the given variant is compatible with the media types
supported by this converter.
|
float |
RdfConverter.score(Object source,
Variant target,
Resource resource) |
Representation |
RdfConverter.toRepresentation(Object source,
Variant target,
Resource resource) |
Modifier and Type | Class and Description |
---|---|
class |
SyndFeedRepresentation
Deprecated.
Not actively developed anymore.
|
Modifier and Type | Method and Description |
---|---|
List<Class<?>> |
RomeConverter.getObjectClasses(Variant source)
Deprecated.
|
float |
RomeConverter.score(Object source,
Variant target,
Resource resource)
Deprecated.
|
Representation |
RomeConverter.toRepresentation(Object source,
Variant target,
Resource resource)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
List<Class<?>> |
ThymeleafConverter.getObjectClasses(Variant source) |
float |
ThymeleafConverter.score(Object source,
Variant target,
Resource resource) |
Representation |
ThymeleafConverter.toRepresentation(Object source,
Variant target,
Resource resource) |
Modifier and Type | Method and Description |
---|---|
List<Class<?>> |
VelocityConverter.getObjectClasses(Variant source) |
float |
VelocityConverter.score(Object source,
Variant target,
Resource resource) |
Representation |
VelocityConverter.toRepresentation(Object source,
Variant target,
Resource resource) |
Modifier and Type | Class and Description |
---|---|
class |
WadlRepresentation
Root of a WADL description document.
|
Modifier and Type | Method and Description |
---|---|
protected Variant |
WadlServerResource.getPreferredWadlVariant()
Returns the preferred WADL variant according to the client preferences
specified in the request.
|
protected Variant |
WadlApplication.getPreferredWadlVariant(Request request)
Returns the preferred WADL variant according to the client preferences
specified in the request.
|
Modifier and Type | Method and Description |
---|---|
protected List<Variant> |
WadlApplication.getWadlVariants()
Returns the available WADL variants.
|
protected List<Variant> |
WadlServerResource.getWadlVariants()
Returns the available WADL variants.
|
Modifier and Type | Method and Description |
---|---|
protected RepresentationInfo |
WadlServerResource.describe(MethodInfo methodInfo,
Class<?> representationClass,
Variant variant)
Describes a representation class and variant couple as WADL information.
|
protected RepresentationInfo |
WadlServerResource.describe(MethodInfo methodInfo,
RequestInfo requestInfo,
Class<?> representationClass,
Variant variant)
Describes a representation class and variant couple as WADL information
for the given method and request.
|
protected RepresentationInfo |
WadlServerResource.describe(MethodInfo methodInfo,
ResponseInfo responseInfo,
Class<?> representationClass,
Variant variant)
Describes a representation class and variant couple as WADL information
for the given method and response.
|
protected Representation |
WadlServerResource.describe(Variant variant)
Describes the resource as a WADL document for the given variant.
|
List<Class<?>> |
WadlConverter.getObjectClasses(Variant source) |
float |
WadlConverter.score(Object source,
Variant target,
Resource resource) |
Representation |
WadlConverter.toRepresentation(Object source,
Variant target,
Resource resource) |
protected Representation |
WadlApplication.wadlRepresent(Variant variant,
Request request,
Response response)
Represents the resource as a WADL description for the given variant.
|
Constructor and Description |
---|
RepresentationInfo(Variant variant)
Constructor with a variant.
|
Modifier and Type | Class and Description |
---|---|
class |
DomRepresentation
XML representation based on a DOM document.
|
class |
SaxRepresentation
XML representation for SAX events processing.
|
class |
TransformRepresentation
Representation able to apply an XSLT transformation.
|
class |
XmlRepresentation
Representation based on an XML document.
|
Modifier and Type | Method and Description |
---|---|
List<Class<?>> |
XmlConverter.getObjectClasses(Variant source) |
float |
XmlConverter.score(Object source,
Variant target,
Resource resource) |
Representation |
XmlConverter.toRepresentation(Object source,
Variant target,
Resource resource) |
Modifier and Type | Class and Description |
---|---|
class |
XstreamRepresentation<T>
Deprecated.
Use an XML serialization technology such as Jackson instead.
|
Modifier and Type | Method and Description |
---|---|
List<Class<?>> |
XstreamConverter.getObjectClasses(Variant source)
Deprecated.
|
float |
XstreamConverter.score(Object source,
Variant target,
Resource resource)
Deprecated.
|
Representation |
XstreamConverter.toRepresentation(Object source,
Variant target,
Resource resource)
Deprecated.
|
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 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 |
Representation
Current or intended state of a resource.
|
class |
RepresentationInfo
Information about a representation.
|
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.
|
Modifier and Type | Method and Description |
---|---|
boolean |
Variant.includes(Variant other)
Indicates if the current variant includes the given variant.
|
boolean |
Variant.isCompatible(Variant other)
Indicates if the current variant is compatible with the given variant.
|
Constructor and Description |
---|
Representation(Variant variant,
Date modificationDate)
Constructor from a variant.
|
Representation(Variant variant,
Date modificationDate,
Tag tag)
Constructor from a variant.
|
Representation(Variant variant,
Tag tag)
Constructor from a variant.
|
RepresentationInfo(Variant variant,
Date modificationDate)
Constructor from a variant.
|
RepresentationInfo(Variant variant,
Date modificationDate,
Tag tag)
Constructor from a variant.
|
RepresentationInfo(Variant variant,
Tag tag)
Constructor from a variant.
|
Modifier and Type | Method and Description |
---|---|
protected Variant |
ServerResource.getPreferredVariant(List<Variant> variants)
Returns the preferred variant among a list of available variants.
|
Modifier and Type | Method and Description |
---|---|
List<Variant> |
Directory.getIndexVariants(ReferenceList indexContent)
Returns the variant representations of a directory index.
|
List<Variant> |
ServerResource.getVariants()
Returns a modifiable list of exposed variants for the current request
method.
|
protected List<Variant> |
ServerResource.getVariants(Method method)
Returns a modifiable list of exposed variants for the given method.
|
Modifier and Type | Method and Description |
---|---|
protected Representation |
ServerResource.delete(Variant variant)
Deletes the resource and all its representations.
|
protected Representation |
ServerResource.doHandle(Variant variant)
Effectively handles a call with content negotiation of the response
entity.
|
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.
|
protected RepresentationInfo |
ServerResource.getInfo(Variant variant)
Returns information about the resource's representation.
|
protected Representation |
ServerResource.head(Variant variant)
Returns a representation whose metadata will be returned to the client.
|
protected Representation |
ServerResource.options(Variant variant)
Indicates the communication options available for this resource.
|
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,
Variant variant)
Posts a representation to the resource at the target URI reference.
|
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.
|
Modifier and Type | Method and Description |
---|---|
protected Variant |
ServerResource.getPreferredVariant(List<Variant> variants)
Returns the preferred variant among a list of available variants.
|
Modifier and Type | Method and Description |
---|---|
Variant |
ConnegService.getPreferredVariant(List<? extends Variant> variants,
Request request,
MetadataService metadataService)
Returns the best variant representation for a given resource according
the the client preferences.
A default language is provided in case the variants don't match the client preferences. |
Modifier and Type | Method and Description |
---|---|
List<? extends Variant> |
ConverterService.getVariants(Class<?> source,
Variant target)
Returns the list of variants that can be converted from a given object
class.
|
Modifier and Type | Method and Description |
---|---|
List<Class<?>> |
ConverterService.getObjectClasses(Variant source)
Returns the list of object classes that can be converted from a given
variant.
|
List<? extends Variant> |
ConverterService.getVariants(Class<?> source,
Variant target)
Returns the list of variants that can be converted from a given object
class.
|
Representation |
ConverterService.toRepresentation(Object source,
Variant target)
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.
|
Modifier and Type | Method and Description |
---|---|
Variant |
ConnegService.getPreferredVariant(List<? extends Variant> variants,
Request request,
MetadataService metadataService)
Returns the best variant representation for a given resource according
the the client preferences.
A default language is provided in case the variants don't match the client preferences. |
Modifier and Type | Class and Description |
---|---|
class |
WrapperRepresentation
Representation wrapper.
|
Copyright © 2005–2016. All rights reserved.