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.
add(String) - Method in class org.restlet.data.ReferenceList
Creates then adds a reference at the end of the list.
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.
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.
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.resource.Resource
Indicates if it is allowed to delete the resource.
allowGet() - Method in class org.restlet.resource.Resource
Indicates if it is allowed to get the variants.
allowPost() - Method in class org.restlet.resource.Resource
Indicates if it is allowed to post to the resource.
allowPut() - Method in class org.restlet.resource.Resource
Indicates if it is allowed to put to the resource.
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_ATOM_XML - Static variable in class org.restlet.data.MediaType
 
APPLICATION_CAB - 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_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_JSON - 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_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_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_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.
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.
AUDIO_ALL - 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.
authorize(Request) - Method in class org.restlet.Guard
Indicates if the request is authorized to pass through the Guard.

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
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, String) - Constructor for class org.restlet.data.ChallengeResponse
Constructor.
ChallengeResponse(ChallengeScheme, String, char[]) - 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.
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.
checkSecret(String, char[]) - Method in class org.restlet.Guard
Indicates if the secret is valid for the given identifier.
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.
Client - Class in org.restlet
Connector acting as a generic client.
Client(Context, List<Protocol>) - 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_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.
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.
COMPRESS - Static variable in class org.restlet.data.Encoding
The common Unix file compression.
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 providing 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.
ConverterService - Class in org.restlet.service
Service converting message entities into higher-level objects.
ConverterService() - Constructor for class org.restlet.service.ConverterService
 
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
Preferred constructor.
CookieSetting(int, String, String, String, String) - Constructor for class org.restlet.data.CookieSetting
Preferred 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.
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.
createClapReference(int, String) - Static method in class org.restlet.data.LocalReference
Constructor.
createContext(String) - Method in class org.restlet.util.Helper
Creates a new context.
createDirectoryResource(Directory, Request, Response) - Method in class org.restlet.util.Engine
Creates a directory resource.
createEntry(String, String) - Method in class org.restlet.data.Form
 
createEntry(String, String) - Method in class org.restlet.util.Series
Creates a new entry.
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.
createHelper(Application, Context) - Method in class org.restlet.util.Engine
Creates a new helper for a given component.
createHelper(Client) - 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) - 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.
createResource(Request, Response) - Method in class org.restlet.Finder
Creates a new instance of the resource class designated by the "targetClass" property.
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.
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(boolean) - Constructor for class org.restlet.service.DecoderService
Constructor.
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
Asks the resource to delete itself and all its representations.
delete(String) - Method in class org.restlet.Uniform
Deletes the identified resource.
delete(Reference) - Method in class org.restlet.Uniform
Deletes the identified resource.
detach(Restlet) - Method in class org.restlet.Router
Detaches the target from this router.
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, LocalReference) - 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) - Method in class org.restlet.data.Parameter
Encodes the parameter using the standard URI encoding mechanism.
encode(Appendable, CharacterSet) - Method in class org.restlet.data.Parameter
Encodes the parameter and appends the result to the given buffer.
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.
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.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.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.
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
Local file system access protocol.
FileRepresentation - Class in org.restlet.resource
Representation based on a file.
FileRepresentation(File, MediaType, int) - Constructor for class org.restlet.resource.FileRepresentation
Constructor.
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 resource that will concretely handle a call.
Finder() - Constructor for class org.restlet.Finder
Constructor.
Finder(Context) - Constructor for class org.restlet.Finder
Constructor.
Finder(Context, Class<? extends Resource>) - 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 Resource if available.
findTarget(Request, Response) - Method in class org.restlet.Finder
Finds the target Resource if available.
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
Constructor.
Form(Logger, String, CharacterSet) - Constructor for class org.restlet.data.Form
Constructor.
Form(Representation) - Constructor for class org.restlet.data.Form
Constructor.
Form(String) - Constructor for class org.restlet.data.Form
Constructor.
Form(String, CharacterSet) - 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(Request, Response) - Method in class org.restlet.util.Template
Creates a formatted string based on the given request.
format(Map<String, Object>) - Method in class org.restlet.util.Template
Creates a formatted string based on the given request.
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).
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
FILE is a standard scheme to access to representations stored in the file system (locally most of the time).

G

generateRef(String) - Method in class org.restlet.resource.Resource
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(String) - Method in class org.restlet.Uniform
Gets the identified resource.
get(Reference) - 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 character set preferences.
getAcceptedEncodings() - Method in class org.restlet.data.ClientInfo
Returns the encoding preferences.
getAcceptedLanguages() - Method in class org.restlet.data.ClientInfo
Returns the language preferences.
getAcceptedMediaTypes() - Method in class org.restlet.data.ClientInfo
Returns the media type preferences.
getAddress() - Method in class org.restlet.data.ClientInfo
Returns the client's IP address.
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 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).
getAgent() - Method in class org.restlet.data.ClientInfo
Returns the agent name (ex: "Noelios Restlet Engine/1.0").
getAgent() - Method in class org.restlet.data.ServerInfo
Returns the agent name (ex: "Noelios Restlet Engine/1.0").
getAllowedMethods() - Method in class org.restlet.data.Response
Returns the set of methods allowed on the requested resource.
getAllowedMethods() - Method in class org.restlet.util.WrapperResponse
Returns the set of methods allowed on the requested resource.
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 a modifiable attributes map that can be used by developers to save information relative to the message.
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.
getAuthorityName(int) - Static method in class org.restlet.data.LocalReference
Returns an authority name.
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.
getChallengeRequest() - Method in class org.restlet.data.Response
Returns the authentication request sent by an origin server to a client.
getChallengeRequest() - Method in class org.restlet.util.WrapperResponse
Returns the authentication request 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.FileRepresentation
Returns a readable byte channel.
getChannel() - Method in class org.restlet.resource.ReadableRepresentation
Returns a readable byte channel.
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
Returns a readable byte channel.
getChannel() - Method in class org.restlet.resource.WritableRepresentation
Returns a readable byte channel.
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
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.
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
Returns the character set or null if not applicable.
getCharacterSetAttribute() - 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 a class loader to use when creating instantiating implementation classes.
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 list of required client protocols.
getClients() - Method in class org.restlet.Component
Returns the 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.
getConditions() - Method in class org.restlet.data.Request
Returns the conditions applying to this call.
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.
getContactEmail() - Method in class org.restlet.service.StatusService
Returns the email address to contact in case of error.
getContext() - Method in class org.restlet.resource.Resource
Returns the context.
getContext() - Method in class org.restlet.Restlet
Returns the context.
getContext() - Method in class org.restlet.util.ServerList
Returns the context.
getConverterService() - Method in class org.restlet.Application
Returns the converter service.
getCookies() - Method in class org.restlet.data.Request
Returns the 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 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.
getCustom(Request, Response) - Method in class org.restlet.Router
Returns the matched route according to a custom algorithm.
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.
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.
getDimensions() - Method in class org.restlet.data.Response
Returns the 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
Returns a request dispatcher to available client connectors.
getDocument() - Method in class org.restlet.resource.DomRepresentation
Returns the wrapped DOM document.
getDomain() - Method in class org.restlet.data.Cookie
Returns the domain name.
getEncodingAttribute() - 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 list of encodings applied to the entity-body.
getEncodings() - Method in class org.restlet.util.WrapperRepresentation
Returns the list of encodings.
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.
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.
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.
Note that this triggers the parsing of the entity.
This method and the related getEntity*() methods can only be invoked once.
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
Returns the entity as a higher-level object.
getEntityAsObject() - Method in class org.restlet.util.WrapperRequest
Returns the entity as a higher-level object.
getEntityAsObject() - Method in class org.restlet.util.WrapperResponse
Returns the entity as a higher-level object.
getEntityAsSax() - Method in class org.restlet.data.Message
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.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.
getExpirationDate() - Method in class org.restlet.resource.Variant
Returns the future date when this representation expire.
getExpirationDate() - Method in class org.restlet.util.WrapperRepresentation
Returns the future date when this representation expire.
getExtension(Metadata) - Method in class org.restlet.service.MetadataService
Returns the first extension mapping to this metadata.
getFile() - Method in class org.restlet.data.LocalReference
Gets the local file corresponding to the reference.
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.
getHierarchicalPart() - Method in class org.restlet.data.Reference
Returns the hierarchical part which is equivalent to the scheme specific part less the query component.
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() - 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.
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 host routers.
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.
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
Returns the official identifier.
getIndentStep() - Method in class org.restlet.util.XmlWriter
Return the current indent step.
getIndexName() - Method in class org.restlet.Directory
Returns the index name, without extensions.