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(Reference, Reference, Literal) - Method in class org.restlet.data.LinkSet

Creates then adds a link.

add(Reference, Reference, Reference) - Method in class org.restlet.data.LinkSet

Creates then adds a link.

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 - Static variable in class org.restlet.data.MediaType

APPLICATION_ATOM_SERVICE_XML - Static variable in class org.restlet.data.MediaType

Deprecated. Use MediaType.APPLICATION_ATOMPUB_SERVICE instead.

APPLICATION_ATOM_XML - Static variable in class org.restlet.data.MediaType

Deprecated. Use MediaType.APPLICATION_ATOMPUB_SERVICE instead.

APPLICATION_ATOMPUB_CATEGORY - Static variable in class org.restlet.data.MediaType

APPLICATION_ATOMPUB_SERVICE - 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_KML - Static variable in class org.restlet.data.MediaType

APPLICATION_KMZ - 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 - Static variable in class org.restlet.data.MediaType

APPLICATION_MATHML_XML - Static variable in class org.restlet.data.MediaType

Deprecated. Use MediaType.APPLICATION_MATHML instead.

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_TRIG - Static variable in class org.restlet.data.MediaType

APPLICATION_RDF_TRIX - Static variable in class org.restlet.data.MediaType

APPLICATION_RDF_TURTLE - 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 - Static variable in class org.restlet.data.MediaType

APPLICATION_RSS_XML - Static variable in class org.restlet.data.MediaType

Deprecated. Use MediaType.APPLICATION_RSS instead.

APPLICATION_RTF - Static variable in class org.restlet.data.MediaType

APPLICATION_SPARQL_RESULTS_JSON - Static variable in class org.restlet.data.MediaType

APPLICATION_SPARQL_RESULTS_XML - 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 - Static variable in class org.restlet.data.MediaType

APPLICATION_W3C_SCHEMA_XML - Static variable in class org.restlet.data.MediaType

Deprecated. Use MediaType.APPLICATION_W3C_SCHEMA instead.

APPLICATION_W3C_XSLT - Static variable in class org.restlet.data.MediaType

APPLICATION_WADL - Static variable in class org.restlet.data.MediaType

APPLICATION_WADL_XML - Static variable in class org.restlet.data.MediaType

Deprecated. Use MediaType.APPLICATION_WADL instead.

APPLICATION_WORD - Static variable in class org.restlet.data.MediaType

APPLICATION_WWW_FORM - Static variable in class org.restlet.data.MediaType

APPLICATION_XHTML - Static variable in class org.restlet.data.MediaType

APPLICATION_XHTML_XML - Static variable in class org.restlet.data.MediaType

Deprecated. Use MediaType.APPLICATION_XHTML instead.

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, 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(Charset) - Constructor for class org.restlet.data.CharacterSet

Constructor.

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.
If case the given algorithm is the same than the one provided at instantiation, the check operation is made with the current stored computed value and does not require to exhaust entirely the representation's stream.

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.

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.
If case the given algorithm is the same than the one provided at instantiation, the computation operation is made with the current stored computed value and does not require to exhaust entirely the representation's stream.

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.

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.

createBlankReference(String) - Static method in class org.restlet.data.LinkReference

Creates a reference to a blank node.

createChildContext() - Method in class org.restlet.Context

Creates a protected child context.

createClapReference(int, String) - Static method in class org.restlet.data.LocalReference

Constructor.

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).

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 - Static variable in class org.restlet.data.CharacterSet

The default character set of the JVM.

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(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.Link

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.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(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(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