|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.restlet.service.Service
org.restlet.service.MetadataService
public class MetadataService
Application service providing access to metadata and their associated
extension names. The list of default mappings is documented in the
addCommonExtensions()
method.
Internally, the mappings are stored as a list of "extension, metadata" pairs.
Constructor Summary | |
---|---|
MetadataService()
Constructor. |
Method Summary | ||
---|---|---|
void |
addCommonExtensions()
Adds a common list of associations from extensions to metadata. |
|
void |
addExtension(String extension,
Metadata metadata)
Maps an extension to some metadata (media type, language or character set) to an extension. |
|
void |
addExtension(String extension,
Metadata metadata,
boolean preferred)
Maps an extension to some metadata (media type, language or character set) to an extension. |
|
void |
clearExtensions()
clears the mappings for all extensions. |
|
List<MediaType> |
getAllMediaTypes(String extension)
Returns all the media types associated to this extension. |
|
List<Metadata> |
getAllMetadata(String extension)
Returns all the metadata associated to this extension. |
|
CharacterSet |
getCharacterSet(String extension)
Returns the character set associated to this extension. |
|
CharacterSet |
getDefaultCharacterSet()
Returns the default character set for textual representations. |
|
Encoding |
getDefaultEncoding()
Returns the default encoding for representations. |
|
Language |
getDefaultLanguage()
Returns the default language for representations. |
|
MediaType |
getDefaultMediaType()
Returns the default media type for representations. |
|
Encoding |
getEncoding(String extension)
Returns the encoding associated to this extension. |
|
String |
getExtension(Metadata metadata)
Returns the first extension mapping to this metadata. |
|
Language |
getLanguage(String extension)
Returns the language associated to this extension. |
|
MediaType |
getMediaType(String extension)
Returns the mediatype associated to this extension. |
|
Metadata |
getMetadata(String extension)
Returns the metadata associated to this extension. |
|
|
getMetadata(String extension,
Class<T> metadataType)
Returns the metadata associated to this extension. |
|
void |
setDefaultCharacterSet(CharacterSet defaultCharacterSet)
Sets the default character set for local representations. |
|
void |
setDefaultEncoding(Encoding defaultEncoding)
Sets the default encoding for local representations. |
|
void |
setDefaultLanguage(Language defaultLanguage)
Sets the default language for local representations. |
|
void |
setDefaultMediaType(MediaType defaultMediaType)
Sets the default media type for local representations. |
Methods inherited from class org.restlet.service.Service |
---|
createInboundFilter, createOutboundFilter, getContext, isEnabled, isStarted, isStopped, setContext, setEnabled, start, stop |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MetadataService()
Language.ENGLISH_US
,
the default encoding to Encoding.IDENTITY
(no encoding) and the
default media type to MediaType.APPLICATION_OCTET_STREAM
. It also
calls the addCommonExtensions()
method.
Method Detail |
---|
public void addCommonExtensions()
public void addExtension(String extension, Metadata metadata)
extension
- The extension name.metadata
- The metadata to map.public void addExtension(String extension, Metadata metadata, boolean preferred)
extension
- The extension name.metadata
- The metadata to map.preferred
- indicates if this mapping is the preferred one.public void clearExtensions()
public List<MediaType> getAllMediaTypes(String extension)
extension
- The extension name without any delimiter.
public List<Metadata> getAllMetadata(String extension)
extension
- The extension name without any delimiter.
public CharacterSet getCharacterSet(String extension)
extension
- The extension name without any delimiter.
public CharacterSet getDefaultCharacterSet()
public Encoding getDefaultEncoding()
public Language getDefaultLanguage()
public MediaType getDefaultMediaType()
public Encoding getEncoding(String extension)
extension
- The extension name without any delimiter.
public String getExtension(Metadata metadata)
metadata
- The metadata to find.
public Language getLanguage(String extension)
extension
- The extension name without any delimiter.
public MediaType getMediaType(String extension)
extension
- The extension name without any delimiter.
public Metadata getMetadata(String extension)
extension
- The extension name without any delimiter.
public <T extends Metadata> T getMetadata(String extension, Class<T> metadataType)
T
- extension
- The extension name without any delimiter.metadataType
- The target metadata type.
public void setDefaultCharacterSet(CharacterSet defaultCharacterSet)
defaultCharacterSet
- The default character set for local representations.public void setDefaultEncoding(Encoding defaultEncoding)
defaultEncoding
- The default encoding for local representations.public void setDefaultLanguage(Language defaultLanguage)
defaultLanguage
- The default language for local representations.public void setDefaultMediaType(MediaType defaultMediaType)
defaultMediaType
- The default media type for local representations.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |