A B C D E F G H I J K L M N O P R S T U V W X Z

A

accept(Request, Response) - Method in class org.restlet.Guard
Accepts the call.
acceptRepresentation(Representation) - Method in class org.restlet.resource.Resource
Accepts and processes a representation posted to the resource.
add(String) - Method in class org.restlet.data.ReferenceList
Creates then adds a reference at the end of the list.
add(Client) - Method in class org.restlet.util.ClientList
 
add(Protocol) - Method in class org.restlet.util.ClientList
Adds a new client connector in the map supporting the given protocol.
add(String, String) - Method in class org.restlet.util.Series
Creates then adds a parameter at the end of the list.
add(Protocol) - Method in class org.restlet.util.ServerList
Adds a new server connector in the map supporting the given protocol.
add(Protocol, int) - Method in class org.restlet.util.ServerList
Adds a new server connector in the map supporting the given protocol on the specified port.
add(Protocol, String, int) - Method in class org.restlet.util.ServerList
Adds a new server connector in the map supporting the given protocol on the specified IP address and port.
add(Server) - Method in class org.restlet.util.ServerList
Adds a server at the end of the list.
add(E) - Method in class org.restlet.util.WrapperList
Adds a element at the end of the list.
add(int, E) - Method in class org.restlet.util.WrapperList
Inserts the specified element at the specified position in this list.
addAll(Collection<? extends E>) - Method in class org.restlet.util.WrapperList
Appends all of the elements in the specified collection to the end of this list.
addAll(int, Collection<? extends E>) - Method in class org.restlet.util.WrapperList
Inserts all of the elements in the specified collection into this list at the specified position.
addCommonExtensions() - Method in class org.restlet.service.MetadataService
Adds a common list of associations from extensions to metadata.
addExtension(String, Metadata) - Method in class org.restlet.service.MetadataService
Maps an extension to some metadata (media type, language or character set) to an extension.
addExtension(String, Metadata, boolean) - Method in class org.restlet.service.MetadataService
Maps an extension to some metadata (media type, language or character set) to an extension.
addQueryParameter(String, String) - Method in class org.restlet.data.Reference
Adds a parameter to the query component.
addSegment(String) - Method in class org.restlet.data.Reference
Adds a segment at the end of the path.
after(Date, Date) - Static method in class org.restlet.util.DateUtils
Compares two date with a precision of one second.
afterHandle(Request, Response) - Method in class org.restlet.Filter
Allows filtering after processing by the next Restlet.
afterHandle(Request, Response) - Method in class org.restlet.Transformer
 
afterSend(Representation) - Method in class org.restlet.service.ConnectorService
Call-back method invoked by the client or server connectors just after sending the entity to the target component.
AJP - Static variable in class org.restlet.data.Protocol
AJP 1.3 protocol to communicate with Apache HTTP server or Microsoft IIS.
ALGORITHM_MD2 - Static variable in class org.restlet.data.Digest
Digest algorightm defined in RFC 1319.
ALGORITHM_MD5 - Static variable in class org.restlet.data.Digest
Digest algorightm defined in RFC 1321.
ALGORITHM_SHA_1 - Static variable in class org.restlet.data.Digest
Digest algorightm defined in Secure Hash Standard, NIST FIPS 180-1.
ALGORITHM_SHA_256 - Static variable in class org.restlet.data.Digest
NIST approved digest algorithm from SHA-2 family.
ALGORITHM_SHA_384 - Static variable in class org.restlet.data.Digest
NIST approved digest algorithm from SHA-2 family.
ALGORITHM_SHA_512 - Static variable in class org.restlet.data.Digest
NIST approved digest algorithm from SHA-2 family.
ALL - Static variable in class org.restlet.data.CharacterSet
All character sets acceptable.
ALL - Static variable in class org.restlet.data.Encoding
All encodings acceptable.
ALL - Static variable in class org.restlet.data.Language
All languages acceptable.
ALL - Static variable in class org.restlet.data.MediaType
 
ALL - Static variable in class org.restlet.data.Protocol
All protocols wildcard.
ALL - Static variable in class org.restlet.data.Tag
Tag matching any other tag, used in call's condition data.
allowClient(ClientInfo) - Method in class org.restlet.service.TunnelService
Indicates if the request from a given client can be tunnelled.
allowDelete() - Method in class org.restlet.Handler
Indicates if DELETE calls are allowed.
allowDelete() - Method in class org.restlet.resource.Resource
Indicates if DELETE calls are allowed by checking the "modifiable" property.
allowGet() - Method in class org.restlet.Handler
Indicates if GET calls are allowed.
allowGet() - Method in class org.restlet.resource.Resource
Indicates if GET calls are allowed by checking the "readable" property.
allowHead() - Method in class org.restlet.Handler
Indicates if HEAD calls are allowed.
allowOptions() - Method in class org.restlet.Handler
Indicates if OPTIONS calls are allowed.
allowPost() - Method in class org.restlet.Handler
Indicates if POST calls are allowed.
allowPost() - Method in class org.restlet.resource.Resource
Indicates if POST calls are allowed by checking the "modifiable" property.
allowPut() - Method in class org.restlet.Handler
Indicates if PUT calls are allowed.
allowPut() - Method in class org.restlet.resource.Resource
Indicates if PUT calls are allowed by checking the "modifiable" property.
Application - Class in org.restlet
Restlet that can be attached to one or more VirtualHosts.
Application() - Constructor for class org.restlet.Application
Constructor.
Application(Context) - Constructor for class org.restlet.Application
Constructor.
APPLICATION_ALL - Static variable in class org.restlet.data.MediaType
 
APPLICATION_ALL_XML - Static variable in class org.restlet.data.MediaType
 
APPLICATION_ATOM_SERVICE_XML - Static variable in class org.restlet.data.MediaType
 
APPLICATION_ATOM_XML - Static variable in class org.restlet.data.MediaType
 
APPLICATION_CAB - Static variable in class org.restlet.data.MediaType
 
APPLICATION_COMPRESS - Static variable in class org.restlet.data.MediaType
 
APPLICATION_EXCEL - Static variable in class org.restlet.data.MediaType
 
APPLICATION_FLASH - Static variable in class org.restlet.data.MediaType
 
APPLICATION_GNU_TAR - Static variable in class org.restlet.data.MediaType
 
APPLICATION_GNU_ZIP - Static variable in class org.restlet.data.MediaType
 
APPLICATION_HTTP_COOKIES - Static variable in class org.restlet.data.MediaType
 
APPLICATION_JAVA - Static variable in class org.restlet.data.MediaType
 
APPLICATION_JAVA_ARCHIVE - Static variable in class org.restlet.data.MediaType
 
APPLICATION_JAVA_OBJECT - Static variable in class org.restlet.data.MediaType
 
APPLICATION_JAVASCRIPT - Static variable in class org.restlet.data.MediaType
 
APPLICATION_JNLP - Static variable in class org.restlet.data.MediaType
 
APPLICATION_JSON - Static variable in class org.restlet.data.MediaType
 
APPLICATION_LATEX - Static variable in class org.restlet.data.MediaType
 
APPLICATION_MAC_BINHEX40 - Static variable in class org.restlet.data.MediaType
 
APPLICATION_MATHML_XML - Static variable in class org.restlet.data.MediaType
 
APPLICATION_OCTET_STREAM - Static variable in class org.restlet.data.MediaType
 
APPLICATION_PDF - Static variable in class org.restlet.data.MediaType
 
APPLICATION_POSTSCRIPT - Static variable in class org.restlet.data.MediaType
 
APPLICATION_POWERPOINT - Static variable in class org.restlet.data.MediaType
 
APPLICATION_PROJECT - Static variable in class org.restlet.data.MediaType
 
APPLICATION_RDF_XML - Static variable in class org.restlet.data.MediaType
 
APPLICATION_RELAXNG_COMPACT - Static variable in class org.restlet.data.MediaType
 
APPLICATION_RELAXNG_XML - Static variable in class org.restlet.data.MediaType
 
APPLICATION_RSS_XML - Static variable in class org.restlet.data.MediaType
 
APPLICATION_RTF - Static variable in class org.restlet.data.MediaType
 
APPLICATION_STUFFIT - Static variable in class org.restlet.data.MediaType
 
APPLICATION_TAR - Static variable in class org.restlet.data.MediaType
 
APPLICATION_TEX - Static variable in class org.restlet.data.MediaType
 
APPLICATION_TROFF_MAN - Static variable in class org.restlet.data.MediaType
 
APPLICATION_VOICEXML - Static variable in class org.restlet.data.MediaType
 
APPLICATION_W3C_SCHEMA_XML - Static variable in class org.restlet.data.MediaType
 
APPLICATION_W3C_XSLT - Static variable in class org.restlet.data.MediaType
 
APPLICATION_WADL_XML - Static variable in class org.restlet.data.MediaType
 
APPLICATION_WORD - Static variable in class org.restlet.data.MediaType
 
APPLICATION_WWW_FORM - Static variable in class org.restlet.data.MediaType
 
APPLICATION_XHTML_XML - Static variable in class org.restlet.data.MediaType
 
APPLICATION_XML - Static variable in class org.restlet.data.MediaType
 
APPLICATION_XML_DTD - Static variable in class org.restlet.data.MediaType
 
APPLICATION_XUL - Static variable in class org.restlet.data.MediaType
 
APPLICATION_ZIP - Static variable in class org.restlet.data.MediaType
 
attach(Restlet) - Method in class org.restlet.Router
Attaches a target Restlet to this router with an empty URI pattern.
attach(String, Class<? extends Resource>) - Method in class org.restlet.Router
Attaches a target Resource class to this router based on a given URI pattern.
attach(String, Restlet) - Method in class org.restlet.Router
Attaches a target Restlet to this router based on a given URI pattern.
attach(Restlet) - Method in class org.restlet.VirtualHost
Attaches a target Restlet to this router with an empty URI pattern.
attach(String, Restlet) - Method in class org.restlet.VirtualHost
Attaches a target Restlet to this router based on a given URI pattern.
attachDefault(Class<? extends Resource>) - Method in class org.restlet.Router
Attaches a Resource class to this router as the default target to invoke when no route matches.
attachDefault(Restlet) - Method in class org.restlet.Router
Attaches a Restlet to this router as the default target to invoke when no route matches.
attachDefault(Restlet) - Method in class org.restlet.VirtualHost
Attaches a Restlet to this router as the default target to invoke when no route matches.
AUDIO_ALL - Static variable in class org.restlet.data.MediaType
 
AUDIO_BASIC - Static variable in class org.restlet.data.MediaType
 
AUDIO_MIDI - Static variable in class org.restlet.data.MediaType
 
AUDIO_MPEG - Static variable in class org.restlet.data.MediaType
 
AUDIO_REAL - Static variable in class org.restlet.data.MediaType
 
AUDIO_WAV - Static variable in class org.restlet.data.MediaType
 
authenticate(Request) - Method in class org.restlet.Guard
Indicates if the call is properly authenticated.
authenticate(Request, Guard) - Method in class org.restlet.util.Engine
Indicates if the call is properly authenticated.
AUTHENTICATION_INVALID - Static variable in class org.restlet.Guard
Indicates that an authentication response is considered invalid.
AUTHENTICATION_MISSING - Static variable in class org.restlet.Guard
Indicates that an authentication response couldn't be found.
AUTHENTICATION_STALE - Static variable in class org.restlet.Guard
Indicates that an authentication response is stale.
AUTHENTICATION_VALID - Static variable in class org.restlet.Guard
Indicates that an authentication response is valid.
authorize(Request) - Method in class org.restlet.Guard
Indicates if the request is authorized to pass through the Guard.
awaitTermination(long, TimeUnit) - Method in class org.restlet.service.TaskService
Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.

B

before(Date, Date) - Static method in class org.restlet.util.DateUtils
Compares two date with a precision of one second.
beforeHandle(Request, Response) - Method in class org.restlet.Filter
Allows filtering before processing by the next Restlet.
beforeHandle(Request, Response) - Method in class org.restlet.Route
Allows filtering before its handling by the target Restlet.
beforeHandle(Request, Response) - Method in class org.restlet.Transformer
 
beforeSend(Representation) - Method in class org.restlet.service.ConnectorService
Call-back method invoked by the client or server connectors just before sending the entity to the target component.
BEST - Static variable in class org.restlet.Router
Each call will be routed to the route with the best score, if the required score is reached.
ByteUtils - Class in org.restlet.util
Byte manipulation utilities.

C

challenge(Response) - Method in class org.restlet.Guard
Deprecated. Use the Guard.challenge(Response, boolean) method instead.
challenge(Response, boolean) - Method in class org.restlet.Guard
Challenges the client by adding a challenge request to the response and by setting the status to CLIENT_ERROR_UNAUTHORIZED.
challenge(Response, boolean, Guard) - Method in class org.restlet.util.Engine
Challenges the client by adding a challenge request to the response and by setting the status to CLIENT_ERROR_UNAUTHORIZED.
ChallengeRequest - Class in org.restlet.data
Authentication challenge sent by an origin server to a client.
ChallengeRequest(ChallengeScheme, String) - Constructor for class org.restlet.data.ChallengeRequest
Constructor.
ChallengeResponse - Class in org.restlet.data
Authentication response sent by client to an origin server.
ChallengeResponse(ChallengeScheme, String) - Constructor for class org.restlet.data.ChallengeResponse
Constructor.
ChallengeResponse(ChallengeScheme, String, char[]) - Constructor for class org.restlet.data.ChallengeResponse
Constructor.
ChallengeResponse(ChallengeScheme, String, Series<Parameter>) - Constructor for class org.restlet.data.ChallengeResponse
Constructor.
ChallengeResponse(ChallengeScheme, String, String) - Constructor for class org.restlet.data.ChallengeResponse
Constructor.
ChallengeScheme - Class in org.restlet.data
Challenge scheme used to authenticate remote clients.
ChallengeScheme(String, String) - Constructor for class org.restlet.data.ChallengeScheme
Constructor.
ChallengeScheme(String, String, String) - Constructor for class org.restlet.data.ChallengeScheme
Constructor.
ChannelRepresentation - Class in org.restlet.resource
Representation based on a NIO byte channel.
ChannelRepresentation(MediaType) - Constructor for class org.restlet.resource.ChannelRepresentation
Constructor.
CharacterRepresentation - Class in org.restlet.resource
Representation based on a BIO character stream.
CharacterRepresentation(MediaType) - Constructor for class org.restlet.resource.CharacterRepresentation
Constructor.
characters(char[], int, int) - Method in class org.restlet.util.XmlWriter
Write character data.
characters(String) - Method in class org.restlet.util.XmlWriter
Write a string of character data, with XML escaping.
CharacterSet - Class in org.restlet.data
Character set used to encode characters in textual representations.
CharacterSet(String) - Constructor for class org.restlet.data.CharacterSet
Constructor.
CharacterSet(String, String) - Constructor for class org.restlet.data.CharacterSet
Constructor.
checkDigest() - Method in class org.restlet.resource.DigestRepresentation
Check that the digest computed from the wrapped representation content and the digest declared by the wrapped representation are the same.
checkDigest(String) - Method in class org.restlet.resource.DigestRepresentation
Check that the digest computed from the representation content and the digest declared by the representation are the same.
checkDigest() - Method in class org.restlet.resource.Representation
Check that the digest computed from the representation content and the digest declared by the representation are the same.
Since this method relies on the Representation.computeDigest(String) method, and since this method reads entirely the representation's stream, user must take care of the content of the representation in case the latter is transient.
checkDigest(String) - Method in class org.restlet.resource.Representation
Check that the digest computed from the representation content and the digest declared by the representation are the same.
checkDigest() - Method in class org.restlet.util.WrapperRepresentation
 
checkDigest(String) - Method in class org.restlet.util.WrapperRepresentation
 
checkSecret(Request, String, char[]) - Method in class org.restlet.Guard
Indicates if the secret is valid for the given identifier.
checkSecret(String, char[]) - Method in class org.restlet.Guard
Deprecated. Use the Guard.checkSecret(Request, String, char[]) method instead.
CLAP - Static variable in class org.restlet.data.Protocol
CLAP (ClassLoader Access Protocol) is a custom scheme to access to representations via classloaders.
CLAP_CLASS - Static variable in class org.restlet.data.LocalReference
The resources will be resolved from the classloader associated with the local class.
CLAP_SYSTEM - Static variable in class org.restlet.data.LocalReference
The resources will be resolved from the system's classloader.
CLAP_THREAD - Static variable in class org.restlet.data.LocalReference
The resources will be resolved from the current thread's classloader.
clear() - Method in class org.restlet.util.WrapperList
Removes all of the elements from this list.
clear() - Method in class org.restlet.util.WrapperMap
Removes all mappings from this Map.
clearExtensions() - Method in class org.restlet.service.MetadataService
clears the mappings for all extensions.
Client - Class in org.restlet
Connector acting as a generic client.
Client(Context, List<Protocol>) - Constructor for class org.restlet.Client
Constructor.
Client(Context, List<Protocol>, String) - Constructor for class org.restlet.Client
Constructor.
Client(Context, Protocol) - Constructor for class org.restlet.Client
Constructor.
Client(List<Protocol>) - Constructor for class org.restlet.Client
Constructor.
Client(Protocol) - Constructor for class org.restlet.Client
Constructor.
Client(String) - Constructor for class org.restlet.Client
Constructor.
CLIENT_ERROR_BAD_REQUEST - Static variable in class org.restlet.data.Status
The request could not be understood by the server due to malformed syntax.
CLIENT_ERROR_CONFLICT - Static variable in class org.restlet.data.Status
The request could not be completed due to a conflict with the current state of the resource (as experienced in a version control system).
CLIENT_ERROR_EXPECTATION_FAILED - Static variable in class org.restlet.data.Status
The user agent expects some behaviour of the server (given in an Expect request-header field), but this expectation could not be met by this server.
CLIENT_ERROR_FAILED_DEPENDENCY - Static variable in class org.restlet.data.Status
This status code means that the method could not be performed on the resource because the requested action depended on another action and that action failed.
CLIENT_ERROR_FORBIDDEN - Static variable in class org.restlet.data.Status
The server understood the request, but is refusing to fulfill it as it could be explained in the entity.
CLIENT_ERROR_GONE - Static variable in class org.restlet.data.Status
The requested resource is no longer available at the server and no forwarding address is known.
CLIENT_ERROR_LENGTH_REQUIRED - Static variable in class org.restlet.data.Status
The server refuses to accept the request without a defined Content-Length.
CLIENT_ERROR_LOCKED - Static variable in class org.restlet.data.Status
The source or destination resource of a method is locked (or temporarily involved in another process).
CLIENT_ERROR_METHOD_NOT_ALLOWED - Static variable in class org.restlet.data.Status
The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
CLIENT_ERROR_NOT_ACCEPTABLE - Static variable in class org.restlet.data.Status
The resource identified by the request is only capable of generating response entities whose content characteristics do not match the user's requirements (in Accept* headers).
CLIENT_ERROR_NOT_FOUND - Static variable in class org.restlet.data.Status
The server has not found anything matching the Request-URI or the server does not wish to reveal exactly why the request has been refused, or no other response is applicable.
CLIENT_ERROR_PAYMENT_REQUIRED - Static variable in class org.restlet.data.Status
This code is reserved for future use.
CLIENT_ERROR_PRECONDITION_FAILED - Static variable in class org.restlet.data.Status
Sent by the server when the user agent asks the server to carry out a request under certain conditions that are not met.
CLIENT_ERROR_PROXY_AUTHENTIFICATION_REQUIRED - Static variable in class org.restlet.data.Status
This code is similar to 401 (Unauthorized), but indicates that the client must first authenticate itself with the proxy.
CLIENT_ERROR_REQUEST_ENTITY_TOO_LARGE - Static variable in class org.restlet.data.Status
The server is refusing to process a request because the request entity is larger than the server is willing or able to process.
CLIENT_ERROR_REQUEST_TIMEOUT - Static variable in class org.restlet.data.Status
Sent by the server when an HTTP client opens a connection, but has never sent a request (or never sent the blank line that signals the end of the request).
CLIENT_ERROR_REQUEST_URI_TOO_LONG - Static variable in class org.restlet.data.Status
The server is refusing to service the request because the Request-URI is longer than the server is willing to interpret.
CLIENT_ERROR_REQUESTED_RANGE_NOT_SATISFIABLE - Static variable in class org.restlet.data.Status
The request includes a Range request-header field and the selected resource is too small for any of the byte-ranges to apply.
CLIENT_ERROR_UNAUTHORIZED - Static variable in class org.restlet.data.Status
The request requires user authentication.
CLIENT_ERROR_UNPROCESSABLE_ENTITY - Static variable in class org.restlet.data.Status
This status code means the server understands the content type of the request entity (syntactically correct) but was unable to process the contained instructions.
CLIENT_ERROR_UNSUPPORTED_MEDIA_TYPE - Static variable in class org.restlet.data.Status
The server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method.
ClientInfo - Class in org.restlet.data
Client specific data related to a call.
ClientInfo() - Constructor for class org.restlet.data.ClientInfo
Constructor.
ClientList - Class in org.restlet.util
Modifiable list of client connectors.
ClientList(Context) - Constructor for class org.restlet.util.ClientList
Constructor.
clone() - Method in class org.restlet.data.Reference
 
compareTo(Parameter) - Method in class org.restlet.data.Parameter
Compares this object with the specified object for order.
Component - Class in org.restlet
Restlet managing a set of Connectors, VirtualHosts and Applications.
Component() - Constructor for class org.restlet.Component
Constructor.
Component(Reference) - Constructor for class org.restlet.Component
Constructor with the reference to the XML configuration file.
Component(Representation) - Constructor for class org.restlet.Component
Constructor with the representation of the XML configuration file.
COMPRESS - Static variable in class org.restlet.data.Encoding
The common Unix file compression.
computeDigest(String) - Method in class org.restlet.resource.DigestRepresentation
Compute the representation digest according to the given algorithm.
Since this method reads entirely the representation's stream, user must take care of the content of the representation in case the latter is transient.
computeDigest(String) - Method in class org.restlet.resource.Representation
Compute the representation digest according to the given algorithm.
Since this method reads entirely the representation's stream, user must take care of the content of the representation in case the latter is transient.
computeDigest(String) - Method in class org.restlet.util.WrapperRepresentation
 
Conditions - Class in org.restlet.data
Set of conditions applying to a request.
Conditions() - Constructor for class org.restlet.data.Conditions
Constructor.
CONNECT - Static variable in class org.restlet.data.Method
Used with a proxy that can dynamically switch to being a tunnel.
Connector - Class in org.restlet
Restlet enabling communication between Components.
Connector(Context) - Constructor for class org.restlet.Connector
Constructor.
Connector(Context, List<Protocol>) - Constructor for class org.restlet.Connector
Constructor.
CONNECTOR_ERROR_COMMUNICATION - Static variable in class org.restlet.data.Status
A client connector faces an error during the communication with the remote server (interruption, timeout, etc).
CONNECTOR_ERROR_CONNECTION - Static variable in class org.restlet.data.Status
A client connector can not connect to the remote server.
CONNECTOR_ERROR_INTERNAL - Static variable in class org.restlet.data.Status
Generic status code sent by a client connector when an error occurs during the process of a request to its server or the process of a response to its client.
ConnectorService - Class in org.restlet.service
Service declaring client and server connectors.
ConnectorService() - Constructor for class org.restlet.service.ConnectorService
Constructor.
contains(Object) - Method in class org.restlet.util.WrapperList
Returns true if this list contains the specified element.
containsAll(Collection<?>) - Method in class org.restlet.util.WrapperList
Returns true if this list contains all of the elements of the specified collection.
containsKey(Object) - Method in class org.restlet.util.WrapperMap
Returns true if this map contains a mapping for the specified key.
containsValue(Object) - Method in class org.restlet.util.WrapperMap
Returns true if this map maps one or more keys to the specified value.
Context - Class in org.restlet
Contextual data and services provided to a Restlet.
Context() - Constructor for class org.restlet.Context
Constructor.
Context(Logger) - Constructor for class org.restlet.Context
Constructor.
Context(String) - Constructor for class org.restlet.Context
Constructor.
CONTINUE - Static variable in class org.restlet.Filter
Indicates that the request processing should continue normally.
ConverterService - Class in org.restlet.service
Deprecated. Since 1.1 with no replacement as it doesn't fit well with content negotiation. Most users prefer to handle those conversion in Resource subclasses.
ConverterService() - Constructor for class org.restlet.service.ConverterService
Deprecated.  
Cookie - Class in org.restlet.data
Cookie provided by a client.
Cookie() - Constructor for class org.restlet.data.Cookie
Constructor.
Cookie(int, String, String) - Constructor for class org.restlet.data.Cookie
Constructor.
Cookie(int, String, String, String, String) - Constructor for class org.restlet.data.Cookie
Constructor.
Cookie(String, String) - Constructor for class org.restlet.data.Cookie
Constructor.
CookieSetting - Class in org.restlet.data
Cookie setting provided by a server.
CookieSetting() - Constructor for class org.restlet.data.CookieSetting
Default constructor.
CookieSetting(int, String, String) - Constructor for class org.restlet.data.CookieSetting
Constructor.
CookieSetting(int, String, String, String, String) - Constructor for class org.restlet.data.CookieSetting
Constructor.
CookieSetting(int, String, String, String, String, String, int, boolean) - Constructor for class org.restlet.data.CookieSetting
Constructor.
CookieSetting(int, String, String, String, String, String, int, boolean, boolean) - Constructor for class org.restlet.data.CookieSetting
Constructor.
CookieSetting(String, String) - Constructor for class org.restlet.data.CookieSetting
Preferred constructor.
COPY - Static variable in class org.restlet.data.Method
Creates a duplicate of the source resource, identified by the Request-URI, in the destination resource, identified by the URI in the Destination header.
copyResponseHeaders(Iterable<Parameter>, Response) - Method in class org.restlet.util.Engine
Copies the given header parameters into the given Response.
copyResponseHeaders(Response, Series<Parameter>) - Method in class org.restlet.util.Engine
Copies the headers of the given Response into the given Series.
copyTo(Map<String, Object>) - Method in class org.restlet.util.Series
Copies 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.
createChildContext() - Method in class org.restlet.Context
Creates a protected child context.
createClapReference(int, String) - Static method in class org.restlet.data.LocalReference
Constructor.
createDirectoryResource(Directory, Request, Response) - Method in class org.restlet.util.Engine
Creates a directory resource.
createEmpty() - Static method in class org.restlet.resource.Representation
Returns a new empty representation with no content.
createEntry(String, String) - Method in class org.restlet.data.Form
 
createEntry(String, String) - Method in class org.restlet.util.Series
Creates a new entry.
createExecutorService() - Method in class org.restlet.service.TaskService
Creates a new JDK executor service that will be wrapped.
createFileReference(File) - Static method in class org.restlet.data.LocalReference
Constructor.
createFileReference(String) - Static method in class org.restlet.data.LocalReference
Constructor.
createFileReference(String, String) - Static method in class org.restlet.data.LocalReference
Constructor.
createFinder(Class<? extends Resource>) - Method in class org.restlet.Router
Creates a new finder instance based on the "targetClass" property.
createFinder(Class<? extends Resource>) - Method in class org.restlet.VirtualHost
Creates a new finder instance based on the "targetClass" property.
createHelper(Application) - Method in class org.restlet.util.Engine
Creates a new helper for a given component.
createHelper(Client, String) - Method in class org.restlet.util.Engine
Creates a new helper for a given client connector.
createHelper(Component) - Method in class org.restlet.util.Engine
Creates a new helper for a given component.
createHelper(Server, String) - Method in class org.restlet.util.Engine
Creates a new helper for a given server connector.
createJarReference(Reference, String) - Static method in class org.restlet.data.LocalReference
Constructor.
createResolver(Map<String, ?>) - Static method in class org.restlet.util.Resolver
Creates a resolver that is based on a given map.
createResolver(Request, Response) - Static method in class org.restlet.util.Resolver
Creates a resolver that is based on a call (request, response couple).
createResource(Request, Response) - Method in class org.restlet.Finder
Deprecated. Use the Finder.createTarget(Request, Response) instead.
createRiapReference(int, String) - Static method in class org.restlet.data.LocalReference
Constructor.
createRoot() - Method in class org.restlet.Application
Creates a root Restlet that will receive all incoming calls.
createRoute(String, Restlet) - Method in class org.restlet.Router
Creates a new route for the given URI pattern and target.
createRoute(String, Restlet) - Method in class org.restlet.VirtualHost
 
createSeries(List<Parameter>) - Method in class org.restlet.data.Form
 
createSeries(List<E>) - Method in class org.restlet.util.Series
Creates a new series.
createTarget(Class<? extends Handler>, Request, Response) - Method in class org.restlet.Finder
Creates a new instance of a given handler class.
createTarget(Request, Response) - Method in class org.restlet.Finder
Creates a new instance of the handler class designated by the "targetClass" property.
createThreadFactory() - Method in class org.restlet.service.TaskService
Creates a new thread factory that will properly name the Restlet created threads with a "restlet-" prefix.
createTransformer() - Method in class org.restlet.resource.DomRepresentation
Creates a new JAXP Transformer object that will be used to serialize this DOM.
CUSTOM - Static variable in class org.restlet.data.ChallengeScheme
Custom scheme based on IP address or cookies or query params, etc.
CUSTOM - Static variable in class org.restlet.Router
Each call will be routed according to a custom mode.

D

dataElement(String, String) - Method in class org.restlet.util.XmlWriter
Write an element with character data content but no attributes or Namespace URI.
dataElement(String, String, String) - Method in class org.restlet.util.XmlWriter
Write an element with character data content but no attributes.
dataElement(String, String, String, Attributes, String) - Method in class org.restlet.util.XmlWriter
Write an element with character data content.
DateUtils - Class in org.restlet.util
Date manipulation utilities.
decode(String) - Static method in class org.restlet.data.Reference
Decodes a given string using the standard URI encoding mechanism and the UTF-8 character set.
decode(String, CharacterSet) - Static method in class org.restlet.data.Reference
Decodes a given string using the standard URI encoding mechanism.
DecoderService - Class in org.restlet.service
Service automatically decoding or decompressing request entities.
DecoderService() - Constructor for class org.restlet.service.DecoderService
Constructor.
DecoderService(boolean) - Constructor for class org.restlet.service.DecoderService
Constructor.
DEFAULT_NONCE_LIFESPAN_MILLIS - Static variable in class org.restlet.Guard
Default lifespan for generated nonces (5 minutes).
DEFLATE - Static variable in class org.restlet.data.Encoding
The zlib format defined by RFC 1950 and 1951.
DELETE - Static variable in class org.restlet.data.Method
Requests that the origin server deletes the resource identified by the request URI.
delete() - Method in class org.restlet.resource.Resource
Deprecated. Use the Resource.removeRepresentations() method instead.
delete(Reference) - Method in class org.restlet.Uniform
Deletes the identified resource.
delete(String) - Method in class org.restlet.Uniform
Deletes the identified resource.
detach(Restlet) - Method in class org.restlet.Router
Detaches the target from this router.
Digest - Class in org.restlet.data
Describes a representation digest to ensure its integrity when sent over the network.
Digest(byte[]) - Constructor for class org.restlet.data.Digest
Constructor using the MD5 algorithm by default.
Digest(String, byte[]) - Constructor for class org.restlet.data.Digest
Constructor.
DigestRepresentation - Class in org.restlet.resource
Representation capable of computing a digest.
DigestRepresentation(Representation) - Constructor for class org.restlet.resource.DigestRepresentation
Constructor.
By default, the instance relies on the Digest.ALGORITHM_MD5 digest algorithm.
DigestRepresentation(Representation, String) - Constructor for class org.restlet.resource.DigestRepresentation
Constructor.
Dimension - Enum in org.restlet.data
Dimension on which the representations of a resource may vary.
Directory - Class in org.restlet
Finder mapping a directory of local resources.
Directory(Context, Reference) - Constructor for class org.restlet.Directory
Constructor.
Directory(Context, String) - Constructor for class org.restlet.Directory
Constructor.
doHandle(Request, Response) - Method in class org.restlet.Filter
Handles the call by distributing it to the next Restlet.
doHandle(Request, Response) - Method in class org.restlet.Guard
Handles the call by distributing it to the next Restlet.
DomRepresentation - Class in org.restlet.resource
XML representation based on a DOM document.
DomRepresentation(MediaType) - Constructor for class org.restlet.resource.DomRepresentation
Constructor for an empty document.
DomRepresentation(MediaType, Document) - Constructor for class org.restlet.resource.DomRepresentation
Constructor from an existing DOM document.
DomRepresentation(Representation) - Constructor for class org.restlet.resource.DomRepresentation
Constructor.

E

EMPTY_VALUE - Static variable in class org.restlet.util.Series
A marker for empty values to differentiate from non existing values (null).
emptyElement(String) - Method in class org.restlet.util.XmlWriter
Add an empty element without a Namespace URI, qname or attributes.
emptyElement(String, String) - Method in class org.restlet.util.XmlWriter
Add an empty element without a qname or attributes.
emptyElement(String, String, String, Attributes) - Method in class org.restlet.util.XmlWriter
Write an empty element.
encode() - Method in class org.restlet.data.Form
Encodes the form using the standard URI encoding mechanism and the UTF-8 character set.
encode(CharacterSet) - Method in class org.restlet.data.Form
URL encodes the form.
encode(CharacterSet, char) - Method in class org.restlet.data.Form
URL encodes the form.
encode(Appendable, CharacterSet) - Method in class org.restlet.data.Parameter
Encodes the parameter and appends the result to the given buffer.
encode(CharacterSet) - Method in class org.restlet.data.Parameter
Encodes the parameter using the standard URI encoding mechanism.
encode(String) - Static method in class org.restlet.data.Reference
Encodes a given string using the standard URI encoding mechanism and the UTF-8 character set.
encode(String, CharacterSet) - Static method in class org.restlet.data.Reference
Encodes a given string using the standard URI encoding mechanism.
encode(String) - Method in class org.restlet.util.Variable
According to the type of the variable, encodes the value given in parameters.
Encoding - Class in org.restlet.data
Modifier of a representation's media type.
Encoding(String) - Constructor for class org.restlet.data.Encoding
Constructor.
Encoding(String, String) - Constructor for class org.restlet.data.Encoding
Constructor.
endDocument() - Method in class org.restlet.util.XmlWriter
Write a newline at the end of the document.
endElement(String) - Method in class org.restlet.util.XmlWriter
End an element without a Namespace URI or qname.
endElement(String, String) - Method in class org.restlet.util.XmlWriter
End an element without a qname.
endElement(String, String, String) - Method in class org.restlet.util.XmlWriter
Write an end tag.
Engine - Class in org.restlet.util
Facade to the engine implementating the Restlet API.
Engine() - Constructor for class org.restlet.util.Engine
 
ENGLISH - Static variable in class org.restlet.data.Language
English language.
ENGLISH_US - Static variable in class org.restlet.data.Language
English language spoken in USA.
entrySet() - Method in class org.restlet.util.WrapperMap
Returns a set view of the mappings contained in this map.
equals(Object) - Method in class org.restlet.data.ChallengeRequest
equals(Object) - Method in class org.restlet.data.ChallengeResponse
equals(Object) - Method in class org.restlet.data.ChallengeScheme
equals(Object) - Method in class org.restlet.data.CharacterSet
equals(Object) - Method in class org.restlet.data.Cookie
equals(Object) - Method in class org.restlet.data.CookieSetting
equals(Object) - Method in class org.restlet.data.Digest
 
equals(Object) - Method in class org.restlet.data.Encoding
equals(Object) - Method in class org.restlet.data.Language
equals(Object) - Method in class org.restlet.data.MediaType
equals(Object, boolean) - Method in class org.restlet.data.MediaType
Test the equality of two media types, with the possibility to ignore the parameters.
equals(Object) - Method in class org.restlet.data.Metadata
equals(Object) - Method in class org.restlet.data.Method
equals(Object) - Method in class org.restlet.data.Parameter
equals(Object) - Method in class org.restlet.data.Protocol
equals(Object) - Method in class org.restlet.data.Range
 
equals(Object) - Method in class org.restlet.data.Reference
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.restlet.data.Status
Indicates if the status is equal to a given one.
equals(Object) - Method in class org.restlet.data.Tag
Indicates if both tags are equal.
equals(Object, boolean) - Method in class org.restlet.data.Tag
Indicates if both tags are equal.
equals(Date, Date) - Static method in class org.restlet.util.DateUtils
Compares two date with a precision of one second.
equals(Object) - Method in class org.restlet.util.WrapperList
Compares the specified object with this list for equality.
equals(Object) - Method in class org.restlet.util.WrapperMap
Compares the specified object with this map for equality.
evaluate(String, QName) - Method in class org.restlet.resource.DomRepresentation
 
evaluate(String, QName) - Method in class org.restlet.resource.SaxRepresentation
 
evaluate(String, QName) - Method in class org.restlet.resource.XmlRepresentation
Evaluates an XPath expression and returns the result as in the given return type.
execute(Runnable) - Method in class org.restlet.service.TaskService
Executes the given command asynchronously.
exhaust() - Method in class org.restlet.resource.Representation
Exhauts the content of the representation by reading it and silently discarding anything read.
exhaust(InputStream) - Static method in class org.restlet.util.ByteUtils
Exhauts the content of the representation by reading it and silently discarding anything read.
exhaust() - Method in class org.restlet.util.WrapperRepresentation
 
extractCookie(String, String, boolean) - Method in class org.restlet.Route
Extracts an attribute from the request cookies.
extractEntity(String, String, boolean) - Method in class org.restlet.Route
Extracts an attribute from the request entity form.
extractQuery(String, String, boolean) - Method in class org.restlet.Route
Extracts an attribute from the query string of the resource reference.

F

FILE - Static variable in class org.restlet.data.Protocol
FILE is a standard scheme to access to representations stored in the file system (locally most of the time).
FileRepresentation - Class in org.restlet.resource
Representation based on a file.
FileRepresentation(File, MediaType) - Constructor for class org.restlet.resource.FileRepresentation
Constructor that does not set an expiration date for file
FileRepresentation(File, MediaType, int) - Constructor for class org.restlet.resource.FileRepresentation
Constructor.
FileRepresentation(String, MediaType) - Constructor for class org.restlet.resource.FileRepresentation
Constructor that does not set an expiration date for path
FileRepresentation(String, MediaType, int) - Constructor for class org.restlet.resource.FileRepresentation
Constructor.
Filter - Class in org.restlet
Restlet filtering calls before passing them to an attached Restlet.
Filter() - Constructor for class org.restlet.Filter
Constructor.
Filter(Context) - Constructor for class org.restlet.Filter
Constructor.
Filter(Context, Restlet) - Constructor for class org.restlet.Filter
Constructor.
Finder - Class in org.restlet
Restlet that can find the target handler that will effectively handle the call.
Finder() - Constructor for class org.restlet.Finder
Constructor.
Finder(Context) - Constructor for class org.restlet.Finder
Constructor.
Finder(Context, Class<? extends Handler>) - Constructor for class org.restlet.Finder
Constructor.
findSecret(String) - Method in class org.restlet.Guard
Finds the secret associated to a given identifier.
findTarget(Request, Response) - Method in class org.restlet.Directory
Finds the target handler if available.
findTarget(Request, Response) - Method in class org.restlet.Finder
Finds the target Handler if available.
fireContextChanged(Restlet, Context) - Method in class org.restlet.util.Engine
Indicates that a Restlet's context has changed.
FIRST - Static variable in class org.restlet.Router
Each call is routed to the first route if the required score is reached.
flush() - Method in class org.restlet.util.XmlWriter
Flush the output.
forbid(Response) - Method in class org.restlet.Guard
Rejects the call due to a failed authentication or authorization.
forceNSDecl(String) - Method in class org.restlet.util.XmlWriter
Force a Namespace to be declared on the root element.
forceNSDecl(String, String) - Method in class org.restlet.util.XmlWriter
Force a Namespace declaration with a preferred prefix.
Form - Class in org.restlet.data
Form which is a specialized modifiable list of parameters.
Form() - Constructor for class org.restlet.data.Form
Empty constructor.
Form(int) - Constructor for class org.restlet.data.Form
Constructor.
Form(List<Parameter>) - Constructor for class org.restlet.data.Form
Constructor.
Form(Logger, Representation) - Constructor for class org.restlet.data.Form
Deprecated. Use the constructor without logger instead.
Form(Logger, String, CharacterSet) - Constructor for class org.restlet.data.Form
Deprecated. Use the constructor without logger instead.
Form(Logger, String, CharacterSet, char) - Constructor for class org.restlet.data.Form
Deprecated. Use the constructor without logger instead.
Form(Representation) - Constructor for class org.restlet.data.Form
Constructor.
Form(String) - Constructor for class org.restlet.data.Form
Constructor.
Form(String, char) - Constructor for class org.restlet.data.Form
Constructor.
Form(String, CharacterSet) - Constructor for class org.restlet.data.Form
Constructor.
Form(String, CharacterSet, char) - Constructor for class org.restlet.data.Form
Constructor.
format() - Method in class org.restlet.data.Tag
Returns tag formatted as an HTTP tag string.
format(Date, String) - Static method in class org.restlet.util.DateUtils
Formats a Date according to the first format in the array.
format(Date, StringBuffer, FieldPosition) - Method in class org.restlet.util.InternetDateFormat
 
format(Map<String, ?>) - Method in class org.restlet.util.Template
Creates a formatted string based on the given map of values.
format(Request, Response) - Method in class org.restlet.util.Template
Creates a formatted string based on the given request and response.
format(Resolver<String>) - Method in class org.restlet.util.Template
Creates a formatted string based on the given variable resolver.
FORMAT_ASC_TIME - Static variable in class org.restlet.util.DateUtils
Obsoleted HTTP date format (ANSI C asctime() format).
FORMAT_RFC_1036 - Static variable in class org.restlet.util.DateUtils
Obsoleted HTTP date format (RFC 1036).
FORMAT_RFC_1123 - Static variable in class org.restlet.util.DateUtils
Preferred HTTP date format (RFC 1123).
FORMAT_RFC_3339 - Static variable in class org.restlet.util.DateUtils
W3C date format (RFC 3339).
FORMAT_RFC_822 - Static variable in class org.restlet.util.DateUtils
Common date format (RFC 822).
formatCookie(Cookie) - Method in class org.restlet.util.Engine
Formats the given Cookie to a String
formatCookieSetting(CookieSetting) - Method in class org.restlet.util.Engine
Formats the given CookieSetting to a String
formatDimensions(Collection<Dimension>) - Method in class org.restlet.util.Engine
Formats the given Set of Dimensions to a String for the HTTP Vary header.
formatUserAgent(List<Product>) - Method in class org.restlet.util.Engine
Formats the given List of Products to a String.
FREEMARKER - Static variable in class org.restlet.data.Encoding
The FreeMarker encoding.
FRENCH - Static variable in class org.restlet.data.Language
French language.
FRENCH_FRANCE - Static variable in class org.restlet.data.Language
French language spoken in France.
FTP - Static variable in class org.restlet.data.Protocol
FTP protocol.

G

generateRef(String) - Method in class org.restlet.Handler
Generates a reference based on a template URI.
GET - Static variable in class org.restlet.data.Method
Retrieves whatever information (in the form of an entity) that is identified by the request URI.
get(Reference) - Method in class org.restlet.Uniform
Gets the identified resource.
get(String) - Method in class org.restlet.Uniform
Gets the identified resource.
get(int) - Method in class org.restlet.util.NodeSet
 
get(int) - Method in class org.restlet.util.WrapperList
Returns the element at the specified position in this list.
get(Object) - Method in class org.restlet.util.WrapperMap
Returns the value to which this map maps the specified key.
getAcceptedCharacterSets() - Method in class org.restlet.data.ClientInfo
Returns the modifiable list of character set preferences.
getAcceptedEncodings() - Method in class org.restlet.data.ClientInfo
Returns the modifiable list of encoding preferences.
getAcceptedLanguages() - Method in class org.restlet.data.ClientInfo
Returns the modifiable list of language preferences.
getAcceptedMediaTypes() - Method in class org.restlet.data.ClientInfo
Returns the modifiable list of media type preferences.
getAddress() - Method in class org.restlet.data.ClientInfo
Returns the client's IP address which is the first address in the list of client addresses, if this list exists and isn't empty.
getAddress() - Method in class org.restlet.data.ServerInfo
Returns the IP address.
getAddress() - Method in class org.restlet.Server
Returns the optional listening IP address (local host used if null).
getAddresses() - Method in class org.restlet.data.ClientInfo
Returns the modifiable list of client IP addresses.

The first address is the one of the immediate client component as returned by the getClientAdress() method and the last address should correspond to the origin client (frequently a user agent).

This is useful when the user agent is separated from the origin server by a chain of intermediary components.
getAgent() - Method in class org.restlet.data.ClientInfo
Returns the agent name (ex: "Noelios-Restlet-Engine/1.1").
getAgent() - Method in class org.restlet.data.ServerInfo
Returns the agent name (ex: "Noelios Restlet Engine/1.1").
getAgentAttributes() - Method in class org.restlet.data.ClientInfo
Returns a list of attributes taken from the name of the user agent.
getAgentName() - Method in class org.restlet.data.ClientInfo
Returns the name of the user agent.
getAgentProducts() - Method in class org.restlet.data.ClientInfo
Returns the list of product tokens from the user agent name.
getAgentVersion() - Method in class org.restlet.data.ClientInfo
Returns the version of the user agent.
getAlgorithm() - Method in class org.restlet.data.Digest
Returns the digest algorithm.
getAllowedMethods() - Method in class org.restlet.data.Response
Returns the modifiable set of methods allowed on the requested resource.
getAllowedMethods() - Method in class org.restlet.Handler
Returns the set of allowed methods.
getAllowedMethods() - Method in class org.restlet.util.WrapperResponse
Returns the set of methods allowed on the requested resource.
getApplication() - Method in class org.restlet.Handler
Returns the parent application if it exists, or null.
getApplication() - Method in class org.restlet.Restlet
Returns the parent application if it exists, or null.
getApplication() - Method in class org.restlet.util.WrapperRestlet
 
getAttributes() - Method in class org.restlet.Context
Returns a modifiable attributes map that can be used by developers to save information relative to the context.
getAttributes() - Method in class org.restlet.data.Message
Returns the modifiable map of attributes that can be used by developers to save information relative to the message.
getAttributes() - Method in class org.restlet.util.Helper
Returns the map of attributes exchanged between the API and the Engine via this helper.
getAttributes() - Method in class org.restlet.util.WrapperRequest
Returns a modifiable attributes map that can be used by developers to save information relative to the message.
getAttributes() - Method in class org.restlet.util.WrapperResponse
Returns a modifiable attributes map that can be used by developers to save information relative to the message.
getAuthor() - Method in class org.restlet.Application
Returns the author(s).
getAuthority() - Method in class org.restlet.data.Reference
Returns the authority component for hierarchical identifiers.
getAuthority(boolean) - Method in class org.restlet.data.Reference
Returns the optionnally decoded authority component.
getAuthorityName(int) - Static method in class org.restlet.data.LocalReference
Returns an authority name.
getAvailableSize() - Method in class org.restlet.resource.Representation
Returns the size effectively available.
getAvailableSize() - Method in class org.restlet.util.WrapperRepresentation
 
getBaseRef() - Method in class org.restlet.data.Reference
Returns the base reference for relative references.
getBest(Request, Response, float) - Method in class org.restlet.util.RouteList
Returns the best route match for a given call.
getBoolean(String) - Method in class org.restlet.resource.XmlRepresentation
Evaluates an XPath expression as a boolean.
getCalendar() - Method in class org.restlet.util.InternetDateFormat
Gets the Calendar object wrapped by this InternetDateFormat object.
getChallengeRequest() - Method in class org.restlet.data.Response
Deprecated. Use the Response.getChallengeRequests() method instead.
getChallengeRequest() - Method in class org.restlet.util.WrapperResponse
Deprecated. Use the WrapperResponse.getChallengeRequests() instead.
getChallengeRequests() - Method in class org.restlet.data.Response
Returns the list of authentication requests sent by an origin server to a client.
getChallengeRequests() - Method in class org.restlet.util.WrapperResponse
Returns the list of authentication requests sent by an origin server to a client.
getChallengeResponse() - Method in class org.restlet.data.Request
Returns the authentication response sent by a client to an origin server.
getChallengeResponse() - Method in class org.restlet.util.WrapperRequest
Returns the authentication response sent by a client to an origin server.
getChannel() - Method in class org.restlet.resource.CharacterRepresentation
 
getChannel() - Method in class org.restlet.resource.DigestRepresentation
 
getChannel() - Method in class org.restlet.resource.FileRepresentation
Returns a readable byte channel.
getChannel() - Method in class org.restlet.resource.ReadableRepresentation
 
getChannel() - Method in class org.restlet.resource.Representation
Returns a channel with the representation's content.
If it is supported by a file, a read-only instance of FileChannel is returned.
This method is ensured to return a fresh channel for each invocation unless it is a transient representation, in which case null is returned.
getChannel() - Method in class org.restlet.resource.StreamRepresentation
 
getChannel() - Method in class org.restlet.resource.WritableRepresentation
 
getChannel(InputStream) - Static method in class org.restlet.util.ByteUtils
Returns a readable byte channel based on a given inputstream.
getChannel(OutputStream) - Static method in class org.restlet.util.ByteUtils
Returns a writable byte channel based on a given output stream.
getChannel(Representation) - Static method in class org.restlet.util.ByteUtils
Returns a readable byte channel based on the given representation's content and its write(WritableByteChannel) method.
getChannel() - Method in class org.restlet.util.WrapperRepresentation
 
getCharacterSet() - Method in class org.restlet.resource.Variant
Returns the character set or null if not applicable.
getCharacterSet() - Method in class org.restlet.util.WrapperRepresentation
 
getCharacterSetAttribute() - Method in class org.restlet.service.TunnelService
Deprecated. Use getCharacterSetParameter instead.
getCharacterSetParameter() - Method in class org.restlet.service.TunnelService
Returns the character set parameter name.
getClapAuthorityType() - Method in class org.restlet.data.LocalReference
Returns the type of authority.
getClassLoader() - Static method in class org.restlet.util.Engine
Returns the best class loader, first the engine class loader if available using Engine.getUserClassLoader(), otherwise the current thread context class loader, or finally the classloader of the current class.
getClientDispatcher() - Method in class org.restlet.Context
Returns a request dispatcher to available client connectors.
getClientInfo() - Method in class org.restlet.data.Request
Returns the client-specific information.
getClientInfo() - Method in class org.restlet.util.WrapperRequest
Returns the client-specific information.
getClientProtocols() - Method in class org.restlet.service.ConnectorService
Returns the modifiable list of required client protocols.
getClients() - Method in class org.restlet.Component
Returns a modifiable list of client connectors.
getCode() - Method in class org.restlet.data.Status
Returns the corresponding code (HTTP or WebDAV or custom code).
getComment() - Method in class org.restlet.data.CookieSetting
Returns the comment for the user.
getComment() - Method in class org.restlet.data.Product
Returns the facultative comment.
getComparator() - Method in class org.restlet.Directory
Returns the reference comparator used to sort index pages.
getComputedDigest() - Method in class org.restlet.resource.DigestRepresentation
Returns the current computed digest value of the representation.
getConditions() - Method in class org.restlet.data.Request
Returns the modifiable conditions applying to this request.
getConditions() - Method in class org.restlet.util.WrapperRequest
Returns the conditions applying to this call.
getConnectorService() - Method in class org.restlet.Application
Returns the connector service.
getConnectTimeout() - Method in class org.restlet.Client
Returns the connection timeout in milliseconds.
getContactEmail() - Method in class org.restlet.service.StatusService
Returns the email address to contact in case of error.
getContext() - Method in class org.restlet.Handler
Returns the context.
getContext() - Method in class org.restlet.Restlet
Returns the context.
getContext() - Method in class org.restlet.util.ClientList
Returns the context.
getContext() - Method in class org.restlet.util.Helper
Returns the helped Restlet context.
getContext() - Method in class org.restlet.util.ServerList
Returns the context.
getContext() - Method in class org.restlet.util.WrapperRestlet
 
getConverterService() - Method in class org.restlet.Application
Deprecated. Since 1.1 with no replacement as it doesn't fit well with content negotiation. Most users prefer to handle those conversion in Resource subclasses.
getCookies() - Method in class org.restlet.data.Request
Returns the modifiable series of cookies provided by the client.
getCookies() - Method in class org.restlet.util.WrapperRequest
Returns the cookies provided by the client.
getCookieSettings() - Method in class org.restlet.data.Response
Returns the modifiable series of cookie settings provided by the server.
getCookieSettings() - Method in class org.restlet.util.WrapperResponse
Returns the cookie settings provided by the server.
getCredentials() - Method in class org.restlet.data.ChallengeResponse
Returns the credentials.
getCurrent() - Static method in class org.restlet.Application
This variable is stored internally as a thread local variable and updated each time a call enters an application.
getCurrent() - Static method in class org.restlet.Context
Returns the context associated to the current Restlet.
getCurrent() - Static method in class org.restlet.data.Request
Returns the request associated to the current thread.
getCurrent() - Static method in class org.restlet.data.Response
Returns the response associated to the current thread.
getCurrent() - Static method in class org.restlet.VirtualHost
Returns the virtual host code associated to the current thread.
getCurrentLogger() - Static method in class org.restlet.Context
Returns the current context's logger.
getCustom(Request, Response) - Method in class org.restlet.Router
Returns the matched route according to a custom algorithm.
getDate() - Method in class org.restlet.util.InternetDateFormat
Gets the value of this InternetDateFormat object as a Date object.
getDecoderService() - Method in class org.restlet.Application
Returns the decoder service.
getDefaultEncoding() - Method in class org.restlet.service.MetadataService
Returns the default encoding for local representations.
getDefaultHost() - Method in class org.restlet.Component
Returns the default virtual host.
getDefaultLanguage() - Method in class org.restlet.service.MetadataService
Returns the default language for local representations.
getDefaultMatchingMode() - Method in class org.restlet.Router
Returns the default matching mode to use when selecting routes based on URIs.
getDefaultMatchQuery() - Method in class org.restlet.Router
Returns the default setting for whether the routing should be done on URIs with or without taking into account query string.
getDefaultMediaType() - Method in class org.restlet.service.MetadataService
Returns the default media type for local representations.
getDefaultPort() - Method in class org.restlet.data.Protocol
Returns the default port number.
getDefaultRoute() - Method in class org.restlet.Router
Returns the default route to test if no other one was available after retrying the maximum number of attemps.
getDefaultValue() - Method in class org.restlet.util.Variable
Returns the default value to use if the key couldn't be found in the model.
getDefaultVariable() - Method in class org.restlet.util.Template
Returns the default variable.
getDelegate() - Method in class org.restlet.util.WrapperList
Returns the delegate list.
getDelegate() - Method in class org.restlet.util.WrapperMap
Returns the delegate list.
getDescription() - Method in class org.restlet.Application
Returns the description.
getDescription() - Method in class org.restlet.data.CookieSetting
Returns the description of this REST element.
getDescription() - Method in class org.restlet.data.Metadata
Returns the description.
getDescription() - Method in class org.restlet.data.Status
Returns the description.
getDescription() - Method in class org.restlet.data.Tag
Returns the description.
getDigest() - Method in class org.restlet.resource.Representation
Returns the representation digest if any.
getDigest() - Method in class org.restlet.util.WrapperRepresentation
 
getDimensions() - Method in class org.restlet.data.Response
Returns the modifiable set of selecting dimensions on which the response entity may vary.
getDimensions() - Method in class org.restlet.util.WrapperResponse
Returns the set of selecting dimensions on which the response entity may vary.
getDispatcher() - Method in class org.restlet.Context
Deprecated. Use getClientDispatcher() instead.
getDocument() - Method in class org.restlet.resource.DomRepresentation
Returns the wrapped DOM document.
getDocumentBuilder() - Method in class org.restlet.resource.XmlRepresentation
Returns a document builder properly configured.
getDomain() - Method in class org.restlet.data.Cookie
Returns the domain name.
getDomainUris() - Method in class org.restlet.Guard
Returns the base URIs that collectively define the protected domain for HTTP Digest Authentication.
getDomSource() - Method in class org.restlet.resource.DomRepresentation
Returns a DOM source.
getDomSource() - Method in class org.restlet.resource.XmlRepresentation
Returns a DOM source.
getDownloadName() - Method in class org.restlet.resource.Representation
Returns the suggested download file name for this representation.
getDownloadName() - Method in class org.restlet.util.WrapperRepresentation
 
getEncodingAttribute() - Method in class org.restlet.service.TunnelService
Deprecated. Use getEncodingParameter instead.
getEncodingParameter() - Method in class org.restlet.service.TunnelService
Returns the name of the parameter containing the accepted encoding.
getEncodings() - Method in class org.restlet.resource.Variant
Returns the modifiable list of encodings applied to the entity-body.
getEncodings() - Method in class org.restlet.util.WrapperRepresentation
 
getEntity() - Method in class org.restlet.data.Message
Returns the entity representation.
getEntity() - Method in class org.restlet.util.WrapperRequest
Returns the entity representation.
getEntity() - Method in class org.restlet.util.WrapperResponse
Returns the entity representation.
getEntityAsDom() - Method in class org.restlet.data.Message
Returns the entity as a DOM representation.
This method can be called several times and will always return the same representation instance.
getEntityAsDom() - Method in class org.restlet.util.WrapperRequest
 
getEntityAsDom() - Method in class org.restlet.util.WrapperResponse
Returns the entity as a DOM representation.
Note that this triggers the parsing of the entity into a reusable DOM document stored in memory.
This method and the related getEntity*() methods can only be invoked once.
getEntityAsForm() - Method in class org.restlet.data.Message
Returns the entity as a form.
This method can be called several times and will always return the same form instance.
getEntityAsForm() - Method in class org.restlet.util.WrapperRequest
Returns the entity as a DOM representation.
Note that this triggers the parsing of the entity into a reusable DOM document stored in memory.
This method and the related getEntity*() methods can only be invoked once.
getEntityAsForm() - Method in class org.restlet.util.WrapperResponse
Returns the entity as a DOM representation.
Note that this triggers the parsing of the entity into a reusable DOM document stored in memory.
This method and the related getEntity*() methods can only be invoked once.
getEntityAsObject() - Method in class org.restlet.data.Message
Deprecated. Since 1.1, the ConverterService is deprecated, with no replacement as it doesn't fit well with content negotiation. Most users prefer to handle those conversion in Resource subclasses.
getEntityAsObject() - Method in class org.restlet.util.WrapperRequest
Deprecated. Since 1.1, the ConverterService is deprecated, with no replacement as it doesn't fit well with content negotiation. Most users prefer to handle those conversion in Resource subclasses.
getEntityAsObject() - Method in class org.restlet.util.WrapperResponse
Deprecated. Since 1.1, the ConverterService is deprecated, with no replacement as it doesn't fit well with content negotiation. Most users prefer to handle those conversion in Resource subclasses.
getEntityAsSax() - Method in class org.restlet.data.Message
Returns the entity as a SAX representation.
This method can be called several times and will always return the same representation instance.
getEntityAsSax() - Method in class org.restlet.util.WrapperRequest
Returns the entity as a SAX representation.
Note that this kind of representation can only be parsed once.
getEntityAsSax() - Method in class org.restlet.util.WrapperResponse
Returns the entity as a SAX representation.
Note that this kind of representation can only be parsed once.
getEphemeralPort() - Method in class org.restlet.Server
Returns the actual ephemeral port used when the listening port is set to '0'.
getExpirationDate() - Method in class org.restlet.resource.Representation
Returns the future date when this representation expire.
getExpirationDate() - Method in class org.restlet.resource.Variant
Deprecated. Use the Representation.getExpirationDate() method instead.
getExpirationDate() - Method in class org.restlet.util.WrapperRepresentation
 
getExtension(Metadata) - Method in class org.restlet.service.MetadataService
Returns the first extension mapping to this metadata.
getExtensions() - Method in class org.restlet.data.Reference
Returns the optional extensions for hierarchical identifiers.
getExtensionsAsArray() - Method in class org.restlet.data.Reference
Returns the extensions as an array or null if no extension is found.
getFile() - Method in class org.restlet.data.LocalReference
Gets the local file corresponding to the reference.
getFile() - Method in class org.restlet.resource.FileRepresentation
Returns the file handle.
getFinderClass() - Method in class org.restlet.Router
Returns the finder class to instantiate.
getFirst(Request, Response, float) - Method in class org.restlet.util.RouteList
Returns the first route match for a given call.
getFirst(String) - Method in class org.restlet.util.Series
Returns the first parameter found with the given name.
getFirst(String, boolean) - Method in class org.restlet.util.Series
Returns the first parameter found with the given name.
getFirstValue(String) - Method in class org.restlet.util.Series
Returns the value of the first parameter found with the given name.
getFirstValue(String, boolean) - Method in class org.restlet.util.Series
Returns the value of the first parameter found with the given name.
getFirstValue(String, boolean, String) - Method in class org.restlet.util.Series
Returns the value of the first parameter found with the given name.
getFirstValue(String, String) - Method in class org.restlet.util.Series
Returns the value of the first parameter found with the given name.
getFragment() - Method in class org.restlet.data.Reference
Returns the fragment identifier.
Note that no URI decoding is done by this method.
getFragment(boolean) - Method in class org.restlet.data.Reference
Returns the optionnally decoded fragment identifier.
getHelped() - Method in class org.restlet.util.Helper
Returns the helped Restlet.
getHelpedParameters() - Method in class org.restlet.util.Helper
Returns the helped Restlet parameters.
getHierarchicalPart() - Method in class org.restlet.data.Reference
Returns the hierarchical part which is equivalent to the scheme specific part less the query component.
Note that no URI decoding is done by this method.
getHierarchicalPart(boolean) - Method in class org.restlet.data.Reference
Returns the optionnally decoded hierarchical part.
getHomeRef() - Method in class org.restlet.service.StatusService
Returns the home URI to propose in case of error.
getHostDomain() - Method in class org.restlet.data.Reference
Returns the host domain name component for server based hierarchical identifiers.
getHostDomain(boolean) - Method in class org.restlet.data.Reference
Returns the optionnally decoded host domain name component.
getHostDomain() - Method in class org.restlet.VirtualHost
Returns the hostRef host domain to match.
getHostIdentifier() - Method in class org.restlet.data.Reference
Returns the host identifier.
getHostIdentifier(boolean) - Method in class org.restlet.data.Reference
Returns the optionnally decoded host identifier.
getHostPort() - Method in class org.restlet.data.Reference
Returns the optional port number for server based hierarchical identifiers.
getHostPort() - Method in class org.restlet.VirtualHost
Returns the hostRef host port to match.
getHostRef() - Method in class org.restlet.data.Request
Returns the host reference.
getHostRef() - Method in class org.restlet.util.WrapperRequest
Returns the host reference.
getHosts() - Method in class org.restlet.Component
Returns the modifiable list of virtual hosts.
getHostScheme() - Method in class org.restlet.VirtualHost
Returns the hostRef scheme to match.
getIdentifier() - Method in class org.restlet.data.ChallengeResponse
Returns the user identifier, such as a login name or an access key.
getIdentifier() - Method in class org.restlet.data.Reference
Returns the absolute resource identifier, without the fragment.
Note that no URI decoding is done by this method.
getIdentifier(boolean) - Method in class org.restlet.data.Reference
Returns the optionnally decoded absolute resource identifier.
getIdentifier() - Method in class org.restlet.data.ReferenceList
Returns the list identifier.
getIdentifier() - Method in class org.restlet.resource.Variant
Returns an optional identifier.
getIdentifier() - Method in class org.restlet.util.WrapperRepresentation
 
getIndentStep() - Method in class org.restlet.util.XmlWriter
Return the current indent step.
getIndex() - Method in class org.restlet.data.Range
Returns the index from which to start the range.
getIndexName() - Method in class org.restlet.Directory
Returns the index name, without extensions.
getIndexRepresentation(Variant, ReferenceList) - Method in class org.restlet.Directory
Returns an actual index representation for a given variant.
getIndexVariants(ReferenceList) - Method in class org.restlet.Directory
Returns the variant representations of a directory index.
getInstance() - Static method in class org.restlet.util.Engine
Returns the registered Restlet engine.
getInternalRouter() - Method in class org.restlet.Component
Returns the private internal router were Restlets like Applications can be attached.
getIpAddress(String) - Static method in class org.restlet.VirtualHost
Returns the IP address of a given domain name.
getJarEntryPath() - Method in class org.restlet.data.LocalReference
Returns the JAR entry path.
getJarFileRef() - Method in class org.restlet.data.LocalReference
Returns the JAR file reference.
getLanguageAttribute() - Method in class org.restlet.service.TunnelService
Deprecated. Use getLanguageParameter instead.
getLanguageParameter() - Method in class org.restlet.service.TunnelService
Returns the name of the parameter containing the accepted language.
getLanguages() - Method in class org.restlet.resource.Variant
Returns the modifiable list of languages.
getLanguages() - Method in class org.restlet.util.WrapperRepresentation
 
getLast(Request, Response, float) - Method in class org.restlet.util.RouteList
Returns the last route match for a given call.
getLastSegment() - Method in class org.restlet.data.Reference
Returns the last segment of a hierarchical path.
For example the "/a/b/c" and "/a/b/c/" paths have the same segments: "a", "b", "c.
Note that no URI decoding is done by this method.
getLastSegment(boolean) - Method in class org.restlet.data.Reference
Returns the optionnally decoded last segment.
getLastSegment(boolean, boolean) - Method in class org.restlet.data.Reference
Returns the optionnally decoded last segment.
getLength() - Method in class org.restlet.util.NodeSet
getLocalHostAddress() - Static method in class org.restlet.VirtualHost
Returns the local host IP address.
getLocalHostName() - Static method in class org.restlet.VirtualHost
Returns the local host name.
getLocationRef() - Method in class org.restlet.data.Response
Returns the reference that the client should follow for redirections or resource creations.
getLocationRef() - Method in class org.restlet.util.WrapperResponse
Returns the reference that the client should follow for redirections or resource creations.
getLogFormat() - Method in class org.restlet.service.LogService
Returns the format used.
getLogger() - Method in class org.restlet.Context
Returns the logger.
getLogger() - Method in class org.restlet.Handler
Returns the logger to use.
getLogger() - Method in class org.restlet.Restlet
Returns the context's logger.
getLogger() - Method in class org.restlet.util.Helper
Returns the helped Restlet logger.
getLogger() - Method in class org.restlet.util.Template
Returns the logger to use.
getLogger() - Method in class org.restlet.util.WrapperRestlet
 
getLoggerName() - Method in class org.restlet.service.LogService
Returns the name of the JDK's logger to use when logging access calls.
getLogService() - Method in class org.restlet.Component
Returns the global log service.
getMainAgentProduct() - Method in class org.restlet.data.ClientInfo
Returns a Product object based on the name of the user agent.
getMainType() - Method in class org.restlet.data.MediaType
Returns the main type.
getMappings() - Method in class org.restlet.service.MetadataService
Deprecated. .
getMatch() - Method in class org.restlet.data.Conditions
Returns the modifiable list of tags for the "if-match" condition.
getMatchingMode() - Method in class org.restlet.Route
Returns the matching mode to use on the template when parsing a formatted reference.
getMatchingMode() - Method in class org.restlet.util.Template
Returns the matching mode to use when parsing a formatted reference.
getMatchQuery() - Method in class org.restlet.Route
Indicates whether the query part should be taken into account when matching a reference with the template.
getMatrix() - Method in class org.restlet.data.Reference
Returns the optional matrix for hierarchical identifiers.
getMatrix(boolean) - Method in class org.restlet.data.Reference
Returns the optionnally decoded matrix.
getMatrix() - Method in class org.restlet.Handler
Returns the optional matrix of the request's target resource reference as a form (series of parameters).
getMatrixAsForm() - Method in class org.restlet.data.Reference
Returns the optional matrix as a form.
getMatrixAsForm(CharacterSet) - Method in class org.restlet.data.Reference
Returns the optional matrix as a form submission.
getMatrixString() - Method in class org.restlet.data.Form
Formats the form as a matrix path string.
getMatrixString(CharacterSet) - Method in class org.restlet.data.Form
Formats the form as a query string.
getMaxAge() - Method in class org.restlet.data.CookieSetting
Returns the maximum age in seconds.
Use 0 to immediately discard an existing cookie.
Use -1 to discard the cookie at the end of the session (default).
getMaxAttempts() - Method in class org.restlet.Router
Returns the maximum number of attempts if no attachment could be matched on the first attempt.
getMediaType() - Method in class org.restlet.resource.Variant
Returns the media type.
getMediaType() - Method in class org.restlet.util.WrapperRepresentation
 
getMediaTypeAttribute() - Method in class org.restlet.service.TunnelService
Deprecated. Use getMediaTypeParameter instead.
getMediaTypeParameter() - Method in class org.restlet.service.TunnelService
Returns the name of the parameter containing the accepted media type.
getMetadata() - Method in class org.restlet.data.Preference
Returns the metadata associated with this preference.
getMetadata(String) - Method in class org.restlet.service.MetadataService
Returns the metadata associated to this extension.
getMetadataService() - Method in class org.restlet.Application
Returns the metadata service.
getMethod() - Method in class org.restlet.data.Request
Returns the method.
getMethod() - Method in class org.restlet.util.WrapperRequest
Returns the method.
getMethodParameter() - Method in class org.restlet.service.TunnelService
Returns the method parameter name.
getMode() - Method in class org.restlet.Redirector
Returns the redirection mode.
getMode() - Method in class org.restlet.Transformer
Returns the transformation mode.
getModificationDate() - Method in class org.restlet.resource.Representation
Returns the last date when this representation was modified.
getModificationDate() - Method in class org.restlet.resource.Variant
Deprecated. Use the Representation.getModificationDate() method instead.
getModificationDate() - Method in class org.restlet.util.WrapperRepresentation
 
getModifiedSince() - Method in class org.restlet.data.Conditions
Returns the "if-modified-since" condition.
getMostSpecific(MediaType...) - Static method in class org.restlet.data.MediaType
Returns the first of the most specific MediaTypes of the given array of MediaTypes.
getName() - Method in class org.restlet.Application
Returns the display name.
getName() - Method in class org.restlet.data.Metadata
Returns the name (ex: "text/html" or "compress" or "iso-8851-1").
getName() - Method in class org.restlet.data.Parameter
Returns the name of this parameter.
getName() - Method in class org.restlet.data.Product
Returns the product name.
getName() - Method in class org.restlet.data.Status
Returns the name of this status.
getName() - Method in class org.restlet.data.Tag
Returns the name, corresponding to an HTTP opaque tag value.
getName() - Method in class org.restlet.VirtualHost
Returns the display name.
getNames() - Method in class org.restlet.util.Series
Returns the set of parameter names (case sensitive).
getNamespaceURI(String) - Method in class org.restlet.resource.XmlRepresentation
getNext() - Method in class org.restlet.Filter
Returns the next Restlet.
getNext(Request, Response) - Method in class org.restlet.Router
Returns the next Restlet if available.
getNext(Request, Response, float) - Method in class org.restlet.util.RouteList
Returns a next route match in a round robin mode for a given call.
getNode(String) - Method in class org.restlet.resource.XmlRepresentation
Evaluates an XPath expression as a DOM Node.
getNodes(String) - Method in class org.restlet.resource.XmlRepresentation
Evaluates an XPath expression as a DOM NodeList.
getNonceLifespan() - Method in class org.restlet.Guard
Returns the number of milliseconds between each mandatory nonce refresh.
getNoneMatch() - Method in class org.restlet.data.Conditions
Returns the modifiable list of tags for the "if-none-match" condition.
getNumber(String) - Method in class org.restlet.resource.XmlRepresentation
Evaluates an XPath expression as a number.
getObject() - Method in class org.restlet.resource.ObjectRepresentation
Returns the represented object.
getOriginalRef() - Method in class org.restlet.data.Request
Returns the original reference as requested by the client.
getOutputProperties() - Method in class org.restlet.resource.TransformRepresentation
Returns the modifiable map of JAXP transformer output properties.
getOwner() - Method in class org.restlet.Application
Returns the owner(s).
getParameters() - Method in class org.restlet.Context
Returns the modifiable series of parameters.
getParameters() - Method in class org.restlet.data.ChallengeRequest
Returns the modifiable series of scheme parameters.
getParameters() - Method in class org.restlet.data.ChallengeResponse
Returns the modifiable series of scheme parameters.
getParameters() - Method in class org.restlet.data.MediaType
Returns the modifiable list of parameters.
getParameters() - Method in class org.restlet.data.Preference
Returns the modifiable list of parameters.
getParameters() - Method in class org.restlet.resource.TransformRepresentation
Returns the modiable map of JAXP transformer parameters.
getParentRef() - Method in class org.restlet.data.Reference
Returns the parent reference of a hierarchical reference.
getPath() - Method in class org.restlet.data.Cookie
Returns the validity path.
getPath() - Method in class org.restlet.data.Reference
Returns the path component for hierarchical identifiers.
Note that no URI decoding is done by this method.
getPath(boolean) - Method in class org.restlet.data.Reference
Returns the optionnally decoded path component.
getPattern() - Method in class org.restlet.util.Template
Returns the pattern to use for formatting or parsing.
getPort() - Method in class org.restlet.data.ClientInfo
Returns the port number which sent the call.
getPort() - Method in class org.restlet.data.ServerInfo
Returns the port number which received the call.
getPort() - Method in class org.restlet.Server
Returns the listening port if specified.
getPreferredRepresentation() - Method in class org.restlet.resource.Resource
Deprecated. Use the Resource.represent() method instead.
getPreferredVariant(List<Variant>, Language) - Method in class org.restlet.data.ClientInfo
Returns the best variant for a given resource according the the client preferences: accepted languages, accepted character sets, accepted media types and accepted encodings.
A default language is provided in case the variants don't match the client preferences.
getPreferredVariant(Resource, Language) - Method in class org.restlet.data.ClientInfo
Returns the best variant for a given resource according the the client preferences.
A default language is provided in case the resource's variants don't match the client preferences.
getPreferredVariant() - Method in class org.restlet.resource.Resource
Returns the preferred variant according to the client preferences specified in the request.
getPreferredVariant(ClientInfo, List<Variant>, Language) - Method in class org.restlet.util.Engine
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.
getPrefix(String) - Method in class org.restlet.resource.XmlRepresentation
getPrefix(String) - Method in class org.restlet.util.XmlWriter
Get the current or preferred prefix for a Namespace URI.
getPrefixes(String) - Method in class org.restlet.resource.XmlRepresentation
getPrimaryTag() - Method in class org.restlet.data.Language
Returns the primary tag.
getPrincipal() - Method in class org.restlet.data.ChallengeResponse
Gets the principal associated to the identifier property.
getProtocol() - Method in class org.restlet.data.Request
Returns the protocol by first returning the resourceRef.schemeProtocol property if it is set, or the baseRef.schemeProtocol property otherwise.
getProtocol() - Method in class org.restlet.util.WrapperRequest
Returns the protocol by first returning the baseRef.schemeProtocol property if it is set, or the resourceRef.schemeProtocol property otherwise.
getProtocols() - Method in class org.restlet.Connector
Returns the modifiable list of protocols simultaneously supported.
getQuality() - Method in class org.restlet.data.Preference
Returns the quality/preference level.
getQuery() - Method in class org.restlet.data.Reference
Returns the optional query component for hierarchical identifiers.
Note that no URI decoding is done by this method.
getQuery(boolean) - Method in class org.restlet.data.Reference
Returns the optionnally decoded query component.
getQuery() - Method in class org.restlet.Handler
Returns the parsed query of the request's target resource reference as a form (series of parameters).
getQueryAsForm() - Method in class org.restlet.data.Reference
Returns the optional query component as a form.
getQueryAsForm(CharacterSet) - Method in class org.restlet.data.Reference
Returns the optional query component as a form submission.
getQueryString() - Method in class org.restlet.data.Form
Formats the form as a query string.
getQueryString(CharacterSet) - Method in class org.restlet.data.Form
Formats the form as a query string.
getRandom(Request, Response, float) - Method in class org.restlet.util.RouteList
Returns a random route match for a given call.
getRange() - Method in class org.restlet.resource.Representation
Returns the range where in the full content the partial content available should be applied.
getRange() - Method in class org.restlet.util.WrapperRepresentation
 
getRanges() - Method in class org.restlet.data.Request
Returns the ranges to return from the target resource's representation.
getRangeService() - Method in class org.restlet.Application
Returns the range service.
getReader() - Method in class org.restlet.resource.ChannelRepresentation
 
getReader() - Method in class org.restlet.resource.DigestRepresentation
 
getReader() - Method in class org.restlet.resource.FileRepresentation
 
getReader() - Method in class org.restlet.resource.ReaderRepresentation
 
getReader() - Method in class org.restlet.resource.Representation
Returns a characters reader with the representation's content.
getReader() - Method in class org.restlet.resource.StreamRepresentation
 
getReader() - Method in class org.restlet.resource.WriterRepresentation
 
getReader(InputStream, CharacterSet) - Static method in class org.restlet.util.ByteUtils
Returns a reader from an input stream and a character set.
getReader(WriterRepresentation) - Static method in class org.restlet.util.ByteUtils
Returns a reader from a writer representation.Internally, it uses a writer thread and a pipe stream.
getReader() - Method in class org.restlet.util.WrapperRepresentation
 
getRealm() - Method in class org.restlet.data.ChallengeRequest
Returns the realm name.
getRealm() - Method in class org.restlet.Guard
Returns the authentication realm.
getRedirectRef() - Method in class org.restlet.data.Response
Deprecated. Use getLocationRef() instead.
getRedirectRef() - Method in class org.restlet.util.WrapperResponse
Deprecated. Use the getLocationRef() method instead.
getReferrerRef() - Method in class org.restlet.data.Request
Returns the referrer reference if available.
getReferrerRef() - Method in class org.restlet.util.WrapperRequest
Returns the referrer reference if available.
getRelativePart() - Method in class org.restlet.data.Reference
Returns the relative part of relative references, without the query and fragment.
getRelativePart(boolean) - Method in class org.restlet.data.Reference
Returns the optionnally decoded relative part.
getRelativeRef() - Method in class org.restlet.data.Reference
Returns the current reference as a relative reference to the current base reference.
getRelativeRef(Reference) - Method in class org.restlet.data.Reference
Returns the current reference relatively to a base reference.
getRemainingPart() - Method in class org.restlet.data.Reference
Returns the part of the resource identifier remaining after the base reference.
getRemainingPart(boolean) - Method in class org.restlet.data.Reference
Returns the optionally decoded remaining part.
getRemainingPart(boolean, boolean) - Method in class org.restlet.data.Reference
Returns the optionally decoded remaining part with or without the query part of the reference.
getRepresentation(Variant) - Method in class org.restlet.resource.Resource
Deprecated. Use the Resource.represent(Variant) method instead.
getRepresentation(Status, Request, Response) - Method in class org.restlet.service.StatusService
Returns a representation for the given status.
In order to customize the default representation, this method can be overriden.
getRequest() - Method in class org.restlet.data.Response
Returns the associated request
getRequest() - Method in class org.restlet.Handler
Returns the request.
getRequest() - Method in class org.restlet.util.WrapperResponse
Returns the associated request
getRequiredScore() - Method in class org.restlet.Router
Returns the minimum score required to have a match.
getResourceDomain() - Method in class org.restlet.VirtualHost
Returns the resourceRef host domain to match.
getResourcePort() - Method in class org.restlet.VirtualHost
Returns the resourceRef host port to match.
getResourceRef() - Method in class org.restlet.data.Request
Returns the reference of the target resource.
getResourceRef() - Method in class org.restlet.util.WrapperRequest
Returns the reference of the target resource.
getResourceScheme() - Method in class org.restlet.VirtualHost
Returns the resourceRef scheme to match.
getResponse() - Method in class org.restlet.Handler
Returns the response.
getResultCharacterSet() - Method in class org.restlet.Transformer
Returns the character set of the result representation.
getResultEncodings() - Method in class org.restlet.Transformer
Returns the modifiable list of encodings of the result representation.
getResultLanguages() - Method in class org.restlet.Transformer
Returns the modifiable list of languages of the result representation.
getResultMediaType() - Method in class org.restlet.Transformer
Returns the media type of the result representation.
getRetryDelay() - Method in class org.restlet.Router
Returns the delay (in seconds) before a new attempt.
getRiapAuthorityType() - Method in class org.restlet.data.LocalReference
Returns the type of authority.
getRoot() - Method in class org.restlet.Application
Returns the root Restlet.
getRootRef() - Method in class org.restlet.data.Request
Returns the application root reference.
getRootRef() - Method in class org.restlet.Directory
Returns the root URI from which the relative resource URIs will be lookep up.
getRootRef() - Method in class org.restlet.util.WrapperRequest
Returns the application root reference.
getRouter() - Method in class org.restlet.Route
Returns the parent router.
getRoutes() - Method in class org.restlet.Router
Returns the modifiable list of routes.
getRoutingMode() - Method in class org.restlet.Router
Returns the routing mode.
getSaxSource() - Method in class org.restlet.resource.SaxRepresentation
Returns the SAX source that can be parsed by the SaxRepresentation.parse(ContentHandler) method or used for an XSLT transformation.
getSaxSource() - Method in class org.restlet.resource.TransformRepresentation
Returns the SAX source associated to the source representation.
getSaxSource(Representation) - Static method in class org.restlet.resource.XmlRepresentation
Returns a SAX source.
getSaxSource() - Method in class org.restlet.resource.XmlRepresentation
Returns a SAX source.
getScheme() - Method in class org.restlet.data.ChallengeRequest
Returns the scheme used.
getScheme() - Method in class org.restlet.data.ChallengeResponse
Returns the scheme used.
getScheme() - Method in class org.restlet.data.Reference
Returns the scheme component.
Note that no URI decoding is done by this method.
getScheme(boolean) - Method in class org.restlet.data.Reference
Returns the optionnally decoded scheme component.
getScheme() - Method in class org.restlet.Guard
Returns the authentication challenge scheme.
getSchemeName() - Method in class org.restlet.data.Protocol
Returns the URI scheme name.
getSchemeProtocol() - Method in class org.restlet.data.Reference
Returns the protocol associated with the scheme component.
getSchemeSpecificPart() - Method in class org.restlet.data.Reference
Returns the scheme specific part.
Note that no URI decoding is done by this method.
getSchemeSpecificPart(boolean) - Method in class org.restlet.data.Reference
Returns the optionnally decoded scheme specific part.
getSecret() - Method in class org.restlet.data.ChallengeResponse
Returns the user secret, such as a password or a secret key.
getSecretResolver() - Method in class org.restlet.Guard
Returns the secret resolver.
getSecrets() - Method in class org.restlet.Guard
Returns the modifiable map of identifiers and secrets.
getSegments() - Method in class org.restlet.data.Reference
Returns the list of segments in a hierarchical path.
A new list is created for each call.
Note that no URI decoding is done by this method.
getSegments(boolean) - Method in class org.restlet.data.Reference
Returns the optionnally decoded list of segments.
getServerAddress() - Method in class org.restlet.VirtualHost
Returns the listening server address.
getServerDispatcher() - Method in class org.restlet.Context
Returns a request dispatcher to component's virtual hosts.
getServerInfo() - Method in class org.restlet.data.Response
Returns the server-specific information.
getServerInfo() - Method in class org.restlet.util.WrapperResponse
Returns the server-specific information.
getServerKey() - Method in class org.restlet.Guard
Returns the secret key known only by server.
getServerPort() - Method in class org.restlet.VirtualHost
Returns the listening server port.
getServerProtocols() - Method in class org.restlet.service.ConnectorService
Returns the modifiable list of required server protocols.
getServers() - Method in class org.restlet.Component
Returns the modifiable list of server connectors.
getSize() - Method in class org.restlet.data.Range
Returns the size of the range in number of bytes.
getSize() - Method in class org.restlet.resource.FileRepresentation
 
getSize() - Method in class org.restlet.resource.Representation
Returns the size in bytes if known, UNKNOWN_SIZE (-1) otherwise.
getSize() - Method in class org.restlet.resource.Variant
Deprecated. Use the Representation.getSize() method instead.
getSize() - Method in class org.restlet.util.WrapperRepresentation
 
getSourceRepresentation() - Method in class org.restlet.resource.TransformRepresentation
Returns the source representation to transform.
getStatus(Method, Representation) - Method in class org.restlet.data.Conditions
Returns the conditional status of a variant using a given method.
getStatus() - Method in class org.restlet.data.Response
Returns the status.
getStatus() - Method in exception org.restlet.resource.ResourceException
Returns the status associated to this exception.
getStatus(Throwable, Request, Response) - Method in class org.restlet.service.StatusService
Returns a status for a given exception or error.
getStatus() - Method in class org.restlet.util.WrapperResponse
Returns the status.
getStatusService() - Method in class org.restlet.Application
Returns the status service.
getStatusService() - Method in class org.restlet.Component
Returns the status service, enabled by default.
getStream() - Method in class org.restlet.resource.ChannelRepresentation
 
getStream() - Method in class org.restlet.resource.CharacterRepresentation
 
getStream() - Method in class org.restlet.resource.DigestRepresentation
Returns a stream with the representation's content.
getStream() - Method in class org.restlet.resource.FileRepresentation
 
getStream() - Method in class org.restlet.resource.InputRepresentation
 
getStream() - Method in class org.restlet.resource.OutputRepresentation
Returns a stream with the representation's content.
getStream() - Method in class org.restlet.resource.Representation
Returns a stream with the representation's content.
getStream() - Method in class org.restlet.resource.StringRepresentation
 
getStream(ReadableByteChannel) - Static method in class org.restlet.util.ByteUtils
Returns an input stream based on a given readable byte channel.
getStream(Reader, CharacterSet) - Static method in class org.restlet.util.ByteUtils
Returns an input stream based on a given character reader.
getStream(Representation) - Static method in class org.restlet.util.ByteUtils
Returns an input stream based on the given representation's content and its write(OutputStream) method.
getStream(WritableByteChannel) - Static method in class org.restlet.util.ByteUtils
Returns an output stream based on a given writable byte channel.
getStream(Writer) - Static method in class org.restlet.util.ByteUtils
Returns an output stream based on a given writer.
getStream() - Method in class org.restlet.util.WrapperRepresentation
 
getStreamSource() - Method in class org.restlet.resource.XmlRepresentation
Returns a stream of XML markup.
getSubTags() - Method in class org.restlet.data.Language
Returns the modifiable list of subtags.
getSubType() - Method in class org.restlet.data.MediaType
Returns the sub-type.
getTag() - Method in class org.restlet.resource.Representation
Returns the tag.
getTag() - Method in class org.restlet.resource.Variant
Deprecated. Use the Representation.getTag() method instead.
getTag() - Method in class org.restlet.util.WrapperRepresentation
 
getTarget() - Method in class org.restlet.Server
Returns the target Restlet.
getTarget() - Method in class org.restlet.util.ServerList
Returns the target Restlet.
getTargetClass() - Method in class org.restlet.Finder
Returns the target Handler class.
getTargetRef() - Method in class org.restlet.data.Reference
Returns the target reference.
getTargetRef(Request, Response) - Method in class org.restlet.Redirector
Returns the target reference to redirect to.
getTargetTemplate() - Method in class org.restlet.Redirector
Returns the target URI pattern.
getTaskService() - Method in class org.restlet.Application
Returns a task service to run concurrent tasks.
getTechnicalName() - Method in class org.restlet.data.ChallengeScheme
Returns the technical name (ex: BASIC).
getTemplate() - Method in class org.restlet.Route
Returns the reference template to match.
getTemplates() - Method in class org.restlet.resource.TransformRepresentation
Returns the templates to be used and reused.
getText() - Method in class org.restlet.resource.FileRepresentation
 
getText() - Method in class org.restlet.resource.InputRepresentation
 
getText() - Method in class org.restlet.resource.ReaderRepresentation
 
getText() - Method in class org.restlet.resource.Representation
Converts the representation to a string value.
getText() - Method in class org.restlet.resource.StringRepresentation
 
getText(String) - Method in class org.restlet.resource.XmlRepresentation
Evaluates an XPath expression as a string.
getText() - Method in class org.restlet.util.WrapperRepresentation
 
getTextRepresentation() - Method in class org.restlet.data.ReferenceList
Returns a representation of the list in the "text/uri-list" format.
getThrowable() - Method in class org.restlet.data.Status
Returns the related error or exception.
getTime() - Method in class org.restlet.util.InternetDateFormat
Gets the value of this InternetDateFormat object as millisecond time value.
getTransformer() - Method in class org.restlet.resource.TransformRepresentation
Returns a new transformer to be used.
getTransformerHandler() - Method in class org.restlet.resource.TransformRepresentation
Returns the SAX transformer handler associated to the transform sheet.
getTransformSheet() - Method in class org.restlet.resource.TransformRepresentation
Returns the XSLT transform sheet to apply to the source representation.
getTransformSheet() - Method in class org.restlet.Transformer
Returns the XSLT transform sheet to apply to message entities.
getTunnelService() - Method in class org.restlet.Application
Returns the tunnel service.
getType() - Method in class org.restlet.util.Variable
Returns the type of variable.
getUnmodifiedSince() - Method in class org.restlet.data.Conditions
Returns the "if-unmodified-since" condition.
getUri() - Method in class org.restlet.data.Method
Returns the URI of the specification describing the method.
getUri() - Method in class org.restlet.data.Status
Returns the URI of the specification describing the status.
getUriResolver() - Method in class org.restlet.resource.TransformRepresentation
Returns the URI resolver.
getURIResolver() - Method in class org.restlet.resource.TransformRepresentation
Deprecated. Use the getUriResolver method instead.
getUserInfo() - Method in class org.restlet.data.Reference
Returns the user info component for server based hierarchical identifiers.
Note that no URI decoding is done by this method.
getUserInfo(boolean) - Method in class org.restlet.data.Reference
Returns the optionnally decoded user info component.
getValue() - Method in class org.restlet.data.Digest
Returns the digest value.
getValue() - Method in class org.restlet.data.Parameter
Returns the value.
getValues(String) - Method in class org.restlet.util.Series
Returns the values of the parameters with a given name.
getValues(String, String, boolean) - Method in class org.restlet.util.Series
Returns the parameter values with a given name.
getValuesArray(String) - Method in class org.restlet.util.Series
Returns an array of all the values associated to the given parameter name.
getValuesArray(String, boolean) - Method in class org.restlet.util.Series
Returns an array of all the values associated to the given parameter name.
getValuesMap() - Method in class org.restlet.util.Series
Returns a map of name, value pairs.
getVariableNames() - Method in class org.restlet.util.Template
Returns the list of variable names in the template.
getVariables() - Method in class org.restlet.util.Template
Returns the modifiable map of variable descriptors.
getVariants() - Method in class org.restlet.resource.Resource
Returns the modifiable list of variants.
getVersion() - Method in class org.restlet.data.Cookie
Returns the cookie specification version.
getVersion() - Method in class org.restlet.data.Product
Returns the version of the product.
getWebRepresentation() - Method in class org.restlet.data.Form
Returns the form as a Web representation (MediaType.APPLICATION_WWW_FORM).
getWebRepresentation(CharacterSet) - Method in class org.restlet.data.Form
Returns the form as a Web representation (MediaType.APPLICATION_WWW_FORM).
getWebRepresentation() - Method in class org.restlet.data.ReferenceList
Returns a representation of the list in "text/html" format.
getWrappedRepresentation() - Method in class org.restlet.util.WrapperRepresentation
Returns the wrapped representation.
getWrappedRequest() - Method in class org.restlet.util.WrapperRequest
Returns the wrapped request.
getWrappedResponse() - Method in class org.restlet.util.WrapperResponse
Returns the wrapped response.
getWriter() - Method in class org.restlet.util.XmlWriter
Returns the underlying writer.
getXmlFilter() - Method in class org.restlet.resource.TransformRepresentation
Returns the SAX XML filter applying the transform sheet to its input.
Guard - Class in org.restlet
Filter guarding the access to an attached Restlet.
Guard(Context, ChallengeScheme, String) - Constructor for class org.restlet.Guard
Constructor.
Guard(Context, String, Collection<String>, String) - Constructor for class org.restlet.Guard
Alternate Constructor for HTTP DIGEST authentication scheme.
GZIP - Static variable in class org.restlet.data.Encoding
The GNU Zip encoding.

H

handle(Request, Response) - Method in class org.restlet.Application
 
handle(Request, Response) - Method in class org.restlet.Client
 
handle(Request, Response) - Method in class org.restlet.Component
 
handle(Request, Response) - Method in class org.restlet.Filter
Handles a call by first invoking the beforeHandle() method for pre-filtering, then distributing the call to the next Restlet via the doHandle() method.
handle(Request, Response) - Method in class org.restlet.Finder
Handles a call.
handle(Request, Response) - Method in class org.restlet.Redirector
Handles a call by redirecting using the selected redirection mode.
handle(Request, Response) - Method in class org.restlet.Restlet
Handles a call.
handle(Request, Response) - Method in class org.restlet.Router
Handles a call by invoking the next Restlet if it is available.
handle(Request, Response) - Method in class org.restlet.Server
 
handle(Request) - Method in class org.restlet.Uniform
Handles a call.
handle(Request, Response) - Method in class org.restlet.Uniform
Handles a call.
handle(Request, Response) - Method in class org.restlet.util.Helper
Handles a call.
handle(Request, Response) - Method in class org.restlet.util.WrapperRestlet
 
handleDelete() - Method in class org.restlet.Handler
Handles a DELETE call.
handleDelete() - Method in class org.restlet.resource.Resource
Handles a DELETE call by invoking the Resource.removeRepresentations() method.
handleGet() - Method in class org.restlet.Handler
Handles a GET call.
handleGet() - Method in class org.restlet.resource.Resource
Handles a GET call by automatically returning the best representation available.
handleHead() - Method in class org.restlet.Handler
Handles a HEAD call.
handleOptions() - Method in class org.restlet.Handler
Handles an OPTIONS call introspecting the target resource (as provided by the 'findTarget' method).
handlePost() - Method in class org.restlet.Handler
Handles a POST call.
handlePost() - Method in class org.restlet.resource.Resource
Handles a POST call by invoking the Resource.acceptRepresentation(Representation) method.
handlePut() - Method in class org.restlet.Handler
Handles a PUT call.
handlePut() - Method in class org.restlet.resource.Resource
Handles a PUT call by invoking the Resource.storeRepresentation(Representation) method.
Handler - Class in org.restlet
Final handler of calls typically created by Finders.
Handler() - Constructor for class org.restlet.Handler
Special constructor used by IoC frameworks.
Handler(Context, Request, Response) - Constructor for class org.restlet.Handler
Normal constructor.
hasExtensions() - Method in class org.restlet.data.Reference
Indicates if this reference has file-like extensions on its last path segment.
hasFragment() - Method in class org.restlet.data.Reference
Indicates if this reference has a fragment identifier.
hashCode() - Method in class org.restlet.data.ChallengeRequest
hashCode() - Method in class org.restlet.data.ChallengeResponse
hashCode() - Method in class org.restlet.data.ChallengeScheme
hashCode() - Method in class org.restlet.data.CharacterSet
hashCode() - Method in class org.restlet.data.Cookie
hashCode() - Method in class org.restlet.data.CookieSetting
hashCode() - Method in class org.restlet.data.Encoding
hashCode() - Method in class org.restlet.data.Language
hashCode() - Method in class org.restlet.data.MediaType
hashCode() - Method in class org.restlet.data.Metadata
hashCode() - Method in class org.restlet.data.Method
hashCode() - Method in class org.restlet.data.Parameter
hashCode() - Method in class org.restlet.data.Protocol
hashCode() - Method in class org.restlet.data.Reference
Returns a hash code value for the object.
hashCode() - Method in class org.restlet.data.Status
hashCode() - Method in class org.restlet.data.Tag
hashCode(Object...) - Static method in class org.restlet.util.Engine
Computes the hash code of a set of objects.
hashCode() - Method in class org.restlet.util.WrapperList
Returns the hash code value for this list.
hashCode() - Method in class org.restlet.util.WrapperMap
Returns the hash code value for this map.
hasMatrix() - Method in class org.restlet.data.Reference
Indicates if this reference has a matrix.
hasNext() - Method in class org.restlet.Filter
Indicates if there is a next Restlet.
hasQuery() - Method in class org.restlet.data.Reference
Indicates if this reference has a query component.
hasScheme() - Method in class org.restlet.data.Reference
Indicates if this reference has a scheme component.
hasSome() - Method in class org.restlet.data.Conditions
Indicates if there are some conditions set.
hasTarget() - Method in class org.restlet.Server
Indicates if a target Restlet is set.
HEAD - Static variable in class org.restlet.data.Method
Identical to GET except that the server must not return a message body in the response but only the message header.
head(Reference) - Method in class org.restlet.Uniform
Gets the identified resource without its representation's content.
head(String) - Method in class org.restlet.Uniform
Gets the identified resource without its representation's content.
Helper<T extends Restlet> - Class in org.restlet.util
Delegate used by API classes to get support from the implementation classes.
Helper(T) - Constructor for class org.restlet.util.Helper
Constructor.
HTTP - Static variable in class org.restlet.data.Protocol
HTTP protocol.
HTTP_AWS - Static variable in class org.restlet.data.ChallengeScheme
Deprecated. Use the ChallengeScheme.HTTP_AWS_S3 scheme instead.
HTTP_AWS_S3 - Static variable in class org.restlet.data.ChallengeScheme
Amazon S3 HTTP scheme.
HTTP_BASIC - Static variable in class org.restlet.data.ChallengeScheme
Basic HTTP scheme.
HTTP_DIGEST - Static variable in class org.restlet.data.ChallengeScheme
Digest HTTP scheme.
HTTP_NTLM - Static variable in class org.restlet.data.ChallengeScheme
Microsoft NTML HTTP scheme.
HTTP_OAUTH - Static variable in class org.restlet.data.ChallengeScheme
OAuth HTTP scheme.
HTTPS - Static variable in class org.restlet.data.Protocol
HTTPS protocol (via SSL socket).

I

IDENTITY - Static variable in class org.restlet.data.Encoding
The default (identity) encoding.
ignorableWhitespace(char[], int, int) - Method in class org.restlet.util.XmlWriter
Write ignorable whitespace.
IMAGE_ALL - Static variable in class org.restlet.data.MediaType
 
IMAGE_BMP - Static variable in class org.restlet.data.MediaType
 
IMAGE_GIF - Static variable in class org.restlet.data.MediaType
 
IMAGE_ICON - Static variable in class org.restlet.data.MediaType
 
IMAGE_JPEG - Static variable in class org.restlet.data.MediaType
 
IMAGE_PNG - Static variable in class org.restlet.data.MediaType
 
IMAGE_SVG - Static variable in class org.restlet.data.MediaType
 
IMAGE_TIFF - Static variable in class org.restlet.data.MediaType
 
includes(MediaType) - Method in class org.restlet.data.MediaType
Indicates if a given media type is included in the current one.
INDEX_FIRST - Static variable in class org.restlet.data.Range
Index for the first byte of an entity.
INDEX_LAST - Static variable in class org.restlet.data.Range
Index for the last byte of an entity.
indexOf(Object) - Method in class org.restlet.util.WrapperList
Returns the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element.
INFO_CONTINUE - Static variable in class org.restlet.data.Status
This interim response (the client has to wait for the final response) is used to inform the client that the initial part of the request has been received and has not yet been rejected or completed by the server.
INFO_PROCESSING - Static variable in class org.restlet.data.Status
This interim response is used to inform the client that the server has accepted the complete request, but has not yet completed it since the server has a reasonable expectation that the request will take significant time to complete.
INFO_SWITCHING_PROTOCOL - Static variable in class org.restlet.data.Status
The server understands and is willing to comply with the client's request, via the Upgrade message header field, for a change in the application protocol being used on this connection.
init(Context, Request, Response) - Method in class org.restlet.Handler
Initialize the resource with its context.
init(Context, Request, Response) - Method in class org.restlet.resource.Resource
Initialize the resource with its context.
init(Request, Response) - Method in class org.restlet.Restlet
Deprecated. Instead, make sure that you call the Restlet.handle(Request, Response) method from your Restlet superclass.
InputRepresentation - Class in org.restlet.resource
Transient representation based on a BIO input stream.
InputRepresentation(InputStream, MediaType) - Constructor for class org.restlet.resource.InputRepresentation
Constructor.
InputRepresentation(InputStream, MediaType, long) - Constructor for class org.restlet.resource.InputRepresentation
Constructor.
InternetDateFormat - Class in org.restlet.util
This class handles Internet date/time strings in accordance with RFC 3339.
InternetDateFormat() - Constructor for class org.restlet.util.InternetDateFormat
Creates a new InternetDateFormat object set to the current time using the UTC (Z) time zone.
InternetDateFormat(Calendar) - Constructor for class org.restlet.util.InternetDateFormat
Creates a new InternetDateFormat object initialized from a Calendar object.
InternetDateFormat(Date) - Constructor for class org.restlet.util.InternetDateFormat
Creates a new InternetDateFormat object initialized from a Date object using the UTC (Z) time zone.
InternetDateFormat(Date, TimeZone) - Constructor for class org.restlet.util.InternetDateFormat
Creates a new InternetDateFormat object initialized from a Date object using the specified time zone.
InternetDateFormat(long) - Constructor for class org.restlet.util.InternetDateFormat
Creates a new InternetDateFormat object initialized from a millisecond time value using the UTC (Z) time zone.
InternetDateFormat(long, TimeZone) - Constructor for class org.restlet.util.InternetDateFormat
Creates a new InternetDateFormat object initialized from a millisecond time value using the specified time zone.
InternetDateFormat(String) - Constructor for class org.restlet.util.InternetDateFormat
Creates a new InternetDateFormat object by parsing an RFC 3339 date/time string.
InternetDateFormat(TimeZone) - Constructor for class org.restlet.util.InternetDateFormat
Creates a new InternetDateFormat object set to the current time using the specified time zone.
invokeAll(Collection) - Method in class org.restlet.service.TaskService
Executes the given tasks, returning a list of Futures holding their status and results when all complete.
invokeAll(Collection, long, TimeUnit) - Method in class org.restlet.service.TaskService
Executes the given tasks, returning a list of Futures holding their status and results when all complete or the timeout expires, whichever happens first.
invokeAny(Collection) - Method in class org.restlet.service.TaskService
Executes the given tasks, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do.
invokeAny(Collection, long, TimeUnit) - Method in class org.restlet.service.TaskService
Executes the given tasks, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do before the given timeout elapses.
isAbsolute() - Method in class org.restlet.data.Reference
Indicates if the reference is absolute.
isAcceptRanges() - Method in class org.restlet.data.ServerInfo
Return true if the server accepts range requests for a resource.
isAccessRestricted() - Method in class org.restlet.data.CookieSetting
Indicates if cookie access is restricted for untrusted parties.
isAuthenticated() - Method in class org.restlet.data.ChallengeResponse
Indicates if the identifier or principal has been authenticated.
isAvailable() - Method in class org.restlet.resource.Representation
Indicates if some fresh content is available, without having to actually call one of the content manipulation method like getStream() that would actually consume it.
isAvailable() - Method in class org.restlet.resource.Resource
Indicates if the resource is actually available.
isAvailable() - Method in class org.restlet.util.WrapperRepresentation
 
isClientError(int) - Static method in class org.restlet.data.Status
Indicates if the status is a client error status, meaning "The request contains bad syntax or cannot be fulfilled".
isClientError() - Method in class org.restlet.data.Status
Indicates if the status is a client error status, meaning "The request contains bad syntax or cannot be fulfilled".
isCompatible(MediaType) - Method in class org.restlet.data.MediaType
Checks if this MediaType is compatible with the given media type.
isConcrete() - Method in class org.restlet.data.MediaType
Checks if the current media type is concrete.
isConfidential() - Method in class org.restlet.data.Message
Indicates if the message was or will be exchanged confidentially, for example via a SSL-secured connection.
isConfidential() - Method in class org.restlet.data.Protocol
Indicates if the protocol guarantees the confidentially of the messages exchanged, for example via a SSL-secured connection.
isConfidential() - Method in class org.restlet.data.Request
Implemented based on the Protocol.isConfidential() method for the request's protocol returned by Request.getProtocol();
isConfidential() - Method in class org.restlet.data.Response
 
isConfidential() - Method in class org.restlet.util.WrapperRequest
Indicates if the call came over a confidential channel such as an SSL-secured connection.
isConfidential() - Method in class org.restlet.util.WrapperResponse
Indicates if the call came over a confidential channel such as an SSL-secured connection.
isConnectorError(int) - Static method in class org.restlet.data.Status
Indicates if the status is a connector error status, meaning "The connector failed to send or receive an apparently valid message".
isConnectorError() - Method in class org.restlet.data.Status
Indicates if the status is a connector error status, meaning "The connector failed to send or receive an apparently valid message".
isDataFormat() - Method in class org.restlet.util.XmlWriter
 
isDecodedOnParse() - Method in class org.restlet.util.Variable
Indicates if the parsed value must be decoded.
isDeeplyAccessible() - Method in class org.restlet.Directory
Indicates if the subdirectories are deeply accessible (true by default).
isDownloadable() - Method in class org.restlet.resource.Representation
Indicates if the representation is downloadable which means that it can be obtained via a download dialog box.
isDownloadable() - Method in class org.restlet.util.WrapperRepresentation
 
isEmpty() - Method in class org.restlet.util.WrapperList
Returns true if this list contains no elements.
isEmpty() - Method in class org.restlet.util.WrapperMap
Returns true if this map contains no key-value mappings.
isEnabled() - Method in class org.restlet.service.Service
Indicates if the service should be enabled.
isEncodedOnFormat() - Method in class org.restlet.util.Variable
Indicates if the formatted value must be encoded.
isEncodeVariables() - Method in class org.restlet.util.Template
Indicates if the variables must be encoded when formatting the template.
isEntityAvailable() - Method in class org.restlet.data.Message
Indicates if a content is available and can be sent.
isEntityAvailable() - Method in class org.restlet.data.Request
Indicates if a content is available and can be sent.
isEntityAvailable() - Method in class org.restlet.util.WrapperRequest
Indicates if a content is available and can be sent.
isEntityAvailable() - Method in class org.restlet.util.WrapperResponse
Indicates if a content is available and can be sent.
isEquivalentTo(Reference) - Method in class org.restlet.data.Reference
Returns true if both reference are equivalent, meaning that they resolve to the same target reference.
isError(int) - Static method in class org.restlet.data.Status
Indicates if the status is an error (client or server) status.
isError() - Method in class org.restlet.data.Status
Indicates if the status is an error (client or server) status.
isExtensionsTunnel() - Method in class org.restlet.service.TunnelService
Indicates if the client preferences can be tunnelled via the extensions.
isFixed() - Method in class org.restlet.util.Variable
Returns true if the value is fixed, in which case the "defaultValue" property is always used.
isGenericDelimiter(int) - Static method in class org.restlet.data.Reference
Indicates if the given character is a generic URI component delimiter character.
isHierarchical() - Method in class org.restlet.data.Reference
Indicates if the identifier is hierarchical.
isIdentityCheck() - Method in class org.restlet.service.LogService
Indicates if the identity check (as specified by RFC1413) is enabled.
isIncluded(long, long) - Method in class org.restlet.data.Range
Indicates if the given index is included in the range.
isInfo(int) - Static method in class org.restlet.data.Status
Deprecated. Use Status.isInformational(int) instead.
isInfo() - Method in class org.restlet.data.Status
Deprecated. Use Status.isInformational() instead.
isInformational(int) - Static method in class org.restlet.data.Status
Indicates if the status is an information status, meaning "request received, continuing process".
isInformational() - Method in class org.restlet.data.Status
Indicates if the status is an information status, meaning "request received, continuing process".
isListingAllowed() - Method in class org.restlet.Directory
Indicates if the display of directory listings is allowed when no index file is found.
isMethodTunnel() - Method in class org.restlet.service.TunnelService
Indicates if the method name can be tunnelled.
isModifiable() - Method in class org.restlet.Directory
Indicates if modifications to local resources (most likely files) are allowed.
isModifiable() - Method in class org.restlet.resource.Resource
Indicates if the representations can be modified via the Resource.handlePost(), the Resource.handlePut() or the Resource.handleDelete() methods.
isNamespaceAware() - Method in class org.restlet.resource.XmlRepresentation
Indicates if processing is namespace aware.
isNegotiateContent() - Method in class org.restlet.Directory
Indicates if the best content is automatically negotiated.
isNegotiateContent() - Method in class org.restlet.resource.Resource
Indicates if the best content is automatically negotiated.
ISO_8859_1 - Static variable in class org.restlet.data.CharacterSet
The ISO/IEC 8859-1 or Latin 1 character set.
ISO_8859_10 - Static variable in class org.restlet.data.CharacterSet
The ISO/IEC 8859-10 (Latin 6) character set.
ISO_8859_2 - Static variable in class org.restlet.data.CharacterSet
The ISO/IEC 8859-2 (Latin 2) character set.
ISO_8859_3 - Static variable in class org.restlet.data.CharacterSet
The ISO/IEC 8859-3 (Latin 3) character set.
ISO_8859_4 - Static variable in class org.restlet.data.CharacterSet
The ISO/IEC 8859-4 (Latin 4) character set.
ISO_8859_5 - Static variable in class org.restlet.data.CharacterSet
The ISO/IEC 8859-5 (Cyrillic) character set.
ISO_8859_6 - Static variable in class org.restlet.data.CharacterSet
The ISO/IEC 8859-6 (Arabic) character set.
ISO_8859_7 - Static variable in class org.restlet.data.CharacterSet
The ISO/IEC 8859-7 (Greek) character set.
ISO_8859_8 - Static variable in class org.restlet.data.CharacterSet
The ISO/IEC 8859-8 (Hebrew) character set.
ISO_8859_9 - Static variable in class org.restlet.data.CharacterSet
The ISO/IEC 8859-9 (Latin 5) character set.
isOpaque() - Method in class org.restlet.data.Reference
Indicates if the identifier is opaque.
isOverwrite() - Method in class org.restlet.service.StatusService
Indicates if an existing entity should be overwritten.
isParent(Reference) - Method in class org.restlet.data.Reference
Indicates if the reference is a parent of the hierarchical child reference.
isPreferencesTunnel() - Method in class org.restlet.service.TunnelService
Indicates if the client preferences can be tunnelled via the query parameters or file extensions.
isQueryTunnel() - Method in class org.restlet.service.TunnelService
Indicates if the method and client preferences can be tunnelled via query parameters or file extensions.
isReadable() - Method in class org.restlet.resource.Resource
Indicates if the representations can be read via the Resource.handleGet() method.
isRechallengeEnabled() - Method in class org.restlet.Guard
Indicates if a new challenge should be sent when invalid credentials are received (true by default to conform to HTTP recommendations).
isRedirection(int) - Static method in class org.restlet.data.Status
Indicates if the status is a redirection status, meaning "Further action must be taken in order to complete the request".
isRedirection() - Method in class org.restlet.data.Status
Indicates if the status is a redirection status, meaning "Further action must be taken in order to complete the request".
isRelative() - Method in class org.restlet.data.Reference
Indicates if the reference is relative.
isRequired() - Method in class org.restlet.util.Variable
Returns true if the variable is required or optional.
isReserved(int) - Static method in class org.restlet.data.Reference
Indicates if the given character is a reserved URI character.
isSecure() - Method in class org.restlet.data.CookieSetting
Indicates if cookie should only be transmitted by secure means.
isServerError(int) - Static method in class org.restlet.data.Status
Indicates if the status is a server error status, meaning "The server failed to fulfill an apparently valid request".
isServerError() - Method in class org.restlet.data.Status
Indicates if the status is a server error status, meaning "The server failed to fulfill an apparently valid request".
isShutdown() - Method in class org.restlet.service.TaskService
Returns true if this executor has been shut down.
isShutdownAllowed() - Method in class org.restlet.service.TaskService
Indicates if the TaskService.shutdown() and TaskService.shutdownNow() methods are allowed to effectively shutdown the wrapped executor service.
isStarted() - Method in class org.restlet.Restlet
Indicates if the Restlet is started.
isStarted() - Method in class org.restlet.service.Service
Indicates if the Restlet is started.
isStarted() - Method in class org.restlet.util.WrapperRestlet
 
isStopped() - Method in class org.restlet.Restlet
Indicates if the Restlet is stopped.
isStopped() - Method in class org.restlet.service.Service
Indicates if the Restlet is stopped.
isStopped() - Method in class org.restlet.util.WrapperRestlet
 
isSubDelimiter(int) - Static method in class org.restlet.data.Reference
Indicates if the given character is an URI subcomponent delimiter character.
isSuccess(int) - Static method in class org.restlet.data.Status
Indicates if the status is a success status, meaning "The action was successfully received, understood, and accepted".
isSuccess() - Method in class org.restlet.data.Status
Indicates if the status is a success status, meaning "The action was successfully received, understood, and accepted".
isTerminated() - Method in class org.restlet.service.TaskService
Returns true if all tasks have completed following shut down.
isTransient() - Method in class org.restlet.resource.Representation
Indicates if the representation's content is transient, which means that it can be obtained only once.
isTransient() - Method in class org.restlet.util.WrapperRepresentation
 
isUnreserved(int) - Static method in class org.restlet.data.Reference
Indicates if the given character is an unreserved URI character.
isUserAgentTunnel() - Method in class org.restlet.service.TunnelService
Indicates if the client preferences can be tunnelled according to the user agent.
isValid(int) - Static method in class org.restlet.data.Reference
Indicates if the given character is a valid URI character.
isWeak() - Method in class org.restlet.data.Tag
Indicates if the tag is weak.
item(int) - Method in class org.restlet.util.NodeSet
iterator() - Method in class org.restlet.util.WrapperList
Returns an iterator over the elements in this list in proper sequence.

J

JAR - Static variable in class org.restlet.data.Protocol
JAR (Java ARchive) is a common scheme to access to representations inside archive files.
JDBC - Static variable in class org.restlet.data.Protocol
JDBC protocol.

K

keySet() - Method in class org.restlet.util.WrapperMap
Returns a set view of the keys contained in this map.

L

Language - Class in org.restlet.data
Language used in representations and preferences.
Language(String) - Constructor for class org.restlet.data.Language
Constructor.
Language(String, String) - Constructor for class org.restlet.data.Language
Constructor.
LAST - Static variable in class org.restlet.Router
Each call will be routed to the last route if the required score is reached.
lastIndexOf(Object) - Method in class org.restlet.util.WrapperList
Returns the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element.
listIterator() - Method in class org.restlet.util.WrapperList
Returns a list iterator of the elements in this list (in proper sequence).
listIterator(int) - Method in class org.restlet.util.WrapperList
Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list.
loadClass(String) - Static method in class org.restlet.util.Engine
Returns the class object for the given name using the engine class loader fist, then the current thread context class loader, or the classloader of the current class.
localizePath(String) - Static method in class org.restlet.data.LocalReference
Localize a path by converting all the separator characters to the system-dependant separator character.
LocalReference - Class in org.restlet.data
Reference to a local (i.e.
LocalReference(Reference) - Constructor for class org.restlet.data.LocalReference
Constructor.
LocalReference(String) - Constructor for class org.restlet.data.LocalReference
Constructor.
LOCK - Static variable in class org.restlet.data.Method
Used to take out a lock of any access type on the resource identified by the request URI.
LogService - Class in org.restlet.service
Service providing access logging service.
LogService(boolean) - Constructor for class org.restlet.service.LogService
Constructor.

M

MACINTOSH - Static variable in class org.restlet.data.CharacterSet
The Macintosh ("Mac OS Roman") character set.
main(String[]) - Static method in class org.restlet.Component
Used as bootstrap for configuring and running a component in command line.
MAJOR_NUMBER - Static variable in class org.restlet.util.Engine
Major version number.
match(String) - Method in class org.restlet.util.Template
Indicates if the current pattern matches the given formatted string.
MediaType - Class in org.restlet.data
Media type used in representations and preferences.
MediaType(String) - Constructor for class org.restlet.data.MediaType
Constructor.
MediaType(String, Series<Parameter>) - Constructor for class org.restlet.data.MediaType
Constructor.
MediaType(String, Series<Parameter>, String) - Constructor for class org.restlet.data.MediaType
Constructor.
MediaType(String, String) - Constructor for class org.restlet.data.MediaType
Constructor.
Message - Class in org.restlet.data
Generic message exchanged between client and server connectors.
Message() - Constructor for class org.restlet.data.Message
Constructor.
Message(Representation) - Constructor for class org.restlet.data.Message
Constructor.
MESSAGE_ALL - Static variable in class org.restlet.data.MediaType
 
Metadata - Class in org.restlet.data
Description of data contained in a resource representation.
Metadata(String) - Constructor for class org.restlet.data.Metadata
Constructor.
Metadata(String, String) - Constructor for class org.restlet.data.Metadata
Constructor.
MetadataService - Class in org.restlet.service
Service providing access to metadata and their associated extension names.
MetadataService() - Constructor for class org.restlet.service.MetadataService
Constructor.
Method - Class in org.restlet.data
Method to execute when handling a call.
Method(String) - Constructor for class org.restlet.data.Method
Constructor.
Method(String, String) - Constructor for class org.restlet.data.Method
Constructor.
Method(String, String, String) - Constructor for class org.restlet.data.Method
Constructor.
MINOR_NUMBER - Static variable in class org.restlet.util.Engine
Minor version number.
MKCOL - Static variable in class org.restlet.data.Method
MKCOL creates a new collection resource at the location specified by the Request URI.
mode - Variable in class org.restlet.Redirector
The redirection mode.
MODE_CLIENT_FOUND - Static variable in class org.restlet.Redirector
In this mode, the client is simply redirected to the URI generated from the target URI pattern.
See org.restlet.data.Status.REDIRECTION_FOUND.
MODE_CLIENT_PERMANENT - Static variable in class org.restlet.Redirector
In this mode, the client is permanently redirected to the URI generated from the target URI pattern.
See org.restlet.data.Status.REDIRECTION_PERMANENT.
MODE_CLIENT_SEE_OTHER - Static variable in class org.restlet.Redirector
In this mode, the client is simply redirected to the URI generated from the target URI pattern.
See org.restlet.data.Status.REDIRECTION_SEE_OTHER.
MODE_CLIENT_TEMPORARY - Static variable in class org.restlet.Redirector
In this mode, the client is temporarily redirected to the URI generated from the target URI pattern.
See org.restlet.data.Status.REDIRECTION_TEMPORARY.
MODE_DISPATCHER - Static variable in class org.restlet.Redirector
In this mode, the call is sent to the context's dispatcher.
MODE_EQUALS - Static variable in class org.restlet.util.Template
 
MODE_REQUEST - Static variable in class org.restlet.Transformer
Mode that transforms request entities before their handling by the attached Restlet.
MODE_RESPONSE - Static variable in class org.restlet.Transformer
Mode that transforms response entities after their handling by the attached Restlet.
MODE_STARTS_WITH - Static variable in class org.restlet.util.Template
 
MODEL_ALL - Static variable in class org.restlet.data.MediaType
 
MODEL_VRML - Static variable in class org.restlet.data.MediaType
 
MOVE - Static variable in class org.restlet.data.Method
Logical equivalent of a copy, followed by consistency maintenance processing, followed by a delete of the source where all three actions are performed atomically.
MULTIPART_ALL - Static variable in class org.restlet.data.MediaType
 
MULTIPART_FORM_DATA - Static variable in class org.restlet.data.MediaType
 

N

NEXT - Static variable in class org.restlet.Router
Each call is be routed to the next route target if the required score is reached.
NodeSet - Class in org.restlet.util
DOM nodes set that implements the standard List interface for easier iteration.
NodeSet(NodeList) - Constructor for class org.restlet.util.NodeSet
Constructor.
normalize() - Method in class org.restlet.data.Reference
Normalizes the reference.
normalizePath(String) - Static method in class org.restlet.data.LocalReference
Normalize a path by converting all the system-dependant separator characters to the standard '/' separator character.
now() - Static method in class org.restlet.util.InternetDateFormat
Returns the current date and time as an RFC 3339 date/time string using the UTC (Z) time zone.
now(TimeZone) - Static method in class org.restlet.util.InternetDateFormat
Returns the current date and time as an RFC 3339 date/time string using the specified time zone.

O

ObjectRepresentation<T extends java.io.Serializable> - Class in org.restlet.resource
Representation based on a serializable Java object.
ObjectRepresentation(Representation) - Constructor for class org.restlet.resource.ObjectRepresentation
Constructor reading the object from a serialized representation.
ObjectRepresentation(T) - Constructor for class org.restlet.resource.ObjectRepresentation
Constructor
OPTIONS - Static variable in class org.restlet.data.Method
Requests for information about the communication options available on the request/response chain identified by the URI.
options(Reference) - Method in class org.restlet.Uniform
Gets the options for the identified resource.
options(String) - Method in class org.restlet.Uniform
Gets the options for the identified resource.
org.restlet - package org.restlet
Core classes of the API.
org.restlet.data - package org.restlet.data
Element of information handled by a component via a connector.
org.restlet.resource - package org.restlet.resource
Common resource and representation data elements.
org.restlet.service - package org.restlet.service
Service classes used by applications and components.
org.restlet.util - package org.restlet.util
Utility classes and interfaces used in the rest of the API.
OutputRepresentation - Class in org.restlet.resource
Representation based on a BIO output stream.
OutputRepresentation(MediaType) - Constructor for class org.restlet.resource.OutputRepresentation
Constructor.
OutputRepresentation(MediaType, long) - Constructor for class org.restlet.resource.OutputRepresentation
Constructor.

P

Parameter - Class in org.restlet.data
Multi-usage parameter.
Parameter() - Constructor for class org.restlet.data.Parameter
Default constructor.
Parameter(String, String) - Constructor for class org.restlet.data.Parameter
Preferred constructor.
parse(String) - Static method in class org.restlet.data.Tag
Parses a tag formatted as defined by the HTTP standard.
parse(ContentHandler) - Method in class org.restlet.resource.SaxRepresentation
Parses the source and sends SAX events to a content handler.
parse(String, List<String>) - Static method in class org.restlet.util.DateUtils
Parses a formatted date into a Date object.
parse(Form, Representation) - Method in class org.restlet.util.Engine
Parses a representation into a form.
parse(Form, String, CharacterSet, boolean, char) - Method in class org.restlet.util.Engine
Parses a parameters string to parse into a given form.
parse(String) - Method in class org.restlet.util.InternetDateFormat
 
parse(String, ParsePosition) - Method in class org.restlet.util.InternetDateFormat
 
parse(String, Map<String, Object>) - Method in class org.restlet.util.Template
Attempts to parse a formatted reference.
parse(String, Request) - Method in class org.restlet.util.Template
Attempts to parse a formatted reference.
parseCalendar(String) - Static method in class org.restlet.util.InternetDateFormat
Parses an RFC 3339 date/time string to a Calendar object.
parseContentType(String) - Method in class org.restlet.util.Engine
Parses the given Content Type.
parseCookie(String) - Method in class org.restlet.util.Engine
Parses the given String to a Cookie
parseCookieSetting(String) - Method in class org.restlet.util.Engine
Parses the given String to a CookieSetting
parseDate(String) - Static method in class org.restlet.util.InternetDateFormat
Parses an RFC 3339 date/time string to a Date object.
parseTime(String) - Static method in class org.restlet.util.InternetDateFormat
Parses an RFC 3339 date/time string to a millisecond time value.
parseUserAgent(String) - Method in class org.restlet.util.Engine
Parses the given user agent String to a list of Product instances.
POP - Static variable in class org.restlet.data.Protocol
POP protocol.
POP_BASIC - Static variable in class org.restlet.data.ChallengeScheme
Basic POP scheme.
POP_DIGEST - Static variable in class org.restlet.data.ChallengeScheme
Digest POP scheme.
POPS - Static variable in class org.restlet.data.Protocol
POPS protocol (via SSL/TLS socket)..
POST - Static variable in class org.restlet.data.Method
Requests that the origin server accepts the entity enclosed in the request as a new subordinate of the resource identified by the request URI.
post(Representation) - Method in class org.restlet.resource.Resource
Deprecated. Use the Resource.acceptRepresentation(Representation) method instead.
post(Reference, Representation) - Method in class org.restlet.Uniform
Posts a representation to the identified resource.
post(String, Representation) - Method in class org.restlet.Uniform
Posts a representation to the identified resource.
Preference<T extends Metadata> - Class in org.restlet.data
Metadata preference definition.
Preference() - Constructor for class org.restlet.data.Preference
Constructor.
Preference(T) - Constructor for class org.restlet.data.Preference
Constructor.
Preference(T, float) - Constructor for class org.restlet.data.Preference
Constructor.
Preference(T, float, Series<Parameter>) - Constructor for class org.restlet.data.Preference
Constructor.
processingInstruction(String, String) - Method in class org.restlet.util.XmlWriter
Write a processing instruction.
Product - Class in org.restlet.data
Product tokens are used to allow communicating applications to identify themselves by software name and version.
Product(String, String, String) - Constructor for class org.restlet.data.Product
Constructor.
PROPFIND - Static variable in class org.restlet.data.Method
Retrieves properties defined on the resource identified by the request URI.
PROPPATCH - Static variable in class org.restlet.data.Method
Processes instructions specified in the request body to set and/or remove properties defined on the resource identified by the request URI.
Protocol - Class in org.restlet.data
Protocol used by client and server connectors.
Protocol(String) - Constructor for class org.restlet.data.Protocol
Constructor.
Protocol(String, String, String, int) - Constructor for class org.restlet.data.Protocol
Constructor.
Protocol(String, String, String, int, boolean) - Constructor for class org.restlet.data.Protocol
Constructor.
PUT - Static variable in class org.restlet.data.Method
Requests that the enclosed entity be stored under the supplied request URI.
put(Representation) - Method in class org.restlet.resource.Resource
Deprecated. Use the Resource.storeRepresentation(Representation) method instead.
put(Reference, Representation) - Method in class org.restlet.Uniform
Puts a representation in the identified resource.
put(String, Representation) - Method in class org.restlet.Uniform
Puts a representation in the identified resource.
put(K, V) - Method in class org.restlet.util.WrapperMap
Associates the specified value with the specified key in this map (optional operation).
putAll(Map<? extends K, ? extends V>) - Method in class org.restlet.util.WrapperMap
Copies all of the mappings from the specified map to this map (optional operation).
putNamespace(String, String) - Method in class org.restlet.resource.XmlRepresentation
Puts a new mapping between a prefix and a namespace URI.

R

RANDOM - Static variable in class org.restlet.Router
Each call will be randomly routed to one of the routes that reached the required score.
Range - Class in org.restlet.data
Describes a range of bytes.
Range() - Constructor for class org.restlet.data.Range
Default constructor defining a range starting on the first byte and with a maximum size, i.e.
Range(long) - Constructor for class org.restlet.data.Range
Constructor defining a range starting on the first byte and with the given size.
Range(long, long) - Constructor for class org.restlet.data.Range
Constructor.
RangeService - Class in org.restlet.service
Service automatically exposes ranges of response entities.
RangeService() - Constructor for class org.restlet.service.RangeService
Constructor.
RangeService(boolean) - Constructor for class org.restlet.service.RangeService
Constructor.
ReadableRepresentation - Class in org.restlet.resource
Transient representation based on a readable NIO byte channel.
ReadableRepresentation(ReadableByteChannel, MediaType) - Constructor for class org.restlet.resource.ReadableRepresentation
Constructor.
ReadableRepresentation(ReadableByteChannel, MediaType, long) - Constructor for class org.restlet.resource.ReadableRepresentation
Constructor.
ReaderRepresentation - Class in org.restlet.resource
Transient representation based on a BIO characters reader.
ReaderRepresentation(Reader, MediaType) - Constructor for class org.restlet.resource.ReaderRepresentation
Constructor.
ReaderRepresentation(Reader, MediaType, long) - Constructor for class org.restlet.resource.ReaderRepresentation
Constructor.
redirectDispatcher(Reference, Request, Response) - Method in class org.restlet.Redirector
Redirects a given call to a target reference.
REDIRECTION_FOUND - Static variable in class org.restlet.data.Status
The requested resource resides temporarily under a different URI which should not be used for future requests by the client (use status codes 303 or 307 instead since this status has been manifestly misused).
REDIRECTION_MULTIPLE_CHOICES - Static variable in class org.restlet.data.Status
The server lets the user agent choosing one of the multiple representations of the requested resource, each representation having its own specific location provided in the response entity.
REDIRECTION_NOT_MODIFIED - Static variable in class org.restlet.data.Status
Status code sent by the server in response to a conditional GET request in case the document has not been modified.
REDIRECTION_PERMANENT - Static variable in class org.restlet.data.Status
The requested resource has been assigned a new permanent URI and any future references to this resource SHOULD use one of the returned URIs.
REDIRECTION_SEE_OTHER - Static variable in class org.restlet.data.Status
The response to the request can be found under a different URI and SHOULD be retrieved using a GET method on that resource.
REDIRECTION_TEMPORARY - Static variable in class org.restlet.data.Status
The requested resource resides temporarily under a different URI which should not be used for future requests by the client.
REDIRECTION_USE_PROXY - Static variable in class org.restlet.data.Status
The requested resource MUST be accessed through the proxy given by the Location field.
Redirector - Class in org.restlet
Rewrites URIs then redirects the call or the client to a new destination.
Redirector(Context, String) - Constructor for class org.restlet.Redirector
Constructor for the dispatcher mode.
Redirector(Context, String, int) - Constructor for class org.restlet.Redirector
Constructor.
redirectPermanent(Reference) - Method in class org.restlet.data.Response
Permanently redirects the client to a target URI.
redirectPermanent(String) - Method in class org.restlet.data.Response
Permanently redirects the client to a target URI.
redirectPermanent(Reference) - Method in class org.restlet.util.WrapperResponse
Permanently redirects the client to a target URI.
redirectPermanent(String) - Method in class org.restlet.util.WrapperResponse
Permanently redirects the client to a target URI.
redirectSeeOther(Reference) - Method in class org.restlet.data.Response
Redirects the client to a different URI that SHOULD be retrieved using a GET method on that resource.
redirectSeeOther(String) - Method in class org.restlet.data.Response
Redirects the client to a different URI that SHOULD be retrieved using a GET method on that resource.
redirectSeeOther(Reference) - Method in class org.restlet.util.WrapperResponse
Redirects the client to a different URI that SHOULD be retrieved using a GET method on that resource.
redirectSeeOther(String) - Method in class org.restlet.util.WrapperResponse
Redirects the client to a different URI that SHOULD be retrieved using a GET method on that resource.
redirectTemporary(Reference) - Method in class org.restlet.data.Response
Temporarily redirects the client to a target URI.
redirectTemporary(String) - Method in class org.restlet.data.Response
Temporarily redirects the client to a target URI.
redirectTemporary(Reference) - Method in class org.restlet.util.WrapperResponse
Temporarily redirects the client to a target URI.
redirectTemporary(String) - Method in class org.restlet.util.WrapperResponse
Temporarily redirects the client to a target URI.
Reference - Class in org.restlet.data
Reference to a Uniform Resource Identifier (URI).
Reference() - Constructor for class org.restlet.data.Reference
Empty constructor.
Reference(Protocol, String) - Constructor for class org.restlet.data.Reference
Constructor for a protocol and host name.
Reference(Protocol, String, int) - Constructor for class org.restlet.data.Reference
Constructor for a protocol, host name and host port
Reference(Reference) - Constructor for class org.restlet.data.Reference
Clone constructor.
Reference(Reference, Reference) - Constructor for class org.restlet.data.Reference
Constructor from an URI reference (most likely relative).
Reference(Reference, String) - Constructor for class org.restlet.data.Reference
Constructor from an URI reference (most likely relative).
Reference(Reference, String, String, String) - Constructor for class org.restlet.data.Reference
Constructor of relative reference from its parts.
Reference(String) - Constructor for class org.restlet.data.Reference
Constructor from an URI reference.
Reference(String, String) - Constructor for class org.restlet.data.Reference
Constructor from an identifier and a fragment.
Reference(String, String, int, String, String, String) - Constructor for class org.restlet.data.Reference
Constructor of absolute reference from its parts.
ReferenceList - Class in org.restlet.data
List of URI references.
ReferenceList() - Constructor for class org.restlet.data.ReferenceList
Constructor.
ReferenceList(int) - Constructor for class org.restlet.data.ReferenceList
Constructor.
ReferenceList(List<Reference>) - Constructor for class org.restlet.data.ReferenceList
Constructor.
ReferenceList(Representation) - Constructor for class org.restlet.data.ReferenceList
Constructor from a "text/uri-list" representation.
register(String, String) - Static method in class org.restlet.data.MediaType
Register a media type as a known type that can later be retrieved using MediaType.valueOf(String).
release() - Method in class org.restlet.data.Message
Releases the message's entity.
release() - Method in class org.restlet.resource.DomRepresentation
Releases the wrapped DOM document and the source XML representation if they have been defined.
release() - Method in class org.restlet.resource.FileRepresentation
Releases the file handle.
release() - Method in class org.restlet.resource.InputRepresentation
Closes and releases the input stream.
release() - Method in class org.restlet.resource.ObjectRepresentation
Releases the represented object.
release() - Method in class org.restlet.resource.OutputRepresentation
Calls parent's implementation.
release() - Method in class org.restlet.resource.ReadableRepresentation
Closes and releases the readable channel.
release() - Method in class org.restlet.resource.ReaderRepresentation
Closes and releases the input stream.
release() - Method in class org.restlet.resource.Representation
Releases the representation's content and all associated objects like sockets, channels or files.
release() - Method in class org.restlet.resource.SaxRepresentation
Releases the namespaces map.
release() - Method in class org.restlet.resource.StringRepresentation
Closes and releases the input stream.
release() - Method in class org.restlet.resource.TransformRepresentation
Releases the source and transform sheet representations, the transformer and the URI resolver.
release() - Method in class org.restlet.resource.WritableRepresentation
Calls parent's implementation.
release() - Method in class org.restlet.resource.WriterRepresentation
Calls parent's implementation.
release() - Method in class org.restlet.resource.XmlRepresentation
Releases the namespaces map.
release() - Method in class org.restlet.util.WrapperRepresentation
 
RELEASE_NUMBER - Static variable in class org.restlet.util.Engine
Release number.
remove(int) - Method in class org.restlet.util.WrapperList
Removes the element at the specified position in this list.
remove(Object) - Method in class org.restlet.util.WrapperList
Removes the first occurrence in this list of the specified element.
remove(Object) - Method in class org.restlet.util.WrapperMap
Removes the mapping for this key from this map if it is present (optional operation).
removeAll(Restlet) - Method in class org.restlet.util.RouteList
Removes all routes routing to a given target.
removeAll(String) - Method in class org.restlet.util.Series
Removes all the parameters with a given name.
removeAll(String, boolean) - Method in class org.restlet.util.Series
Removes all the parameters with a given name.
removeAll(Collection<?>) - Method in class org.restlet.util.WrapperList
Removes from this list all the elements that are contained in the specified collection.
removeFirst(String) - Method in class org.restlet.util.Series
Removes from this list the first entry whose name equals the specified name ignoring the case.
removeFirst(String, boolean) - Method in class org.restlet.util.Series
Removes from this list the first entry whose name equals the specified name ignoring the case or not.
removeRepresentations() - Method in class org.restlet.resource.Resource
Removes all the representations of the resource and effectively the resource itself.
represent() - Method in class org.restlet.resource.Resource
Returns the preferred representation according to the client preferences specified in the request.
represent(Variant) - Method in class org.restlet.resource.Resource
Returns a full representation for a given variant previously returned via the getVariants() method.
Representation - Class in org.restlet.resource
Current or intended state of a resource.
Representation() - Constructor for class org.restlet.resource.Representation
Default constructor.
Representation(MediaType) - Constructor for class org.restlet.resource.Representation
Constructor.
Request - Class in org.restlet.data
Generic request sent by client connectors.
Request() - Constructor for class org.restlet.data.Request
Constructor.
Request(Method, Reference) - Constructor for class org.restlet.data.Request
Constructor.
Request(Method, Reference, Representation) - Constructor for class org.restlet.data.Request
Constructor.
Request(Method, String) - Constructor for class org.restlet.data.Request
Constructor.
Request(Method, String, Representation) - Constructor for class org.restlet.data.Request
Constructor.
reset() - Method in class org.restlet.util.XmlWriter
Reset the writer.
resolve(String) - Method in class org.restlet.util.Resolver
Resolves a name into a value.
Resolver<T> - Class in org.restlet.util
Resolves a name into a value.
Resolver() - Constructor for class org.restlet.util.Resolver
 
Resource - Class in org.restlet.resource
Intended conceptual target of a hypertext reference.
Resource() - Constructor for class org.restlet.resource.Resource
Special constructor used by IoC frameworks.
Resource(Context, Request, Response) - Constructor for class org.restlet.resource.Resource
Normal constructor.
ResourceException - Exception in org.restlet.resource
Encapsulates a response status and the optional cause as a checked exception.
ResourceException(int) - Constructor for exception org.restlet.resource.ResourceException
Constructor.
ResourceException(int, String, String, String) - Constructor for exception org.restlet.resource.ResourceException
Constructor.
ResourceException(int, String, String, String, Throwable) - Constructor for exception org.restlet.resource.ResourceException
Constructor.
ResourceException(int, Throwable) - Constructor for exception org.restlet.resource.ResourceException
Constructor.
ResourceException(Status) - Constructor for exception org.restlet.resource.ResourceException
Constructor.
ResourceException(Status, String) - Constructor for exception org.restlet.resource.ResourceException
Constructor.
ResourceException(Status, String, Throwable) - Constructor for exception org.restlet.resource.ResourceException
Constructor.
ResourceException(Status, Throwable) - Constructor for exception org.restlet.resource.ResourceException
Constructor.
ResourceException(Throwable) - Constructor for exception org.restlet.resource.ResourceException
Constructor that set the status to Status.SERVER_ERROR_INTERNAL including the related error or exception.
Response - Class in org.restlet.data
Generic response sent by server connectors.
Response(Request) - Constructor for class org.restlet.data.Response
Constructor.
Restlet - Class in org.restlet
Uniform class that provides a context and life cycle support.
Restlet() - Constructor for class org.restlet.Restlet
Constructor with null context.
Restlet(Context) - Constructor for class org.restlet.Restlet
Constructor with the Restlet's context which can be the parent's application context, but shouldn't be the parent Component's context for security reasons.
retainAll(Collection<?>) - Method in class org.restlet.util.WrapperList
RemovesRetains only the elements in this list that are contained in the specified collection.
rewrite(Representation) - Method in class org.restlet.Redirector
Optionnaly rewrites the response entity returned in the MODE_CONNECTOR mode.
RIAP - Static variable in class org.restlet.data.Protocol
RIAP (Restlet Internal Access Protocol) is a custom scheme to access representations via internal calls to virtual hosts/components.
RIAP_APPLICATION - Static variable in class org.restlet.data.LocalReference
The resources will be resolved from the current application's root Restlet.
RIAP_COMPONENT - Static variable in class org.restlet.data.LocalReference
The resources will be resolved from the current component's internal (private) router.
RIAP_HOST - Static variable in class org.restlet.data.LocalReference
The resources will be resolved from the current component's virtual host.
Route - Class in org.restlet
Filter scoring the affinity of calls with the attached Restlet.
Route(Restlet) - Constructor for class org.restlet.Route
Constructor behaving as a simple extractor filter.
Route(Router, String, Restlet) - Constructor for class org.restlet.Route
Constructor.
Route(Router, Template, Restlet) - Constructor for class org.restlet.Route
Constructor.
RouteList - Class in org.restlet.util
Modifiable list of routes with some helper methods.
RouteList() - Constructor for class org.restlet.util.RouteList
Constructor.
RouteList(List<Route>) - Constructor for class org.restlet.util.RouteList
Constructor.
Router - Class in org.restlet
Restlet routing calls to one of the attached routes.
Router() - Constructor for class org.restlet.Router
Constructor.
Router(Context) - Constructor for class org.restlet.Router
Constructor.

S

SaxRepresentation - Class in org.restlet.resource
XML representation for SAX events processing.
SaxRepresentation(MediaType) - Constructor for class org.restlet.resource.SaxRepresentation
Constructor.
SaxRepresentation(MediaType, Document) - Constructor for class org.restlet.resource.SaxRepresentation
Constructor.
SaxRepresentation(MediaType, InputSource) - Constructor for class org.restlet.resource.SaxRepresentation
Constructor.
SaxRepresentation(MediaType, SAXSource) - Constructor for class org.restlet.resource.SaxRepresentation
Constructor.
SaxRepresentation(Representation) - Constructor for class org.restlet.resource.SaxRepresentation
Constructor.
score(Request, Response) - Method in class org.restlet.Route
Returns the score for a given call (between 0 and 1.0).
Series<E extends Parameter> - Class in org.restlet.util
Modifiable list of entries with many helper methods.
Series() - Constructor for class org.restlet.util.Series
Constructor.
Series(int) - Constructor for class org.restlet.util.Series
Constructor.
Series(List<E>) - Constructor for class org.restlet.util.Series
Constructor.
Server - Class in org.restlet
Connector acting as a generic server.
Server(Context, List<Protocol>, int, Restlet) - Constructor for class org.restlet.Server
Constructor.
Server(Context, List<Protocol>, String, int, Restlet) - Constructor for class org.restlet.Server
Constructor.
Server(Context, List<Protocol>, String, int, Restlet, String) - Constructor for class org.restlet.Server
Constructor.
Server(Context, Protocol, int, Restlet) - Constructor for class org.restlet.Server
Constructor.
Server(Context, Protocol, Restlet) - Constructor for class org.restlet.Server
Constructor using the protocol's default port.
Server(Context, Protocol, String, int, Restlet) - Constructor for class org.restlet.Server
Constructor.
Server(List<Protocol>, int, Restlet) - Constructor for class org.restlet.Server
Constructor.
Server(List<Protocol>, String, int, Restlet) - Constructor for class org.restlet.Server
Constructor.
Server(Protocol, int, Restlet) - Constructor for class org.restlet.Server
Constructor.
Server(Protocol, Restlet) - Constructor for class org.restlet.Server
Constructor using the protocol's default port.
Server(Protocol, String, int, Restlet) - Constructor for class org.restlet.Server
Constructor.
Server(Protocol, String, Restlet) - Constructor for class org.restlet.Server
Constructor using the protocol's default port.
SERVER_ERROR_BAD_GATEWAY - Static variable in class org.restlet.data.Status
The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request.
SERVER_ERROR_GATEWAY_TIMEOUT - Static variable in class org.restlet.data.Status
The server, while acting as a gateway or proxy, could not connect to the upstream server.
SERVER_ERROR_INSUFFICIENT_STORAGE - Static variable in class org.restlet.data.Status
This status code means the method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request.
SERVER_ERROR_INTERNAL - Static variable in class org.restlet.data.Status
The server encountered an unexpected condition which prevented it from fulfilling the request.
SERVER_ERROR_NOT_IMPLEMENTED - Static variable in class org.restlet.data.Status
The server does not support the functionality required to fulfill the request.
SERVER_ERROR_SERVICE_UNAVAILABLE - Static variable in class org.restlet.data.Status
The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.
SERVER_ERROR_VERSION_NOT_SUPPORTED - Static variable in class org.restlet.data.Status
The server does not support, or refuses to support, the HTTP protocol version that was used in the request message.
ServerInfo - Class in org.restlet.data
Server specific data related to a call.
ServerInfo() - Constructor for class org.restlet.data.ServerInfo
Constructor.
ServerList - Class in org.restlet.util
Modifiable list of server connectors.
ServerList(Context, Restlet) - Constructor for class org.restlet.util.ServerList
Constructor.
Service - Class in org.restlet.service
Generic service associated to a component or an application.
Service() - Constructor for class org.restlet.service.Service
Constructor.
Service(boolean) - Constructor for class org.restlet.service.Service
Constructor.
set(String, String, boolean) - Method in class org.restlet.util.Series
Replaces the value of the first parameter with the given name and removes all other parameters with the same name.
set(int, E) - Method in class org.restlet.util.WrapperList
Replaces the element at the specified position in this list with the specified element.
setAcceptedCharacterSets(List<Preference<CharacterSet>>) - Method in class org.restlet.data.ClientInfo
Sets the character set preferences.
setAcceptedEncodings(List<Preference<Encoding>>) - Method in class org.restlet.data.ClientInfo
Sets the encoding preferences.
setAcceptedLanguages(List<Preference<Language>>) - Method in class org.restlet.data.ClientInfo
Sets the language preferences.
setAcceptedMediaTypes(List<Preference<MediaType>>) - Method in class org.restlet.data.ClientInfo
Sets the media type preferences.
setAcceptRanges(boolean) - Method in class org.restlet.data.ServerInfo
Indicates if the server accepts range requests for a resource.
setAccessRestricted(boolean) - Method in class org.restlet.data.CookieSetting
Indicates whether to restrict cookie access to untrusted parties.
setAddress(String) - Method in class org.restlet.data.ClientInfo
Sets the client's IP address.
setAddress(String) - Method in class org.restlet.data.ServerInfo
Sets the IP address which received the call.
setAddress(String) - Method in class org.restlet.Server
Sets the optional listening IP address (local host used if null).
setAddresses(List<String>) - Method in class org.restlet.data.ClientInfo
Sets the list of client IP addresses.
setAgent(String) - Method in class org.restlet.data.ClientInfo
Sets the agent name (ex: "Noelios Restlet Engine/1.1").
setAgent(String) - Method in class org.restlet.data.ServerInfo
Sets the agent name (ex: "Noelios Restlet Engine/1.1").
setAllowedMethods(Set<Method>) - Method in class org.restlet.data.Response
Sets the set of methods allowed on the requested resource.
setAlphaComparator() - Method in class org.restlet.Directory
Sets the reference comparator based on classic alphabetical order.
setAlphaNumComparator() - Method in class org.restlet.Directory
Sets the reference comparator based on the more friendly "Alphanum Algorithm" created by David Koelle.
setAttributes(Map<String, Object>) - Method in class org.restlet.Context
Sets the modifiable map of attributes.
setAttributes(Map<String, Object>) - Method in class org.restlet.data.Message
Sets the modifiable map of attributes
setAuthenticated(boolean) - Method in class org.restlet.data.ChallengeResponse
Indicates if the identifier or principal has been authenticated.
setAuthor(String) - Method in class org.restlet.Application
Sets the author(s).
setAuthority(String) - Method in class org.restlet.data.Reference
Sets the authority component for hierarchical identifiers.
setAvailable(boolean) - Method in class org.restlet.resource.Representation
Indicates if some fresh content is available.
setAvailable(boolean) - Method in class org.restlet.resource.Resource
Indicates if the resource is actually available.
setAvailable(boolean) - Method in class org.restlet.util.WrapperRepresentation
 
setBaseRef(Reference) - Method in class org.restlet.data.Reference
Sets the base reference for relative references.
setBaseRef(String) - Method in class org.restlet.data.Reference
Sets the base reference for relative references.
setChallengeRequest(ChallengeRequest) - Method in class org.restlet.data.Response
Sets the authentication request sent by an origin server to a client.
setChallengeRequest(ChallengeRequest) - Method in class org.restlet.util.WrapperResponse
Sets the authentication request sent by an origin server to a client.
setChallengeRequests(List<ChallengeRequest>) - Method in class org.restlet.data.Response
Sets the list of authentication requests sent by an origin server to a client.
setChallengeRequests(List<ChallengeRequest>) - Method in class org.restlet.util.WrapperResponse
Sets the list of authentication requests sent by an origin server to a client.
setChallengeResponse(ChallengeResponse) - Method in class org.restlet.data.Request
Sets the authentication response sent by a client to an origin server.
setChallengeResponse(ChallengeResponse) - Method in class org.restlet.util.WrapperRequest
Sets the authentication response sent by a client to an origin server.
setChannel(ReadableByteChannel) - Method in class org.restlet.resource.ReadableRepresentation
Sets the readable channel.
setCharacterSet(CharacterSet) - Method in class org.restlet.resource.StringRepresentation
 
setCharacterSet(CharacterSet) - Method in class org.restlet.resource.Variant
Sets the character set or null if not applicable.
setCharacterSet(CharacterSet) - Method in class org.restlet.util.WrapperRepresentation
 
setCharacterSetAttribute(String) - Method in class org.restlet.service.TunnelService
Deprecated. Use setCharacterSetParameter instead.
setCharacterSetParameter(String) - Method in class org.restlet.service.TunnelService
Sets the character set parameter name.
setClientInfo(ClientInfo) - Method in class org.restlet.data.Request
Sets the client-specific information.
setClientProtocols(List<Protocol>) - Method in class org.restlet.service.ConnectorService
Sets the list of required client protocols.
setClients(ClientList) - Method in class org.restlet.Component
Sets a modifiable list of client connectors.
setComment(String) - Method in class org.restlet.data.CookieSetting
Sets the comment for the user.
setComment(String) - Method in class org.restlet.data.Product
Sets the facultative comment.
setComparator(Comparator<Reference>) - Method in class org.restlet.Directory
Sets the reference comparator used to sort index pages.
setConditions(Conditions) - Method in class org.restlet.data.Request
Sets the conditions applying to this request.
setConnectorService(ConnectorService) - Method in class org.restlet.Application
Sets the connector service.
setConnectTimeout(int) - Method in class org.restlet.Client
Sets the connection timeout in milliseconds.
setContactEmail(String) - Method in class org.restlet.service.StatusService
Sets the email address to contact in case of error.
setContext(Context) - Method in class org.restlet.Handler
Sets the parent context.
setContext(Context) - Method in class org.restlet.Restlet
Sets the context.
setContext(Context) - Method in class org.restlet.util.ClientList
Sets the context.
setContext(Context) - Method in class org.restlet.util.ServerList
Sets the context.
setContext(Context) - Method in class org.restlet.util.WrapperRestlet
 
setConverterService(ConverterService) - Method in class org.restlet.Application
Deprecated. Since 1.1 with no replacement as it doesn't fit well with content negotiation. Most users prefer to handle those conversion in Resource subclasses.
setCookies(Series<Cookie>) - Method in class org.restlet.data.Request
Sets the cookies provided by the client.
setCookieSettings(Series<CookieSetting>) - Method in class org.restlet.data.Response
Sets the cookie settings provided by the server.
setCredentialComponents(Series<Parameter>) - Method in class org.restlet.data.ChallengeResponse
Sets the credential components.
setCredentials(String) - Method in class org.restlet.data.ChallengeResponse
Sets the credentials.
setCurrent(Application) - Static method in class org.restlet.Application
Sets the context to associated with the current thread.
setCurrent(Context) - Static method in class org.restlet.Context
Sets the context to associated with the current thread.
setCurrent(Response) - Static method in class org.restlet.data.Response
Sets the response associated with the current thread.
setCurrent(Integer) - Static method in class org.restlet.VirtualHost
Sets the virtual host code associated with the current thread.
setDataFormat(boolean) - Method in class org.restlet.util.XmlWriter
 
setDecodedOnParse(boolean) - Method in class org.restlet.util.Variable
Indicates if the parsed value must be decoded.
setDecoderService(DecoderService) - Method in class org.restlet.Application
Sets the decoder service.
setDeeplyAccessible(boolean) - Method in class org.restlet.Directory
Indicates if the subdirectories are deeply accessible (true by default).
setDefaultEncoding(Encoding) - Method in class org.restlet.service.MetadataService
Sets the default encoding for local representations.
setDefaultHost(VirtualHost) - Method in class org.restlet.Component
Sets the default virtual host.
setDefaultLanguage(Language) - Method in class org.restlet.service.MetadataService
Sets the default language for local representations.
setDefaultMatchingMode(int) - Method in class org.restlet.Router
Sets the default matching mode to use when selecting routes based on URIs.
setDefaultMatchQuery(boolean) - Method in class org.restlet.Router
Sets the default setting for whether the routing should be done on URIs with or without taking into account query string.
setDefaultMediaType(MediaType) - Method in class org.restlet.service.MetadataService
Sets the default media type for local representations.
setDefaultRoute(Route) - Method in class org.restlet.Router
Sets the default route tested if no other one was available.
setDefaultValue(String) - Method in class org.restlet.util.Variable
Sets the default value to use if the key couldn't be found in the model.
setDefaultVariable(Variable) - Method in class org.restlet.util.Template
Sets the variable to use, if no variable is given.
setDescription(String) - Method in class org.restlet.Application
Sets the description.
setDigest(Digest) - Method in class org.restlet.resource.Representation
Sets the representation digest.
setDigest(Digest) - Method in class org.restlet.util.WrapperRepresentation
 
setDimensions(Set<Dimension>) - Method in class org.restlet.data.Response
Sets the set of dimensions on which the response entity may vary.
setDocument(Document) - Method in class org.restlet.resource.DomRepresentation
Sets the wrapped DOM document.
setDomain(String) - Method in class org.restlet.data.Cookie
Sets the domain name.
setDomainUris(Collection<String>) - Method in class org.restlet.Guard
Sets the URIs that define the HTTP DIGEST authentication protection domains.
setDownloadable(boolean) - Method in class org.restlet.resource.Representation
Indicates if the representation is downloadable which means that it can be obtained via a download dialog box.
setDownloadable(boolean) - Method in class org.restlet.util.WrapperRepresentation
 
setDownloadName(String) - Method in class org.restlet.resource.Representation
Set the suggested download file name for this representation.
setDownloadName(String) - Method in class org.restlet.util.WrapperRepresentation
 
setEnabled(boolean) - Method in class org.restlet.service.Service
Indicates if the service should be enabled.
setEncodedOnFormat(boolean) - Method in class org.restlet.util.Variable
Indicates if the formatted value must be encoded.
setEncodeVariables(boolean) - Method in class org.restlet.util.Template
Indicates if the variables must be encoded when formatting the template.
setEncodingAttribute(String) - Method in class org.restlet.service.TunnelService
Deprecated. Use setEncodingParameter instead.
setEncodingParameter(String) - Method in class org.restlet.service.TunnelService
Sets the name of the parameter containing the accepted encoding.
setEncodings(List<Encoding>) - Method in class org.restlet.resource.Variant
Sets the list of encodings applied to the entity-body.
setEncodings(List<Encoding>) - Method in class org.restlet.util.WrapperRepresentation
 
setEntity(Object) - Method in class org.restlet.data.Message
Deprecated. Since 1.1, the ConverterService is deprecated, with no replacement as it doesn't fit well with content negotiation. Most users prefer to handle those conversion in Resource subclasses.
setEntity(Representation) - Method in class org.restlet.data.Message
Sets the entity representation.
setEntity(String, MediaType) - Method in class org.restlet.data.Message
Sets a textual entity.
setEntity(Object) - Method in class org.restlet.util.WrapperRequest
Deprecated. Since 1.1, the ConverterService is deprecated, with no replacement as it doesn't fit well with content negotiation. Most users prefer to handle those conversion in Resource subclasses.
setEntity(Representation) - Method in class org.restlet.util.WrapperRequest
Sets the entity representation.
setEntity(String, MediaType) - Method in class org.restlet.util.WrapperRequest
Sets a textual entity.
setEntity(Object) - Method in class org.restlet.util.WrapperResponse
Deprecated. Since 1.1, the ConverterService is deprecated, with no replacement as it doesn't fit well with content negotiation. Most users prefer to handle those conversion in Resource subclasses.
setEntity(Representation) - Method in class org.restlet.util.WrapperResponse
Sets the entity representation.
setEntity(String, MediaType) - Method in class org.restlet.util.WrapperResponse
Sets a textual entity.
setExpirationDate(Date) - Method in class org.restlet.resource.Representation
Sets the future date when this representation expire.
setExpirationDate(Date) - Method in class org.restlet.resource.Variant
Deprecated. Use the Representation.setExpirationDate(Date) method instead.
setExpirationDate(Date) - Method in class org.restlet.util.WrapperRepresentation
 
setExtensions(String) - Method in class org.restlet.data.Reference
Sets the extensions for hierarchical identifiers.
setExtensions(String[]) - Method in class org.restlet.data.Reference
Sets the extensions based on an array of extension tokens (without dots).
setExtensionsTunnel(boolean) - Method in class org.restlet.service.TunnelService
Indicates if the client preferences can be tunnelled via the extensions.
setFile(File) - Method in class org.restlet.resource.FileRepresentation
Sets the file handle.
setFinderClass(Class<? extends Finder>) - Method in class org.restlet.Router
Sets the finder class to instantiate.
setFixed(boolean) - Method in class org.restlet.util.Variable
Indicates if the value is fixed
setFragment(String) - Method in class org.restlet.data.Reference
Sets the fragment identifier.
setHelped(T) - Method in class org.restlet.util.Helper
Sets the helped Restlet.
setHomeRef(Reference) - Method in class org.restlet.service.StatusService
Sets the home URI to propose in case of error.
setHostDomain(String) - Method in class org.restlet.data.Reference
Sets the host domain component for server based hierarchical identifiers.
setHostDomain(String) - Method in class org.restlet.VirtualHost
Sets the hostRef host domain to match.
setHostPort(Integer) - Method in class org.restlet.data.Reference
Sets the optional port number for server based hierarchical identifiers.
setHostPort(String) - Method in class org.restlet.VirtualHost
Sets the hostRef host port to match.
setHostRef(Reference) - Method in class org.restlet.data.Request
Sets the host reference.
setHostRef(String) - Method in class org.restlet.data.Request
Sets the host reference using an URI string.
setHostRef(Reference) - Method in class org.restlet.util.WrapperRequest
Sets the host reference.
setHostRef(String) - Method in class org.restlet.util.WrapperRequest
Sets the host reference using an URI string.
setHosts(List<VirtualHost>) - Method in class org.restlet.Component
Sets the modifiable list of virtual hosts.
setHostScheme(String) - Method in class org.restlet.VirtualHost
Sets the hostRef scheme to match.
setIdentifier(String) - Method in class org.restlet.data.ChallengeResponse
Sets the user identifier, such as a login name or an access key.
setIdentifier(String) - Method in class org.restlet.data.Reference
Sets the absolute resource identifier.
setIdentifier(Reference) - Method in class org.restlet.data.ReferenceList
Sets the list reference.
setIdentifier(String) - Method in class org.restlet.data.ReferenceList
Sets the list reference.
setIdentifier(Reference) - Method in class org.restlet.resource.Variant
Sets the optional identifier.
setIdentifier(String) - Method in class org.restlet.resource.Variant
Sets the identifier from a URI string.
setIdentifier(Reference) - Method in class org.restlet.util.WrapperRepresentation
 
setIdentifier(String) - Method in class org.restlet.util.WrapperRepresentation
 
setIdentityCheck(boolean) - Method in class org.restlet.service.LogService
Indicates if the identity check (as specified by RFC1413) is enabled.
setIndentStep(int) - Method in class org.restlet.util.XmlWriter
Set the current indent step.
setIndex(long) - Method in class org.restlet.data.Range
Sets the index from which to start the range.
setIndexName(String) - Method in class org.restlet.Directory
Sets the index name, without extensions.
setInstance(Engine) - Static method in class org.restlet.util.Engine
Sets the registered Restlet engine.
setInternalRouter(Router) - Method in class org.restlet.Component
Sets the private internal router were Restlets like Applications can be attached.
setLanguageAttribute(String) - Method in class org.restlet.service.TunnelService
Deprecated. Use setLanguageParameter instead.
setLanguageParameter(String) - Method in class org.restlet.service.TunnelService
Sets the name of the parameter containing the accepted language.
setLanguages(List<Language>) - Method in class org.restlet.resource.Variant
Sets the list of languages.
setLanguages(List<Language>) - Method in class org.restlet.util.WrapperRepresentation
 
setLastSegment(String) - Method in class org.restlet.data.Reference
Sets the last segment of the path.
setListingAllowed(boolean) - Method in class org.restlet.Directory
Indicates if the display of directory listings is allowed when no index file is found.
setLocationRef(Reference) - Method in class org.restlet.data.Response
Sets the reference that the client should follow for redirections or resource creations.
setLocationRef(String) - Method in class org.restlet.data.Response
Sets the reference that the client should follow for redirections or resource creations.
setLocationRef(Reference) - Method in class org.restlet.util.WrapperResponse
Sets the reference that the client should follow for redirections or resource creations.
setLocationRef(String) - Method in class org.restlet.util.WrapperResponse
Sets the reference that the client should follow for redirections or resource creations.
setLogFormat(String) - Method in class org.restlet.service.LogService
Sets the format to use when logging calls.
setLogger(Logger) - Method in class org.restlet.Context
Sets the logger.
setLogger(String) - Method in class org.restlet.Context
Sets the logger.
setLogger(Logger) - Method in class org.restlet.util.Template
Sets the logger to use.
setLoggerName(String) - Method in class org.restlet.service.LogService
Sets the name of the JDK's logger to use when logging access calls.
setLogService(LogService) - Method in class org.restlet.Component
Sets the global log service.
setMappings(Map<String, Metadata>) - Method in class org.restlet.service.MetadataService
Deprecated.  
setMatch(List<Tag>) - Method in class org.restlet.data.Conditions
Sets the "if-match" condition.
setMatchingMode(int) - Method in class org.restlet.Route
Sets the matching mode to use on the template when parsing a formatted reference.
setMatchingMode(int) - Method in class org.restlet.util.Template
Sets the matching mode to use when parsing a formatted reference.
setMatchQuery(boolean) - Method in class org.restlet.Route
Sets whether the matching should be done on the URI with or without query string.
setMaxAge(int) - Method in class org.restlet.data.CookieSetting
Sets the maximum age in seconds.
Use 0 to immediately discard an existing cookie.
Use -1 to discard the cookie at the end of the session (default).
setMaxAttempts(int) - Method in class org.restlet.Router
Sets the maximum number of attempts if no attachment could be matched on the first attempt.
setMediaType(MediaType) - Method in class org.restlet.resource.Variant
Sets the media type.
setMediaType(MediaType) - Method in class org.restlet.util.WrapperRepresentation
 
setMediaTypeAttribute(String) - Method in class org.restlet.service.TunnelService
Deprecated. Use setMediaTypeParameter instead.
setMediaTypeParameter(String) - Method in class org.restlet.service.TunnelService
Sets the name of the parameter containing the accepted media type.
setMetadata(T) - Method in class org.restlet.data.Preference
Sets the metadata associated with this preference.
setMetadataService(MetadataService) - Method in class org.restlet.Application
Sets the metadata service.
setMethod(Method) - Method in class org.restlet.data.Request
Sets the method called.
setMethod(Method) - Method in class org.restlet.util.WrapperRequest
Sets the method called.
setMethodParameter(String) - Method in class org.restlet.service.TunnelService
Sets the method parameter name.
setMethodTunnel(boolean) - Method in class org.restlet.service.TunnelService
Indicates if the method name can be tunnelled.
setMode(int) - Method in class org.restlet.Redirector
Sets the redirection mode.
setMode(int) - Method in class org.restlet.Transformer
Sets the transformation mode.
setModifiable(boolean) - Method in class org.restlet.Directory
Indicates if modifications to local resources are allowed.
setModifiable(boolean) - Method in class org.restlet.resource.Resource
Indicates if the representations can be modified via the Resource.handlePost(), the Resource.handlePut() or the Resource.handleDelete() methods.
setModificationDate(Date) - Method in class org.restlet.resource.Representation
Sets the last date when this representation was modified.
setModificationDate(Date) - Method in class org.restlet.resource.Variant
Deprecated. Use the Representation.setModificationDate(Date) method instead.
setModificationDate(Date) - Method in class org.restlet.util.WrapperRepresentation
 
setModifiedSince(Date) - Method in class org.restlet.data.Conditions
Sets the "if-modified-since" condition.
setName(String) - Method in class org.restlet.Application
Sets the display name.
setName(String) - Method in class org.restlet.data.Parameter
Sets the name.
setName(String) - Method in class org.restlet.data.Product
Sets the product name.
setName(String) - Method in class org.restlet.VirtualHost
Sets the display name.
setNamespaceAware(boolean) - Method in class org.restlet.resource.XmlRepresentation
Indicates if processing is namespace aware.
setNegotiateContent(boolean) - Method in class org.restlet.Directory
Indicates if the best content is automatically negotiated.
setNegotiateContent(boolean) - Method in class org.restlet.resource.Resource
Indicates if the returned representation is automatically negotiated.
setNext(Class<? extends Resource>) - Method in class org.restlet.Filter
Sets the next Restlet as a Finder for a given Resource class.
setNext(Restlet) - Method in class org.restlet.Filter
Sets the next Restlet.
setNonceLifespan(long) - Method in class org.restlet.Guard
Sets the number of milliseconds between each mandatory nonce refresh.
setNoneMatch(List<Tag>) - Method in class org.restlet.data.Conditions
Sets the "if-none-match" condition.
setObject(T) - Method in class org.restlet.resource.ObjectRepresentation
Sets the represented object.
setOriginalRef(Reference) - Method in class org.restlet.data.Request
Sets the original reference requested by the client.
setOutput(Writer) - Method in class org.restlet.util.XmlWriter
Set a new output destination for the document.
setOutputProperties(Map<String, String>) - Method in class org.restlet.resource.TransformRepresentation
Sets the modifiable map of JAXP transformer output properties.
setOverwrite(boolean) - Method in class org.restlet.service.StatusService
Indicates if an existing entity should be overwritten.
setOwner(String) - Method in class org.restlet.Application
Sets the owner(s).
setParameters(Series<Parameter>) - Method in class org.restlet.Context
Sets the modifiable series of parameters.
setParameters(Series<Parameter>) - Method in class org.restlet.data.ChallengeRequest
Sets the modifiable series of scheme parameters.
setParameters(Series<Parameter>) - Method in class org.restlet.data.Preference
Sets the modifiable list of parameters.
setParameters(Map<String, Object>) - Method in class org.restlet.resource.TransformRepresentation
Sets the JAXP transformer parameters.
setPath(String) - Method in class org.restlet.data.Cookie
Sets the validity path.
setPath(String) - Method in class org.restlet.data.Reference
Sets the path component for hierarchical identifiers.
setPattern(String) - Method in class org.restlet.util.Template
Sets the pattern to use for formatting or parsing.
setPort(int) - Method in class org.restlet.data.ClientInfo
Sets the port number which sent the call.
setPort(int) - Method in class org.restlet.data.ServerInfo
Sets the port number which received the call.
setPort(int) - Method in class org.restlet.Server
Sets the listening port if specified.
setPreferencesTunnel(boolean) - Method in class org.restlet.service.TunnelService
Indicates if the client preferences can be tunnelled via the query parameters.
setPrefix(String, String) - Method in class org.restlet.util.XmlWriter
Specify a preferred prefix for a Namespace URI.
setProtocol(Protocol) - Method in class org.restlet.data.Reference
Sets the scheme component based on this protocol.
setProtocols(List<Protocol>) - Method in class org.restlet.Connector
Sets the protocols simultaneously supported.
setQuality(float) - Method in class org.restlet.data.Preference
Sets the quality/preference level.
setQuery(String) - Method in class org.restlet.data.Reference
Sets the query component for hierarchical identifiers.
setQueryTunnel(boolean) - Method in class org.restlet.service.TunnelService
Indicates if the method and client preferences can be tunnelled via query parameters.
setRange(Range) - Method in class org.restlet.resource.Representation
Sets the range where in the full content the partial content available should be applied.
setRange(Range) - Method in class org.restlet.util.WrapperRepresentation
 
setRanges(List<Range>) - Method in class org.restlet.data.Request
Sets the ranges to return from the target resource's representation.
setRangeService(RangeService) - Method in class org.restlet.Application
Sets the range service.
setReadable(boolean) - Method in class org.restlet.resource.Resource
Indicates if the representations can be read via the Resource.handleGet() method.
setReader(Reader) - Method in class org.restlet.resource.ReaderRepresentation
Sets the reader to use.
setRealm(String) - Method in class org.restlet.data.ChallengeRequest
Sets the realm name.
setRealm(String) - Method in class org.restlet.Guard
Sets the authentication realm.
setRechallengeEnabled(boolean) - Method in class org.restlet.Guard
Indicates if a new challenge should be sent when invalid credentials are received.
setRedirectRef(Reference) - Method in class org.restlet.data.Response
Deprecated. Use the setLocationRef() method instead.
setRedirectRef(String) - Method in class org.restlet.data.Response
Deprecated. Use the setLocationRef() method instead.
setRedirectRef(Reference) - Method in class org.restlet.util.WrapperResponse
Deprecated. Use the setLocationRef() method instead.
setRedirectRef(String) - Method in class org.restlet.util.WrapperResponse
Deprecated. Use the setLocationRef() method instead.
setReferrerRef(Reference) - Method in class org.restlet.data.Request
Sets the referrer reference if available.
setReferrerRef(String) - Method in class org.restlet.data.Request
Sets the referrer reference if available using an URI string.
setReferrerRef(Reference) - Method in class org.restlet.util.WrapperRequest
Sets the referrer reference if available.
setReferrerRef(String) - Method in class org.restlet.util.WrapperRequest
Sets the referrer reference if available using an URI string.
setRelativePart(String) - Method in class org.restlet.data.Reference
Sets the relative part for relative references only.
setRequest(Request) - Method in class org.restlet.data.Response
Sets the associated request.
setRequest(Request) - Method in class org.restlet.Handler
Sets the request to handle.
setRequest(Request) - Method in class org.restlet.util.WrapperResponse
Sets the associated request.
setRequest(WrapperRequest) - Method in class org.restlet.util.WrapperResponse
Sets the associated request.
setRequired(boolean) - Method in class org.restlet.util.Variable
Indicates if the variable is required or optional.
setRequiredScore(float) - Method in class org.restlet.Router
Sets the score required to have a match.
setResourceDomain(String) - Method in class org.restlet.VirtualHost
Sets the resourceRef host domain to match.
setResourcePort(String) - Method in class org.restlet.VirtualHost
Sets the resourceRef host port to match.
setResourceRef(Reference) - Method in class org.restlet.data.Request
Sets the target resource reference.
setResourceRef(String) - Method in class org.restlet.data.Request
Sets the target resource reference using an URI string.
setResourceRef(Reference) - Method in class org.restlet.util.WrapperRequest
Sets the target resource reference.
setResourceRef(String) - Method in class org.restlet.util.WrapperRequest
Sets the target resource reference using an URI string.
setResourceScheme(String) - Method in class org.restlet.VirtualHost
Sets the resourceRef scheme to match.
setResponse(Response) - Method in class org.restlet.Handler
Sets the response to update.
setResultCharacterSet(CharacterSet) - Method in class org.restlet.Transformer
Sets the character set of the result representation.
setResultEncodings(List<Encoding>) - Method in class org.restlet.Transformer
Sets the encodings of the result representation.
setResultLanguages(List<Language>) - Method in class org.restlet.Transformer
Sets the languages of the result representation.
setResultMediaType(MediaType) - Method in class org.restlet.Transformer
Sets the media type of the result representation.
setRetryDelay(long) - Method in class org.restlet.Router
Sets the delay (in seconds) before a new attempt.
setRoot(Restlet) - Method in class org.restlet.Application
Sets the root Restlet.
setRootRef(Reference) - Method in class org.restlet.data.Request
Sets the application root reference.
setRootRef(Reference) - Method in class org.restlet.Directory
Sets the root URI from which the relative resource URIs will be lookep up.
setRootRef(Reference) - Method in class org.restlet.util.WrapperRequest
Sets the application root reference.
setRouter(Router) - Method in class org.restlet.Route
Sets the parent router.
setRoutes(RouteList) - Method in class org.restlet.Router
Sets the modifiable list of routes.
setRoutingMode(int) - Method in class org.restlet.Router
Sets the routing mode.
setSaxSource(SAXSource) - Method in class org.restlet.resource.SaxRepresentation
Sets a SAX source that can be parsed by the SaxRepresentation.parse(ContentHandler) method.
setScheme(ChallengeScheme) - Method in class org.restlet.data.ChallengeRequest
Sets the scheme used.
setScheme(ChallengeScheme) - Method in class org.restlet.data.ChallengeResponse
Sets the scheme used.
setScheme(String) - Method in class org.restlet.data.Reference
Sets the scheme component.
setScheme(ChallengeScheme) - Method in class org.restlet.Guard
Sets the authentication challenge scheme.
setSchemeSpecificPart(String) - Method in class org.restlet.data.Reference
Sets the scheme specific part.
setSecret(char[]) - Method in class org.restlet.data.ChallengeResponse
Sets the user secret, such as a password or a secret key.
setSecret(String) - Method in class org.restlet.data.ChallengeResponse
Sets the user secret, such as a password or a secret key.
setSecretResolver(Resolver<char[]>) - Method in class org.restlet.Guard
Sets the secret resolver.
setSecure(boolean) - Method in class org.restlet.data.CookieSetting
Indicates if cookie should only be transmitted by secure means.
setSegments(List<String>) - Method in class org.restlet.data.Reference
Sets the segments of a hierarchical path.
A new absolute path will replace any existing one.
setServerAddress(String) - Method in class org.restlet.VirtualHost
Sets the listening server address.
setServerInfo(ServerInfo) - Method in class org.restlet.data.Response
Sets the server-specific information.
setServerKey(String) - Method in class org.restlet.Guard
Sets the secret key known only by server.
setServerPort(String) - Method in class org.restlet.VirtualHost
Sets the listening server port.
setServerProtocols(List<Protocol>) - Method in class org.restlet.service.ConnectorService
Sets he list of required server protocols.
setServers(ServerList) - Method in class org.restlet.Component
Sets a modifiable list of server connectors.
setShutdownAllowed(boolean) - Method in class org.restlet.service.TaskService
Indicates if the TaskService.shutdown() and TaskService.shutdownNow() methods are allowed to effectively shutdown the wrapped executor service.
setSize(long) - Method in class org.restlet.data.Range
Sets the size of the range in number of bytes.
setSize(long) - Method in class org.restlet.resource.Representation
Sets the expected size in bytes if known, -1 otherwise.
setSize(long) - Method in class org.restlet.resource.Variant
Deprecated. Use the Representation.setSize(long) method instead.
setSize(long) - Method in class org.restlet.util.WrapperRepresentation
 
setSourceRepresentation(Representation) - Method in class org.restlet.resource.TransformRepresentation
Sets the source representation to transform.
setStatus(Status) - Method in class org.restlet.data.Response
Sets the status.
setStatus(Status, String) - Method in class org.restlet.data.Response
Sets the status.
setStatus(Status, Throwable) - Method in class org.restlet.data.Response
Sets the status.
setStatus(Status, Throwable, String) - Method in class org.restlet.data.Response
Sets the status.
setStatus(Status) - Method in class org.restlet.util.WrapperResponse
Sets the status.
setStatus(Status, String) - Method in class org.restlet.util.WrapperResponse
Sets the status.
setStatusService(StatusService) - Method in class org.restlet.Application
Sets the status service.
setStatusService(StatusService) - Method in class org.restlet.Component
Sets the status service.
setStream(InputStream) - Method in class org.restlet.resource.InputRepresentation
Sets the input stream to use.
setTag(Tag) - Method in class org.restlet.resource.Representation
Sets the tag.
setTag(Tag) - Method in class org.restlet.resource.Variant
Deprecated. Use the Representation.setTag(Tag) method instead.
setTag(Tag) - Method in class org.restlet.util.WrapperRepresentation
 
setTarget(Restlet) - Method in class org.restlet.Server
Sets the target Restlet.
setTarget(Restlet) - Method in class org.restlet.util.ServerList
Sets the target Restlet.
setTargetClass(Class<? extends Handler>) - Method in class org.restlet.Finder
Sets the target Handler class.
setTargetTemplate(String) - Method in class org.restlet.Redirector
Sets the target URI pattern.
setTaskService(TaskService) - Method in class org.restlet.Application
Sets the task service.
setTemplate(Template) - Method in class org.restlet.Route
Sets the reference template to match.
setTemplates(Templates) - Method in class org.restlet.resource.TransformRepresentation
Sets the templates to be used and reused.
setText(String) - Method in class org.restlet.resource.StringRepresentation
Sets the string value.
setTransformSheet(Representation) - Method in class org.restlet.resource.TransformRepresentation
Sets the XSLT transform sheet to apply to message entities.
setTransformSheet(Representation) - Method in class org.restlet.Transformer
Sets the XSLT transform sheet to apply to message entities.
setTransient(boolean) - Method in class org.restlet.resource.Representation
Indicates if the representation's content is transient.
setTransient(boolean) - Method in class org.restlet.util.WrapperRepresentation
 
setTunnelService(TunnelService) - Method in class org.restlet.Application
Sets the tunnel service.
setType(int) - Method in class org.restlet.util.Variable
Sets the type of variable.
setUnmodifiedSince(Date) - Method in class org.restlet.data.Conditions
Sets the "if-unmodified-since" condition.
setUri(String) - Method in class org.restlet.data.Method
 
setUriResolver(URIResolver) - Method in class org.restlet.resource.TransformRepresentation
Sets the URI resolver.
setUserAgentTunnel(boolean) - Method in class org.restlet.service.TunnelService
Indicates if the client preferences can be tunnelled according to the user agent.
setUserClassLoader(ClassLoader) - Static method in class org.restlet.util.Engine
Sets the user class loader that should used in priority.
setUserInfo(String) - Method in class org.restlet.data.Reference
Sets the user info component for server based hierarchical identifiers.
setValue(String) - Method in class org.restlet.data.Parameter
Sets the value.
setVariables(Map<String, Variable>) - Method in class org.restlet.util.Template
Sets the modifiable map of variables.
setVariants(List<Variant>) - Method in class org.restlet.resource.Resource
Sets the modifiable list of variants.
setVersion(int) - Method in class org.restlet.data.Cookie
Sets the cookie specification version.
setVersion(String) - Method in class org.restlet.data.Product
Sets the version of the product.
shutdown() - Method in class org.restlet.service.TaskService
Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted.
shutdownNow() - Method in class org.restlet.service.TaskService
Attempts to stop all actively executing tasks, halts the processing of waiting tasks, and returns a list of the tasks that were awaiting execution.
size() - Method in class org.restlet.util.NodeSet
 
size() - Method in class org.restlet.util.WrapperList
Returns the number of elements in this list.
size() - Method in class org.restlet.util.WrapperMap
Returns the number of key-value mappings in this map.
SIZE_MAX - Static variable in class org.restlet.data.Range
Maximum size available from the index.
SKIP - Static variable in class org.restlet.Filter
Indicates that after the Filter.beforeHandle(Request, Response) method, the request processing should skip the Filter.doHandle(Request, Response) method to continue with the Filter.afterHandle(Request, Response) method.
SMTP - Static variable in class org.restlet.data.Protocol
SMTP protocol.
SMTP_PLAIN - Static variable in class org.restlet.data.ChallengeScheme
Plain SMTP scheme.
SMTP_STARTTLS - Static variable in class org.restlet.data.Protocol
Deprecated. Use the "startTls" parameter on the JavaMail connector instead.
SMTPS - Static variable in class org.restlet.data.Protocol
SMTPS protocol (via SSL/TLS socket).
SPANISH - Static variable in class org.restlet.data.Language
Spanish language.
start() - Method in class org.restlet.Application
Starts the application then all the enabled associated services.
start() - Method in class org.restlet.Client
 
start() - Method in class org.restlet.Component
Starts the component.
start() - Method in class org.restlet.Restlet
Starts the Restlet.
start() - Method in class org.restlet.Server
 
start() - Method in class org.restlet.service.Service
Starts the Restlet.
start() - Method in class org.restlet.service.TaskService
 
start() - Method in class org.restlet.util.Helper
Start callback.
start() - Method in class org.restlet.util.WrapperRestlet
 
startClients() - Method in class org.restlet.Component
Starts the client connectors.
startDocument() - Method in class org.restlet.util.XmlWriter
Write the XML declaration at the beginning of the document.
startElement(String) - Method in class org.restlet.util.XmlWriter
Start a new element without a qname, attributes or a Namespace URI.
startElement(String, String) - Method in class org.restlet.util.XmlWriter
Start a new element without a qname or attributes.
startElement(String, String, String, Attributes) - Method in class org.restlet.util.XmlWriter
Write a start tag.
startHelper() - Method in class org.restlet.Component
Starts the internal helper allowing incoming requests to be served.
startServers() - Method in class org.restlet.Component
Starts the server connectors.
startServices() - Method in class org.restlet.Component
Starts the associated services.
Status - Class in org.restlet.data
Status to return after handling a call.
Status(int) - Constructor for class org.restlet.data.Status
Constructor.
Status(int, String, String, String) - Constructor for class org.restlet.data.Status
Constructor.
Status(int, Throwable) - Constructor for class org.restlet.data.Status
Constructor.
Status(int, Throwable, String, String, String) - Constructor for class org.restlet.data.Status
Constructor.
Status(Status, String) - Constructor for class org.restlet.data.Status
Constructor.
Status(Status, Throwable) - Constructor for class org.restlet.data.Status
Constructor.
Status(Status, Throwable, String) - Constructor for class org.restlet.data.Status
Constructor.
StatusService - Class in org.restlet.service
Service to handle error statuses.
StatusService() - Constructor for class org.restlet.service.StatusService
Constructor.
StatusService(boolean) - Constructor for class org.restlet.service.StatusService
Constructor.
stop() - Method in class org.restlet.Application
Stops all the enabled associated services the the application itself.
stop() - Method in class org.restlet.Client
 
stop() - Method in class org.restlet.Component
Stops the component.
STOP - Static variable in class org.restlet.Filter
Indicates that the request processing should stop and return the current response from the filter.
stop() - Method in class org.restlet.Restlet
Stops the Restlet.
stop() - Method in class org.restlet.Server
 
stop() - Method in class org.restlet.service.Service
Stops the Restlet.
stop() - Method in class org.restlet.service.TaskService
 
stop() - Method in class org.restlet.util.Helper
Stop callback.
stop() - Method in class org.restlet.util.WrapperRestlet
 
stopClients() - Method in class org.restlet.Component
Stops the client connectors.
stopHelper() - Method in class org.restlet.Component
Stops the internal helper allowing incoming requests to be served.
stopServers() - Method in class org.restlet.Component
Stops the server connectors.
stopServices() - Method in class org.restlet.Component
Stops the associated services.
storeRepresentation(Representation) - Method in class org.restlet.resource.Resource
Stores a representation put to the resource and replaces all existing representations of the resource.
StreamRepresentation - Class in org.restlet.resource
Representation based on a BIO stream.
StreamRepresentation(MediaType) - Constructor for class org.restlet.resource.StreamRepresentation
Constructor.
StringRepresentation - Class in org.restlet.resource
Represents an Unicode string that can be converted to any character set supported by Java.
StringRepresentation(CharSequence) - Constructor for class org.restlet.resource.StringRepresentation
Constructor.
StringRepresentation(CharSequence, Language) - Constructor for class org.restlet.resource.StringRepresentation
Constructor.
StringRepresentation(CharSequence, MediaType) - Constructor for class org.restlet.resource.StringRepresentation
Constructor.
StringRepresentation(CharSequence, MediaType, Language) - Constructor for class org.restlet.resource.StringRepresentation
Constructor.
StringRepresentation(CharSequence, MediaType, Language, CharacterSet) - Constructor for class org.restlet.resource.StringRepresentation
Constructor.
subList(int, int) - Method in class org.restlet.data.ReferenceList
Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
subList(int, int) - Method in class org.restlet.util.RouteList
Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
subList(int, int) - Method in class org.restlet.util.Series
Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
subList(String) - Method in class org.restlet.util.Series
Returns a list of all the values associated to the parameter name.
subList(String, boolean) - Method in class org.restlet.util.Series
Returns a list of all the values associated to the parameter name.
subList(int, int) - Method in class org.restlet.util.WrapperList
Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
submit(Callable<T>) - Method in class org.restlet.service.TaskService
Submits a value-returning task for execution and returns a Future representing the pending results of the task.
submit(Runnable) - Method in class org.restlet.service.TaskService
 
submit(Runnable, T) - Method in class org.restlet.service.TaskService
 
SUCCESS_ACCEPTED - Static variable in class org.restlet.data.Status
The request has been accepted for processing, but the processing has not been completed.
SUCCESS_CREATED - Static variable in class org.restlet.data.Status
The request has been fulfilled and resulted in a new resource being created.
SUCCESS_MULTI_STATUS - Static variable in class org.restlet.data.Status
This response is used to inform the client that the HTTP response entity contains a set of status codes generated during the method invocation.
SUCCESS_NO_CONTENT - Static variable in class org.restlet.data.Status
The server has fulfilled the request but does not need to return an entity-body (for example after a DELETE), and might want to return updated metainformation.
SUCCESS_NON_AUTHORITATIVE - Static variable in class org.restlet.data.Status
The request has succeeded but the returned metainformation in the entity-header do not come from the origin server, but is gathered from a local or a third-party copy.
SUCCESS_OK - Static variable in class org.restlet.data.Status
The request has succeeded.
SUCCESS_PARTIAL_CONTENT - Static variable in class org.restlet.data.Status
The server has fulfilled the partial GET request for the resource assuming the request has included a Range header field indicating the desired range.
SUCCESS_RESET_CONTENT - Static variable in class org.restlet.data.Status
The server has fulfilled the request and the user agent SHOULD reset the document view which caused the request to be sent.

T

Tag - Class in org.restlet.data
Validation tag equivalent to the HTTP entity tag.
Tag() - Constructor for class org.restlet.data.Tag
Default constructor.
Tag(String) - Constructor for class org.restlet.data.Tag
Constructor of weak tags.
Tag(String, boolean) - Constructor for class org.restlet.data.Tag
Constructor.
targetTemplate - Variable in class org.restlet.Redirector
The target URI pattern.
TaskService - Class in org.restlet.service
Service capable of running tasks asynchronously.
TaskService() - Constructor for class org.restlet.service.TaskService
Constructor.
Template - Class in org.restlet.util
String template with a pluggable model.
Template(Logger, String) - Constructor for class org.restlet.util.Template
Deprecated. Use the constructor with logger instead. The logger can still be set using the Template.setLogger(Logger) method.
Template(Logger, String, int) - Constructor for class org.restlet.util.Template
Deprecated. Use the constructor with logger instead. The logger can still be set using the Template.setLogger(Logger) method.
Template(Logger, String, int, int, String, boolean, boolean) - Constructor for class org.restlet.util.Template
Deprecated. Use the constructor with logger instead. The logger can still be set using the Template.setLogger(Logger) method.
Template(Logger, String, int, int, String, boolean, boolean, boolean) - Constructor for class org.restlet.util.Template
Deprecated. Use the constructor with logger instead. The logger can still be set using the Template.setLogger(Logger) method.
Template(String) - Constructor for class org.restlet.util.Template
Default constructor.
Template(String, int) - Constructor for class org.restlet.util.Template
Constructor.
Template(String, int, int, String, boolean, boolean) - Constructor for class org.restlet.util.Template
Constructor.
TEXT_ALL - Static variable in class org.restlet.data.MediaType
 
TEXT_CALENDAR - Static variable in class org.restlet.data.MediaType
 
TEXT_CSS - Static variable in class org.restlet.data.MediaType
 
TEXT_HTML - Static variable in class org.restlet.data.MediaType
 
TEXT_J2ME_APP_DESCRIPTOR - Static variable in class org.restlet.data.MediaType
 
TEXT_JAVASCRIPT - Static variable in class org.restlet.data.MediaType
 
TEXT_PLAIN - Static variable in class org.restlet.data.MediaType
 
TEXT_RDF_N3 - Static variable in class org.restlet.data.MediaType
 
TEXT_URI_LIST - Static variable in class org.restlet.data.MediaType
 
TEXT_VCARD - Static variable in class org.restlet.data.MediaType
 
TEXT_XML - Static variable in class org.restlet.data.MediaType
 
toArray() - Method in class org.restlet.util.WrapperList
Returns an array containing all of the elements in this list in proper sequence.
toArray(T[]) - Method in class org.restlet.util.WrapperList
Returns an array containing all of the elements in this list in proper sequence; the runtime type of the returned array is that of the specified array.
toBase64(byte[]) - Method in class org.restlet.util.Engine
Converts the given bytes array into a Base64 String.
toMd5(String) - Method in class org.restlet.util.Engine
Returns the MD5 digest of the target string.
toObject(Representation) - Method in class org.restlet.service.ConverterService
Deprecated. Converts a representation into a higher-level object.
toRepresentation(Object) - Method in class org.restlet.service.ConverterService
Deprecated. Converts a higher-level object into a representation.
toString() - Method in class org.restlet.data.MediaType
 
toString() - Method in class org.restlet.data.Metadata
Returns the metadata name.
toString() - Method in class org.restlet.data.Parameter
Returns a string with the name and value of the parameter.
toString() - Method in class org.restlet.data.Preference
 
toString(String, String, Integer, String, String, String) - Static method in class org.restlet.data.Reference
Creates a reference string from its parts.
toString(String, String, String) - Static method in class org.restlet.data.Reference
Creates a relative reference string from its parts.
toString(String, String, String, String, String) - Static method in class org.restlet.data.Reference
Creates a reference string from its parts.
toString() - Method in class org.restlet.data.Reference
Returns the reference as an URI string.
toString(boolean, boolean) - Method in class org.restlet.data.Reference
Returns the URI reference string.
toString() - Method in class org.restlet.data.Status
Returns the name of the status followed by its HTTP code.
toString(InputStream) - Static method in class org.restlet.util.ByteUtils
Converts an input stream to a string.
As this method uses the InputstreamReader class, the default character set is used for decoding the input stream.
toString(InputStream, CharacterSet) - Static method in class org.restlet.util.ByteUtils
Converts an input stream to a string using the specified character set for decoding the input stream.
toString(Reader) - Static method in class org.restlet.util.ByteUtils
Converts a reader to a string.
toString(Calendar) - Static method in class org.restlet.util.InternetDateFormat
Converts the specified Calendar object to an RFC 3339 date/time string.
toString(Date) - Static method in class org.restlet.util.InternetDateFormat
Converts the specified Date object to an RFC 3339 date/time string using the UTC (Z) time zone.
toString(Date, TimeZone) - Static method in class org.restlet.util.InternetDateFormat
Converts the specified Date object to an RFC 3339 date/time string using the specified time zone.
toString(long) - Static method in class org.restlet.util.InternetDateFormat
Converts the specified millisecond time value to an RFC 3339 date/time string using the UTC (Z) time zone.
toString(long, TimeZone) - Static method in class org.restlet.util.InternetDateFormat
Converts the specified millisecond time value to an RFC 3339 date/time string using the specified time zone.
toString() - Method in class org.restlet.util.InternetDateFormat
Converts this InternetDateFormat object to an RFC 3339 date/time string.
toString() - Method in class org.restlet.util.WrapperList
Returns a string representation of the list.
TRACE - Static variable in class org.restlet.data.Method
Used to invoke a remote, application-layer loop-back of the request message.
transform(Representation) - Method in class org.restlet.Transformer
Transforms a source XML representation by applying an XSLT transform sheet to it.
Transformer - Class in org.restlet
Filter that can transform XML representations by applying an XSLT transform sheet.
Transformer(int, Representation) - Constructor for class org.restlet.Transformer
Constructor.
TransformRepresentation - Class in org.restlet.resource
Representation able to apply an XSLT transformation.
TransformRepresentation(Context, Representation, Representation) - Constructor for class org.restlet.resource.TransformRepresentation
Constructor.
TransformRepresentation(Representation, Representation) - Constructor for class org.restlet.resource.TransformRepresentation
Default constructor.
TransformRepresentation(URIResolver, Representation, Representation) - Constructor for class org.restlet.resource.TransformRepresentation
Constructor.
TransformRepresentation(URIResolver, Representation, Templates) - Constructor for class org.restlet.resource.TransformRepresentation
Constructor.
TunnelService - Class in org.restlet.service
Service tunneling request method or client preferences.
TunnelService(boolean, boolean) - Constructor for class org.restlet.service.TunnelService
Constructor that enables the query tunnel and disables the extensions and user agent tunnels.
TunnelService(boolean, boolean, boolean) - Constructor for class org.restlet.service.TunnelService
Constructor that enables the query tunnel and disables the extensions and user agent tunnels.
TunnelService(boolean, boolean, boolean, boolean, boolean) - Constructor for class org.restlet.service.TunnelService
Constructor that disables the user agent tunnel.
TunnelService(boolean, boolean, boolean, boolean, boolean, boolean) - Constructor for class org.restlet.service.TunnelService
Constructor.
TYPE_ALL - Static variable in class org.restlet.util.Variable
Matches all characters.
TYPE_ALPHA - Static variable in class org.restlet.util.Variable
Matches all alphabetical characters.
TYPE_ALPHA_DIGIT - Static variable in class org.restlet.util.Variable
Matches all alphabetical and digital characters.
TYPE_COMMENT - Static variable in class org.restlet.util.Variable
Matches any TEXT excluding "(" and ")".
TYPE_COMMENT_ATTRIBUTE - Static variable in class org.restlet.util.Variable
Matches any TEXT inside a comment excluding ";".
TYPE_DIGIT - Static variable in class org.restlet.util.Variable
Matches all digital characters.
TYPE_TOKEN - Static variable in class org.restlet.util.Variable
Matches any CHAR except CTLs or separators.
TYPE_URI_ALL - Static variable in class org.restlet.util.Variable
Matches all URI characters.
TYPE_URI_FRAGMENT - Static variable in class org.restlet.util.Variable
Matches URI fragment characters.
TYPE_URI_PATH - Static variable in class org.restlet.util.Variable
Matches URI path characters (not the query or the fragment parts).
TYPE_URI_QUERY - Static variable in class org.restlet.util.Variable
Matches URI query characters.
TYPE_URI_SCHEME - Static variable in class org.restlet.util.Variable
Matches URI scheme characters.
TYPE_URI_SEGMENT - Static variable in class org.restlet.util.Variable
Matches URI segment characters.
TYPE_URI_UNRESERVED - Static variable in class org.restlet.util.Variable
Matches unreserved URI characters.
TYPE_WORD - Static variable in class org.restlet.util.Variable
Matches all alphabetical and digital characters plus the underscore.

U

Uniform - Class in org.restlet
Base class exposing the uniform REST interface.
Uniform() - Constructor for class org.restlet.Uniform
 
UNKNOWN_PORT - Static variable in class org.restlet.data.Protocol
Indicates that the port number is undefined.
UNKNOWN_SIZE - Static variable in class org.restlet.resource.Representation
Indicates that the size of the representation can't be known in advance.
UNKNOWN_SIZE - Static variable in class org.restlet.resource.Variant
Deprecated. Use the Representation.UNKNOWN_SIZE constant instead.
UNLOCK - Static variable in class org.restlet.data.Method
Removes the lock identified by the lock token from the request URI, and all other resources included in the lock.
unmodifiable(Date) - Static method in class org.restlet.util.DateUtils
Returns an immutable version of a given date.
update() - Method in class org.restlet.util.Helper
Update callback with less impact than a Helper.stop() followed by a Helper.start().
updateAllowedMethods() - Method in class org.restlet.Handler
Updates the set of allowed methods on the response.
updateHosts() - Method in class org.restlet.Component
Updates the component to take into account changes to the virtual hosts.
updateSize() - Method in class org.restlet.resource.StringRepresentation
Updates the expected size according to the current string value.
US_ASCII - Static variable in class org.restlet.data.CharacterSet
The US-ASCII character set.
UTC - Static variable in class org.restlet.util.InternetDateFormat
A time zone with zero offset and no DST.
UTF_16 - Static variable in class org.restlet.data.CharacterSet
The UTF-16 character set.
UTF_8 - Static variable in class org.restlet.data.CharacterSet
The UTF-8 character set.

V

validate(Representation) - Method in class org.restlet.resource.XmlRepresentation
Validates the XML representation against a given schema.
validate(Representation, Result) - Method in class org.restlet.resource.XmlRepresentation
Validates the XML representation against a given schema.
validate(Schema) - Method in class org.restlet.resource.XmlRepresentation
Validates the XML representation against a given schema.
validate(Schema, Result) - Method in class org.restlet.resource.XmlRepresentation
Validates the XML representation against a given schema.
validate(String, boolean, String) - Method in class org.restlet.Route
Checks the request attributes for presence, format, etc.
valueOf(String) - Static method in class org.restlet.data.ChallengeScheme
Returns the challenge scheme associated to a scheme name.
valueOf(String) - Static method in class org.restlet.data.CharacterSet
Returns the character set associated to a name.
valueOf(String) - Static method in enum org.restlet.data.Dimension
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in class org.restlet.data.Encoding
Returns the encoding associated to a name.
valueOf(String) - Static method in class org.restlet.data.Language
Returns the language associated to a name.
valueOf(String) - Static method in class org.restlet.data.MediaType
Returns the media type associated to a name.
valueOf(String) - Static method in class org.restlet.data.Method
Returns the method associated to a given method name.
valueOf(String) - Static method in class org.restlet.data.Protocol
Creates the protocol associated to a URI scheme name.
valueOf(int) - Static method in class org.restlet.data.Status
Returns the status associated to a code.
valueOf(Date) - Static method in class org.restlet.util.InternetDateFormat
Creates a new InternetDateFormat object from the specified Date object using the UTC (Z) time zone.
valueOf(Date, TimeZone) - Static method in class org.restlet.util.InternetDateFormat
Creates a new InternetDateFormat object from the specified Date object using the specified time zone.
valueOf(long) - Static method in class org.restlet.util.InternetDateFormat
Creates a new InternetDateFormat object from the specified millisecond time value using the UTC (Z) time zone.
valueOf(long, TimeZone) - Static method in class org.restlet.util.InternetDateFormat
Creates a new InternetDateFormat object from the specified millisecond time value using the specified time zone.
valueOf(String) - Static method in class org.restlet.util.InternetDateFormat
Creates a new InternetDateFormat object by parsing an RFC 3339 date/time string.
values() - Static method in enum org.restlet.data.Dimension
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in class org.restlet.util.WrapperMap
Returns a collection view of the values contained in this map.
Variable - Class in org.restlet.util
Variable descriptor for reference templates.
Variable() - Constructor for class org.restlet.util.Variable
Default constructor.
Variable(int) - Constructor for class org.restlet.util.Variable
Constructor.
Variable(int, String, boolean, boolean) - Constructor for class org.restlet.util.Variable
Constructor.
Variable(int, String, boolean, boolean, boolean, boolean) - Constructor for class org.restlet.util.Variable
Constructor.
Variant - Class in org.restlet.resource
Descriptor for available representations of a resource.
Variant() - Constructor for class org.restlet.resource.Variant
Default constructor.
Variant(MediaType) - Constructor for class org.restlet.resource.Variant
Constructor.
VELOCITY - Static variable in class org.restlet.data.Encoding
The Velocity encoding.
VERSION - Static variable in class org.restlet.util.Engine
Complete version.
VIDEO_ALL - Static variable in class org.restlet.data.MediaType
 
VIDEO_AVI - Static variable in class org.restlet.data.MediaType
 
VIDEO_MP4 - Static variable in class org.restlet.data.MediaType
 
VIDEO_MPEG - Static variable in class org.restlet.data.MediaType
 
VIDEO_QUICKTIME - Static variable in class org.restlet.data.MediaType
 
VIDEO_WMV - Static variable in class org.restlet.data.MediaType
 
VirtualHost - Class in org.restlet
Router of calls from Server connectors to Restlets.
VirtualHost() - Constructor for class org.restlet.VirtualHost
Constructor.
VirtualHost(Context) - Constructor for class org.restlet.VirtualHost
Constructor.
VirtualHost(Context, String, String, String, String, String, String, String, String) - Constructor for class org.restlet.VirtualHost
Constructor.

W

WAR - Static variable in class org.restlet.data.Protocol
Local Web Archive access protocol.
WINDOWS_1252 - Static variable in class org.restlet.data.CharacterSet
The Windows-1252 ('ANSI') character set.
wrap(ExecutorService) - Static method in class org.restlet.service.TaskService
Wraps a JDK executor service to ensure that the threads executing the tasks will have the thread local variables copied from the calling thread.
WrapperList<E> - Class in org.restlet.util
List wrapper.
WrapperList() - Constructor for class org.restlet.util.WrapperList
Constructor.
WrapperList(int) - Constructor for class org.restlet.util.WrapperList
Constructor.
WrapperList(List<E>) - Constructor for class org.restlet.util.WrapperList
Constructor.
WrapperMap<K,V> - Class in org.restlet.util
Map wrapper.
WrapperMap() - Constructor for class org.restlet.util.WrapperMap
Constructor.
WrapperMap(Map<K, V>) - Constructor for class org.restlet.util.WrapperMap
Constructor.
WrapperRepresentation - Class in org.restlet.util
Representation wrapper.
WrapperRepresentation(Representation) - Constructor for class org.restlet.util.WrapperRepresentation
Constructor.
WrapperRequest - Class in org.restlet.util
Request wrapper.
WrapperRequest(Request) - Constructor for class org.restlet.util.WrapperRequest
Constructor.
WrapperResponse - Class in org.restlet.util
Request wrapper.
WrapperResponse(Response) - Constructor for class org.restlet.util.WrapperResponse
Constructor.
WrapperRestlet - Class in org.restlet.util
Restlet wrapper.
WrapperRestlet(Restlet) - Constructor for class org.restlet.util.WrapperRestlet
Constructor.
WritableRepresentation - Class in org.restlet.resource
Representation based on a writable NIO byte channel.
WritableRepresentation(MediaType) - Constructor for class org.restlet.resource.WritableRepresentation
Constructor.
write(OutputStream) - Method in class org.restlet.resource.ChannelRepresentation
 
write(Writer) - Method in class org.restlet.resource.ChannelRepresentation
 
write(OutputStream) - Method in class org.restlet.resource.CharacterRepresentation
 
write(WritableByteChannel) - Method in class org.restlet.resource.CharacterRepresentation
 
write(OutputStream) - Method in class org.restlet.resource.DigestRepresentation
Writes the representation to a byte stream.
write(WritableByteChannel) - Method in class org.restlet.resource.DigestRepresentation
 
write(Writer) - Method in class org.restlet.resource.DigestRepresentation
 
write(OutputStream) - Method in class org.restlet.resource.DomRepresentation
 
write(OutputStream) - Method in class org.restlet.resource.FileRepresentation
 
write(WritableByteChannel) - Method in class org.restlet.resource.FileRepresentation
Writes the representation to a byte channel.
write(Writer) - Method in class org.restlet.resource.FileRepresentation
 
write(OutputStream) - Method in class org.restlet.resource.InputRepresentation
 
write(OutputStream) - Method in class org.restlet.resource.ObjectRepresentation
 
write(WritableByteChannel) - Method in class org.restlet.resource.ReadableRepresentation
 
write(Writer) - Method in class org.restlet.resource.ReaderRepresentation
 
write(OutputStream) - Method in class org.restlet.resource.Representation
Writes the representation to a byte stream.
write(WritableByteChannel) - Method in class org.restlet.resource.Representation
Writes the representation to a byte channel.
write(Writer) - Method in class org.restlet.resource.Representation
Writes the representation to a characters writer.
write(OutputStream) - Method in class org.restlet.resource.SaxRepresentation
 
write(XmlWriter) - Method in class org.restlet.resource.SaxRepresentation
Writes the representation to a XML writer.
write(WritableByteChannel) - Method in class org.restlet.resource.StreamRepresentation
 
write(Writer) - Method in class org.restlet.resource.StreamRepresentation
 
write(OutputStream) - Method in class org.restlet.resource.StringRepresentation
 
write(OutputStream) - Method in class org.restlet.resource.TransformRepresentation
 
write(WritableByteChannel) - Method in class org.restlet.resource.WritableRepresentation
 
write(OutputStream) - Method in class org.restlet.resource.WriterRepresentation
 
write(FileChannel, WritableByteChannel) - Static method in class org.restlet.util.ByteUtils
Writes the representation to a byte channel.
write(InputStream, OutputStream) - Static method in class org.restlet.util.ByteUtils
Writes an input stream to an output stream.
write(InputStream, RandomAccessFile) - Static method in class org.restlet.util.ByteUtils
Writes an input stream to a random access file.
write(ReadableByteChannel, WritableByteChannel) - Static method in class org.restlet.util.ByteUtils
Writes a readable channel to a writable channel.
write(Reader, Writer) - Static method in class org.restlet.util.ByteUtils
Writes characters from a reader to a writer.
write(OutputStream) - Method in class org.restlet.util.WrapperRepresentation
 
write(WritableByteChannel) - Method in class org.restlet.util.WrapperRepresentation
 
write(Writer) - Method in class org.restlet.util.WrapperRepresentation
 
WriterRepresentation - Class in org.restlet.resource
Representation based on a BIO characters writer.
WriterRepresentation(MediaType) - Constructor for class org.restlet.resource.WriterRepresentation
Constructor.
WriterRepresentation(MediaType, long) - Constructor for class org.restlet.resource.WriterRepresentation
Constructor.

X

XmlRepresentation - Class in org.restlet.resource
Representation based on an XML document.
XmlRepresentation(MediaType) - Constructor for class org.restlet.resource.XmlRepresentation
Constructor.
XmlRepresentation(MediaType, long) - Constructor for class org.restlet.resource.XmlRepresentation
Constructor.
XmlWriter - Class in org.restlet.util
XML writer doing the opposite work of a SAX-based XML reader.
XmlWriter() - Constructor for class org.restlet.util.XmlWriter
Create a new XML writer.
XmlWriter(OutputStream) - Constructor for class org.restlet.util.XmlWriter
Constructor.
XmlWriter(OutputStream, Charset) - Constructor for class org.restlet.util.XmlWriter
Constructor.
XmlWriter(OutputStream, CharsetEncoder) - Constructor for class org.restlet.util.XmlWriter
Constructor.
XmlWriter(OutputStream, String) - Constructor for class org.restlet.util.XmlWriter
Constructor.
XmlWriter(Writer) - Constructor for class org.restlet.util.XmlWriter
Create a new XML writer.
XmlWriter(XMLReader) - Constructor for class org.restlet.util.XmlWriter
Create a new XML writer.
XmlWriter(XMLReader, Writer) - Constructor for class org.restlet.util.XmlWriter
Create a new XML writer.

Z

ZIP - Static variable in class org.restlet.data.Encoding
The Info-Zip encoding.

A B C D E F G H I J K L M N O P R S T U V W X Z

Copyright © 2005-2008 Noelios Technologies.