- CacheDirective - Class in org.restlet.data
-
Directive for caching mechanisms along the call chain.
- CacheDirective(String) - Constructor for class org.restlet.data.CacheDirective
-
Constructor for directives with no value.
- CacheDirective(String, String) - Constructor for class org.restlet.data.CacheDirective
-
Constructor for directives with a value.
- CacheDirective(String, String, boolean) - Constructor for class org.restlet.data.CacheDirective
-
Constructor for directives with a value.
- canEncode(Representation) - Method in class org.restlet.service.EncoderService
-
Indicates if a representation can be encoded.
- CertificateAuthenticator - Class in org.restlet.security
-
Authenticator based on the SSL client certificate.
- CertificateAuthenticator(Context) - Constructor for class org.restlet.security.CertificateAuthenticator
-
- challenge(Response, boolean) - Method in class org.restlet.security.ChallengeAuthenticator
-
- ChallengeAuthenticator - Class in org.restlet.security
-
Authenticator based on a challenge scheme.
- ChallengeAuthenticator(Context, boolean, ChallengeScheme, String) - Constructor for class org.restlet.security.ChallengeAuthenticator
-
Constructor using the context's default verifier.
- ChallengeAuthenticator(Context, boolean, ChallengeScheme, String, Verifier) - Constructor for class org.restlet.security.ChallengeAuthenticator
-
Constructor.
- ChallengeAuthenticator(Context, ChallengeScheme, String) - Constructor for class org.restlet.security.ChallengeAuthenticator
-
Constructor setting the optional property to false.
- ChallengeMessage - Class in org.restlet.data
-
Base authentication challenge message exchanged between an origin server and
a client.
- ChallengeMessage(ChallengeScheme) - Constructor for class org.restlet.data.ChallengeMessage
-
Constructor.
- ChallengeMessage(ChallengeScheme, Series<Parameter>) - Constructor for class org.restlet.data.ChallengeMessage
-
Constructor.
- ChallengeMessage(ChallengeScheme, String) - Constructor for class org.restlet.data.ChallengeMessage
-
Constructor.
- ChallengeMessage(ChallengeScheme, String, Series<Parameter>) - Constructor for class org.restlet.data.ChallengeMessage
-
Constructor.
- ChallengeMessage(ChallengeScheme, String, Series<Parameter>, String, String, String) - Constructor for class org.restlet.data.ChallengeMessage
-
Constructor.
- ChallengeRequest - Class in org.restlet.data
-
Authentication challenge sent by an origin server to a client.
- ChallengeRequest(ChallengeScheme) - Constructor for class org.restlet.data.ChallengeRequest
-
Constructor.
- 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(ChallengeRequest, Response, String, char[]) - Constructor for class org.restlet.data.ChallengeResponse
-
Constructor.
- ChallengeResponse(ChallengeRequest, Response, String, char[], String) - Constructor for class org.restlet.data.ChallengeResponse
-
Constructor.
- ChallengeResponse(ChallengeRequest, Response, String, String) - Constructor for class org.restlet.data.ChallengeResponse
-
Constructor.
- ChallengeResponse(ChallengeScheme) - Constructor for class org.restlet.data.ChallengeResponse
-
Constructor with no credentials.
- ChallengeResponse(ChallengeScheme, Series<Parameter>, String, char[], String, String, String, Reference, String, String, String, String, int, long) - Constructor for class org.restlet.data.ChallengeResponse
-
Constructor.
- ChallengeResponse(ChallengeScheme, String, char[]) - Constructor for class org.restlet.data.ChallengeResponse
-
Constructor.
- ChallengeResponse(ChallengeScheme, String, char[], Series<Parameter>) - 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.representation
-
Representation based on a NIO byte channel.
- ChannelRepresentation(MediaType) - Constructor for class org.restlet.representation.ChannelRepresentation
-
Constructor.
- CharacterReadingListener - Class in org.restlet.util
-
Selection listener notifying new content as a Reader
.
- CharacterReadingListener(Representation) - Constructor for class org.restlet.util.CharacterReadingListener
-
Default constructor.
- CharacterReadingListener(Representation, int) - Constructor for class org.restlet.util.CharacterReadingListener
-
Constructor.
- CharacterRepresentation - Class in org.restlet.representation
-
Representation based on a BIO character stream.
- CharacterRepresentation(MediaType) - Constructor for class org.restlet.representation.CharacterRepresentation
-
Constructor.
- CharacterSet - Class in org.restlet.data
-
Metadata used to specify the character set of 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.
- checkContext(Restlet) - Method in class org.restlet.routing.VirtualHost
-
Checks the context and sets it if necessary.
- checkDigest() - Method in class org.restlet.representation.DigesterRepresentation
-
Check that the digest computed from the representation content and the
digest declared by the representation are the same.
- checkDigest(String) - Method in class org.restlet.representation.DigesterRepresentation
-
Check that the digest computed from the representation content and the
digest declared by the representation are the same.
- 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_DEFAULT - 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.SelectionRegistration
-
Clears the registration.
- 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 behavior 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_TOO_MANY_REQUESTS - Static variable in class org.restlet.data.Status
-
The server refuses to accept the request because the user has sent too
many requests in a given amount of time.
- 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.
- ClientInfo(List<? extends Variant>) - Constructor for class org.restlet.data.ClientInfo
-
Constructor from a list of variants.
- ClientInfo(MediaType) - Constructor for class org.restlet.data.ClientInfo
-
Constructor from a media type.
- ClientList - Class in org.restlet.util
-
Modifiable list of client connectors.
- ClientList(Context) - Constructor for class org.restlet.util.ClientList
-
Constructor.
- ClientProxy - Interface in org.restlet.resource
-
Marker interface for RESTful resource proxies.
- ClientResource - Class in org.restlet.resource
-
Client-side resource.
- ClientResource() - Constructor for class org.restlet.resource.ClientResource
-
Empty constructor.
- ClientResource(ClientResource) - Constructor for class org.restlet.resource.ClientResource
-
Constructor.
- ClientResource(Context, URI) - Constructor for class org.restlet.resource.ClientResource
-
Constructor.
- ClientResource(Context, Method, URI) - Constructor for class org.restlet.resource.ClientResource
-
Constructor.
- ClientResource(Context, Method, Reference) - Constructor for class org.restlet.resource.ClientResource
-
Constructor.
- ClientResource(Context, Method, String) - Constructor for class org.restlet.resource.ClientResource
-
Constructor.
- ClientResource(Context, Reference) - Constructor for class org.restlet.resource.ClientResource
-
Constructor.
- ClientResource(Context, Request) - Constructor for class org.restlet.resource.ClientResource
-
Constructor.
- ClientResource(Context, Request, Response) - Constructor for class org.restlet.resource.ClientResource
-
Constructor.
- ClientResource(Context, String) - Constructor for class org.restlet.resource.ClientResource
-
Constructor.
- ClientResource(URI) - Constructor for class org.restlet.resource.ClientResource
-
Constructor.
- ClientResource(Method, URI) - Constructor for class org.restlet.resource.ClientResource
-
Constructor.
- ClientResource(Method, Reference) - Constructor for class org.restlet.resource.ClientResource
-
Constructor.
- ClientResource(Method, String) - Constructor for class org.restlet.resource.ClientResource
-
Constructor.
- ClientResource(Reference) - Constructor for class org.restlet.resource.ClientResource
-
Constructor.
- ClientResource(Request) - Constructor for class org.restlet.resource.ClientResource
-
Constructor.
- ClientResource(Request, Response) - Constructor for class org.restlet.resource.ClientResource
-
Constructor.
- ClientResource(String) - Constructor for class org.restlet.resource.ClientResource
-
Constructor.
- clone() - Method in class org.restlet.data.Reference
-
- commit(Response) - Method in class org.restlet.Request
-
Asks the server connector to immediately commit the given response
associated to this request, making it ready to be sent back to the
client.
- commit() - Method in class org.restlet.resource.ServerResource
-
Asks the response to immediately commit making it ready to be sent back
to the client.
- commit() - Method in class org.restlet.Response
-
Asks the server connector to immediately commit the given response,
making it ready to be sent back to the client.
- commit(Response) - Method in class org.restlet.util.WrapperRequest
-
- commit() - Method in class org.restlet.util.WrapperResponse
-
- compare(char[], char[]) - Static method in class org.restlet.security.SecretVerifier
-
Compares that two secrets are equal and not null.
- compareTo(Method) - Method in class org.restlet.data.Method
-
Compares this method to another.
- compareTo(Parameter) - Method in class org.restlet.data.Parameter
-
- Component - Class in org.restlet
-
- Component() - Constructor for class org.restlet.Component
-
Constructor.
- Component(Reference) - Constructor for class org.restlet.Component
-
- Component(Representation) - Constructor for class org.restlet.Component
-
- Component(String) - Constructor for class org.restlet.Component
-
- COMPRESS - Static variable in class org.restlet.data.Encoding
-
The common Unix file compression.
- computeDigest() - Method in class org.restlet.representation.DigesterRepresentation
-
Compute the representation digest according to MD5 algorithm.
- computeDigest(String) - Method in class org.restlet.representation.DigesterRepresentation
-
Compute the representation digest according to the given algorithm.
- Conditions - Class in org.restlet.data
-
Set of conditions applying to a request.
- Conditions() - Constructor for class org.restlet.data.Conditions
-
Constructor.
- ConfidentialAuthorizer - Class in org.restlet.security
-
Authorizer allowing only confidential calls.
- ConfidentialAuthorizer() - Constructor for class org.restlet.security.ConfidentialAuthorizer
-
- 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
-
The client connector faced an error during the communication with the
remote server (interruption, timeout, etc.).
- CONNECTOR_ERROR_CONNECTION - Static variable in class org.restlet.data.Status
-
The client connector could not connect to the remote server.
- CONNECTOR_ERROR_INTERNAL - Static variable in class org.restlet.data.Status
-
The client connector faced an internal error during the process of a
request to its server or the process of a response to its client.
- ConnectorService - Class in org.restlet.service
-
Application service declaring client and server connectors.
- ConnectorService() - Constructor for class org.restlet.service.ConnectorService
-
Constructor.
- ConnegService - Class in org.restlet.service
-
Application service negotiating the preferred resource variants.
- ConnegService() - Constructor for class org.restlet.service.ConnegService
-
Constructor.
- ConnegService(boolean) - Constructor for class org.restlet.service.ConnegService
-
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 set of Restlets.
- 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.routing.Filter
-
Indicates that the request processing should continue normally.
- continueResponse() - Static method in class org.restlet.data.Expectation
-
Creates a "100-continue" expectation.
- ConverterService - Class in org.restlet.service
-
Application service converting between representation and regular Java
objects.
- ConverterService() - Constructor for class org.restlet.service.ConverterService
-
Constructor.
- ConverterService(boolean) - Constructor for class org.restlet.service.ConverterService
-
Constructor.
- Cookie - Class in org.restlet.data
-
Cookie provided by a client.
- Cookie() - Constructor for class org.restlet.data.Cookie
-
Default 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.
- copyTo(Map<String, Object>) - Method in class org.restlet.util.Series
-
Copies the parameters whose name is a key in the given map.
- CorsService - Class in org.restlet.service
-
Application service that adds support of CORS.
- CorsService() - Constructor for class org.restlet.service.CorsService
-
Constructor.
- CorsService(boolean) - Constructor for class org.restlet.service.CorsService
-
Constructor.
- create(CharSequence, CharSequence) - Static method in class org.restlet.data.Parameter
-
Creates a parameter.
- create(Context, Reference, Class<? extends T>) - Static method in class org.restlet.resource.ClientResource
-
Creates a client resource that proxy calls to the given Java interface
into Restlet method calls.
- create(Reference, Class<? extends T>) - Static method in class org.restlet.resource.ClientResource
-
Creates a client resource that proxy calls to the given Java interface
into Restlet method calls.
- create(String, Class<? extends T>) - Static method in class org.restlet.resource.ClientResource
-
Creates a client resource that proxy calls to the given Java interface
into Restlet method calls.
- create(Class<? extends ServerResource>, Request, Response) - Method in class org.restlet.resource.Finder
-
- create(Request, Response) - Method in class org.restlet.resource.Finder
-
Creates a new instance of the
ServerResource
subclass designated
by the "targetClass" property.
- createChallengeRequest(boolean) - Method in class org.restlet.security.ChallengeAuthenticator
-
Creates a new challenge request.
- createChildContext() - Method in class org.restlet.Context
-
Creates a protected child context.
- createClapReference(Package) - Static method in class org.restlet.data.LocalReference
-
Constructor.
- createClapReference(int, Package) - Static method in class org.restlet.data.LocalReference
-
Constructor for CLAP URIs to a given package.
- createClapReference(String) - Static method in class org.restlet.data.LocalReference
-
Constructor.
- createClapReference(int, String) - Static method in class org.restlet.data.LocalReference
-
Constructor.
- createClientInfo() - Method in class org.restlet.representation.Variant
-
Creates a
ClientInfo
instance with preferences matching exactly
the current variant.
- 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(int) - 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 ServerResource>, Class<? extends Finder>, Context, Logger) - Static method in class org.restlet.resource.Finder
-
Creates a new finder instance based on the "targetClass" property.
- createFinder(Class<? extends ServerResource>) - Method in class org.restlet.Restlet
-
Creates a new finder instance based on the "targetClass" property.
- createFinder(Class<? extends ServerResource>) - Method in class org.restlet.routing.VirtualHost
-
Creates a new finder instance based on the "targetClass" property.
- createInboundFilter(Context) - Method in class org.restlet.service.CorsService
-
- createInboundFilter(Context) - Method in class org.restlet.service.DecoderService
-
- createInboundFilter(Context) - Method in class org.restlet.service.EncoderService
-
- createInboundFilter(Context) - Method in class org.restlet.service.LogService
-
- createInboundFilter(Context) - Method in class org.restlet.service.RangeService
-
- createInboundFilter(Context) - Method in class org.restlet.service.Service
-
Create the filter that should be invoked for incoming calls.
- createInboundFilter(Context) - Method in class org.restlet.service.StatusService
-
- createInboundFilter(Context) - Method in class org.restlet.service.TunnelService
-
- createInboundRoot() - Method in class org.restlet.Application
-
Creates a inbound root Restlet that will receive all incoming calls.
- createJarReference(Reference, String) - Static method in class org.restlet.data.LocalReference
-
Constructor.
- createNext() - Method in class org.restlet.resource.ClientResource
-
Creates a next Restlet is no one is set.
- createOutboundFilter(Context) - Method in class org.restlet.service.DecoderService
-
- createOutboundFilter(Context) - Method in class org.restlet.service.EncoderService
-
- createOutboundFilter(Context) - Method in class org.restlet.service.Service
-
Create the filter that should be invoked for outgoing calls.
- createOutboundRoot() - Method in class org.restlet.Application
-
Creates a outbound root Restlet that will receive all outgoing calls from
ClientResource.
- createPatch(Representation, Representation) - Method in class org.restlet.service.ConverterService
-
Creates a patch representation by calculating a diff between initial and
modified representations.
- createRequest() - Method in class org.restlet.resource.ClientResource
-
Creates a new request by cloning the one wrapped by this class.
- 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).
- createResponse(Request) - Method in class org.restlet.resource.ClientResource
-
Creates a new response for the given request.
- createRiapReference(int, String) - Static method in class org.restlet.data.LocalReference
-
Constructor.
- createRoute(String, Restlet) - Method in class org.restlet.routing.Router
-
Creates a new route for the given URI pattern and target.
- createRoute(String, Restlet, int) - Method in class org.restlet.routing.Router
-
Creates a new route for the given URI pattern, target and matching mode.
- createRoute(String, Restlet, int) - Method in class org.restlet.routing.VirtualHost
-
- 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.
- createUser(String, Request, Response) - Method in class org.restlet.security.SecretVerifier
-
Called back to create a new user when valid credentials are provided.
- createZipReference(Reference, String) - Static method in class org.restlet.data.LocalReference
-
Constructor.
- CUSTOM - Static variable in class org.restlet.data.ChallengeScheme
-
Custom scheme based on IP address or cookies or query parameters, etc.
- 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() - Method in class org.restlet.resource.ClientResource
-
Represents the resource using content negotiation to select the best
variant based on the client preferences.
- get(Class<T>) - Method in class org.restlet.resource.ClientResource
-
Represents the resource in the given object class.
- get(MediaType) - Method in class org.restlet.resource.ClientResource
-
Represents the resource using a given media type.
- Get - Annotation Type in org.restlet.resource
-
Annotation for methods that retrieve a resource representation.
- get() - Method in class org.restlet.resource.ServerResource
-
Returns a full representation.
- get(Variant) - Method in class org.restlet.resource.ServerResource
-
Returns a full representation for a given variant.
- get(Application, String) - Static method in class org.restlet.security.Role
-
Finds an existing role or creates a new one if needed.
- get(Application, String, String) - Static method in class org.restlet.security.Role
-
Finds an existing role or creates a new one if needed.
- get(Class<T>) - Method in class org.restlet.util.ServiceList
-
Returns a service matching a given service class.
- get(int) - Method in class org.restlet.util.WrapperList
-
Returns the element at the specified position in this list.
- get(Object) - Method in class org.restlet.util.WrapperMap
-
Returns the value to which this map maps the specified key.
- getAcceptedCharacterSets() - Method in class org.restlet.data.ClientInfo
-
Returns the modifiable list of character set preferences.
- getAcceptedEncodings() - Method in class org.restlet.data.ClientInfo
-
Returns the modifiable list of encoding preferences.
- getAcceptedLanguages() - Method in class org.restlet.data.ClientInfo
-
Returns the modifiable list of language preferences.
- getAcceptedMediaTypes() - Method in class org.restlet.data.ClientInfo
-
Returns the modifiable list of media type preferences.
- getAcceptedMediaTypes() - Method in class org.restlet.service.EncoderService
-
Returns the media types that should be encoded.
- getAcceptedPatches() - Method in class org.restlet.data.ClientInfo
-
Returns the modifiable list of patch preferences.
- getAccessControlAllowCredentials() - Method in class org.restlet.Response
-
When used as part of a response to a preflight CORS request, this
indicates whether or not the actual request can be made using
credentials.
- getAccessControlAllowHeaders() - Method in class org.restlet.Response
-
Returns the modifiable set of headers allowed by the actual request on
the current resource when used as part of a response to a preflight CORS
request.
- getAccessControlAllowMethods() - Method in class org.restlet.Response
-
Returns the modifiable set of methods allowed by the actual request on
the current resource when used as part of a response to a preflight CORS
request
Note that when used with HTTP connectors, this property maps to the
"Access-Control-Allow-Methods" header.
- getAccessControlAllowOrigin() - Method in class org.restlet.Response
-
When used in the context of CORS support, it returns the URI an origin
server allows for the requested resource.
- getAccessControlExposeHeaders() - Method in class org.restlet.Response
-
Returns a modifiable whitelist of headers an origin server allows for the
requested resource.
- getAccessControlMaxAge() - Method in class org.restlet.Response
-
Indicates how long the results of a preflight CORS request can be cached in a preflight result cache.
- getAccessControlRequestHeaders() - Method in class org.restlet.Request
-
Returns the modifiable set of headers the client is willing to send in
future request to this resource.
- getAccessControlRequestHeaders() - Method in class org.restlet.util.WrapperRequest
-
Returns the access control request headers of the target resource.
- getAccessControlRequestMethod() - Method in class org.restlet.Request
-
Returns the method the client is willing to use in future request to this
resource.
- getAccessControlRequestMethod() - Method in class org.restlet.util.WrapperRequest
-
Returns the access control request method of the target resource.
- getActualPort() - Method in class org.restlet.Server
-
Returns the actual server port after it has started.
- getAddress() - Method in class org.restlet.data.ClientInfo
-
Returns the immediate 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).
- getAge() - Method in class org.restlet.Response
-
Returns the estimated amount of time since a response was generated or
revalidated by the origin server.
- getAge() - Method in class org.restlet.util.WrapperResponse
-
- getAgent() - Method in class org.restlet.data.ClientInfo
-
Returns the agent name (ex: "Restlet-Framework/2.0").
- getAgent() - Method in class org.restlet.data.ServerInfo
-
Returns the agent name (ex: "Restlet-Framework/2.0").
- getAgent() - Method in class org.restlet.data.Warning
-
Returns the agent.
- getAgentAttributes() - Method in class org.restlet.data.ClientInfo
-
Returns a list of attributes taken from the name of the user agent.
- getAgentName() - Method in class org.restlet.data.ClientInfo
-
Returns the name of the user agent.
- getAgentProducts() - Method in class org.restlet.data.ClientInfo
-
Returns the list of product tokens from the user agent name.
- getAgentVersion() - Method in class org.restlet.data.ClientInfo
-
Returns the version of the user agent.
- getAlgorithm() - Method in class org.restlet.data.Digest
-
Returns the digest algorithm.
- getAllCharacterSetExtensionNames() - Method in class org.restlet.service.MetadataService
-
Return the ordered list of extension names mapped to character set.
- getAllCharacterSets(String) - Method in class org.restlet.service.MetadataService
-
Returns all the character sets associated to this extension.
- getAllEncodingExtensionNames() - Method in class org.restlet.service.MetadataService
-
Return the ordered list of extension names mapped to encodings.
- getAllExtensionNames() - Method in class org.restlet.service.MetadataService
-
Return the ordered list of extension names.
- getAllLanguageExtensionNames() - Method in class org.restlet.service.MetadataService
-
Return the ordered list of extension names mapped to languages.
- getAllLanguages(String) - Method in class org.restlet.service.MetadataService
-
Returns all the languages associated to this extension.
- getAllMediaTypeExtensionNames() - Method in class org.restlet.service.MetadataService
-
Return the ordered list of extension names mapped to media types.
- getAllMediaTypes(String) - Method in class org.restlet.service.MetadataService
-
Returns all the media types associated to this extension.
- getAllMetadata(String) - Method in class org.restlet.service.MetadataService
-
Returns all the metadata associated to this extension.
- getAllowedHeaders() - Method in class org.restlet.service.CorsService
-
Returns the modifiable set of headers allowed by the actual request on
the current resource.
- getAllowedMethods() - Method in class org.restlet.resource.Resource
-
Returns the set of methods allowed for the current client by the
resource.
- getAllowedMethods() - Method in class org.restlet.Response
-
Returns the modifiable 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.
- getAllowedOrigins() - Method in class org.restlet.service.CorsService
-
Returns the URI an origin server allows for the requested resource.
- getAnnotation(Method) - Method in class org.restlet.resource.ServerResource
-
Returns the first annotation descriptor matching the given method.
- getAnnotation(Method, Form, Representation) - Method in class org.restlet.resource.ServerResource
-
Returns the first annotation descriptor matching the given method.
- getAnnotations() - Method in class org.restlet.resource.ServerResource
-
Returns the annotation descriptors.
- getAnonymousMethods() - Method in class org.restlet.security.MethodAuthorizer
-
Returns the modifiable list of methods authorized for anonymous users.
- getApplication() - Method in class org.restlet.resource.Resource
-
Returns the parent application.
- getApplication() - Method in class org.restlet.Restlet
-
Returns the parent application if it exists, or null.
- getApplication() - Method in class org.restlet.security.Role
-
Returns the parent application.
- getApplication() - Method in class org.restlet.util.WrapperRestlet
-
- getAttribute(String) - Method in class org.restlet.resource.ClientResource
-
Returns the attribute value by looking up the given name in the response
attributes maps.
- getAttribute(String) - Method in class org.restlet.resource.Resource
-
Returns the attribute value by looking up the given name in the request
or response attributes maps.
- getAttribute(String) - Method in class org.restlet.resource.ServerResource
-
Returns the attribute value by looking up the given name in the request
attributes maps.
- 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.Message
-
Returns the modifiable map of attributes that can be used by developers
to save information relative to the message.
- getAttributes() - Method in class org.restlet.util.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.
- getAuthenticatedMethods() - Method in class org.restlet.security.MethodAuthorizer
-
Returns the modifiable list of methods authorized for authenticated
users.
- getAuthenticationInfo() - Method in class org.restlet.Response
-
Returns information sent by an origin server related to an successful
authentication attempt.
- getAuthenticationInfo() - Method in class org.restlet.util.WrapperResponse
-
- getAuthor() - Method in class org.restlet.Restlet
-
Returns the author(s).
- getAuthor() - Method in class org.restlet.util.WrapperRestlet
-
- getAuthority() - Method in class org.restlet.data.Reference
-
Returns the authority component for hierarchical identifiers.
- getAuthority(boolean) - Method in class org.restlet.data.Reference
-
Returns the optionnally decoded authority component.
- getAuthorityName(int) - Static method in class org.restlet.data.LocalReference
-
Returns an authority name.
- getAuthorizedRoles() - Method in class org.restlet.security.RoleAuthorizer
-
Returns the modifiable list of authorized roles.
- getAvailableSize() - Method in class org.restlet.representation.BufferingRepresentation
-
- getAvailableSize() - Method in class org.restlet.representation.Representation
-
Returns the size effectively available.
- getAvailableSize() - Method in class org.restlet.util.WrapperRepresentation
-
- getBaseRef() - Method in class org.restlet.data.Reference
-
Returns the base reference for relative references.
- getBest(Request, Response, float) - Method in class org.restlet.util.RouteList
-
Returns the best route match for a given call.
- getBuffer() - Method in class org.restlet.representation.BufferingRepresentation
-
Returns the buffered content as an array of bytes.
- getCacheDirectives() - Method in class org.restlet.Message
-
Returns the cache directives.
- getCertificates() - Method in class org.restlet.data.ClientInfo
-
Returns the client certificates.
- getChallengeRequests() - Method in class org.restlet.resource.Resource
-
Returns the list of authentication requests sent by an origin server to a
client.
- getChallengeRequests() - Method in class org.restlet.Response
-
Returns the list of authentication requests sent by an origin server to a
client.
- getChallengeRequests() - Method in class org.restlet.util.WrapperResponse
-
Returns the list of authentication requests sent by an origin server to a
client.
- getChallengeResponse() - Method in class org.restlet.Request
-
Returns the authentication response sent by a client to an origin server.
- getChallengeResponse() - Method in class org.restlet.resource.Resource
-
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.representation.BufferingRepresentation
-
- getChannel() - Method in class org.restlet.representation.CharacterRepresentation
-
- getChannel() - Method in class org.restlet.representation.DigesterRepresentation
-
- getChannel() - Method in class org.restlet.representation.EmptyRepresentation
-
- getChannel() - Method in class org.restlet.representation.FileRepresentation
-
Returns a readable byte channel.
- getChannel() - Method in class org.restlet.representation.OutputRepresentation
-
- getChannel() - Method in class org.restlet.representation.ReadableRepresentation
-
- getChannel() - Method in class org.restlet.representation.Representation
-
Returns a channel with the representation's content.
- getChannel() - Method in class org.restlet.representation.StreamRepresentation
-
- getChannel() - Method in class org.restlet.representation.WritableRepresentation
-
- getChannel() - Method in class org.restlet.util.WrapperRepresentation
-
- getCharacterSet() - Method in class org.restlet.representation.Variant
-
Returns the character set or null if not applicable.
- getCharacterSet(String) - Method in class org.restlet.service.MetadataService
-
Returns the character set associated to this extension.
- getCharacterSet() - Method in class org.restlet.util.WrapperRepresentation
-
- getCharacterSetParameter() - Method in class org.restlet.service.TunnelService
-
Returns the character set parameter name.
- getChild(Reference) - Method in class org.restlet.resource.ClientResource
-
Returns the child resource defined by its URI relatively to the current
resource.
- getChild(Reference, Class<? extends T>) - Method in class org.restlet.resource.ClientResource
-
Wraps the child client resource to proxy calls to the given Java
interface into Restlet method calls.
- getChild(String) - Method in class org.restlet.resource.ClientResource
-
Returns the child resource defined by its URI relatively to the current
resource.
- getChild(String, Class<? extends T>) - Method in class org.restlet.resource.ClientResource
-
Wraps the child client resource to proxy calls to the given Java
interface into Restlet method calls.
- getChildRoles() - Method in class org.restlet.security.Role
-
Returns the modifiable list of child roles.
- getCipherSuite() - Method in class org.restlet.data.ClientInfo
-
Returns the SSL Cipher Suite, if available and accessible.
- getClapAuthorityType() - Method in class org.restlet.data.LocalReference
-
Returns the type of authority.
- getClientDispatcher() - Method in class org.restlet.Context
-
Returns a request dispatcher to available client connectors.
- getClientInfo() - Method in class org.restlet.Request
-
Returns the client-specific information.
- getClientInfo() - Method in class org.restlet.resource.Resource
-
Returns the client-specific information.
- getClientInfo() - Method in class org.restlet.util.WrapperRequest
-
Returns the client-specific information.
- getClientNonce() - Method in class org.restlet.data.AuthenticationInfo
-
Returns the client nonce.
- getClientNonce() - Method in class org.restlet.data.ChallengeResponse
-
Returns the client nonce.
- getClientProtocols() - Method in class org.restlet.service.ConnectorService
-
Returns the modifiable list of required client protocols.
- getClientResource() - Method in interface org.restlet.resource.ClientProxy
-
Returns the wrapped client resource.
- getClients() - Method in class org.restlet.Component
-
Returns a modifiable list of client connectors.
- getCode() - Method in class org.restlet.data.Status
-
Returns the corresponding code (HTTP or WebDAV or custom code).
- getComment() - Method in class org.restlet.data.CookieSetting
-
Returns the comment for the user.
- getComment() - Method in class org.restlet.data.Product
-
Returns the facultative comment.
- getComment() - Method in class org.restlet.data.RecipientInfo
-
Returns the optional comment, typically the software agent name.
- getComparator() - Method in class org.restlet.resource.Directory
-
Returns the reference comparator used to sort index pages.
- getComputedDigest() - Method in class org.restlet.representation.DigesterRepresentation
-
Returns the current computed digest value of the representation.
- getConditions() - Method in class org.restlet.Request
-
Returns the modifiable conditions applying to this request.
- getConditions() - Method in class org.restlet.resource.Resource
-
Returns the modifiable conditions applying to this request.
- getConditions() - Method in class org.restlet.util.WrapperRequest
-
Returns the conditions applying to this call.
- getConnectorService() - Method in class org.restlet.Application
-
Returns the connector service.
- getConnegService() - Method in class org.restlet.Application
-
Returns the content negotiation service.
- getConnegService() - Method in class org.restlet.resource.Resource
-
Returns the application's content negotiation service or create a new
one.
- getConnegService() - Method in class org.restlet.service.StatusService
-
Returns the service used to select the preferred variant.
- 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 current context.
- getContext() - Method in class org.restlet.Restlet
-
Returns the context.
- getContext() - Method in class org.restlet.service.Service
-
Returns the context.
- getContext() - Method in class org.restlet.util.ClientList
-
Returns the context.
- getContext() - Method in class org.restlet.util.ServerList
-
Returns the context.
- getContext() - Method in class org.restlet.util.ServiceList
-
Returns the context.
- getContext() - Method in class org.restlet.util.WrapperRestlet
-
- getConverterService() - Method in class org.restlet.Application
-
Returns the converter service.
- getConverterService() - Method in class org.restlet.resource.Resource
-
Returns the application's converter service or create a new one.
- getConverterService() - Method in class org.restlet.service.StatusService
-
Returns the service used to convert between status/throwable and
representation.
- getCookies() - Method in class org.restlet.Request
-
Returns the modifiable series of cookies provided by the client.
- getCookies() - Method in class org.restlet.resource.Resource
-
Returns the modifiable series of cookies provided by the client.
- getCookies() - Method in class org.restlet.util.WrapperRequest
-
Returns the cookies provided by the client.
- getCookieSettings() - Method in class org.restlet.resource.Resource
-
Returns the modifiable series of cookie settings provided by the server.
- getCookieSettings() - Method in class org.restlet.Response
-
Returns the modifiable series of cookie settings provided by the server.
- getCookieSettings() - Method in class org.restlet.util.WrapperResponse
-
Returns the cookie settings provided by the server.
- getCorePoolSize() - Method in class org.restlet.service.TaskService
-
Returns the core pool size defining the maximum number of threads.
- getCurrent() - Static method in class org.restlet.Application
-
This variable is stored internally as a thread local variable and updated
each time a call enters an application.
- getCurrent() - Static method in class org.restlet.Context
-
Returns the context associated to the current
Restlet
.
- getCurrent() - Static method in class org.restlet.Request
-
Returns the request associated to the current thread.
- getCurrent() - Static method in class org.restlet.Response
-
Returns the response associated to the current thread.
- getCurrent() - Static method in class org.restlet.routing.VirtualHost
-
Returns the virtual host code associated to the current thread.
- getCurrentLogger() - Static method in class org.restlet.Context
-
Returns the current context's logger.
- getCustom(Request, Response) - Method in class org.restlet.routing.Router
-
Returns the matched route according to a custom algorithm.
- getDate() - Method in class org.restlet.data.Warning
-
Returns the warning date.
- getDate() - Method in class org.restlet.Message
-
Returns the date and time at which the message was originated.
- getDecoderService() - Method in class org.restlet.Application
-
Returns the decoder service.
- getDefaultAcceptedMediaTypes() - Static method in class org.restlet.service.EncoderService
-
Returns the list of default encoded media types.
- getDefaultAllowedMethods() - Method in class org.restlet.service.CorsService
-
- getDefaultCharacterSet() - Method in class org.restlet.service.MetadataService
-
Returns the default character set for textual representations.
- getDefaultEncoding() - Method in class org.restlet.service.MetadataService
-
Returns the default encoding for representations.
- getDefaultEnroler() - Method in class org.restlet.Context
-
Returns an enroler that can add the user roles based on authenticated
user principals.
- getDefaultHost() - Method in class org.restlet.Component
-
Returns the default virtual host.
- getDefaultIgnoredMediaTypes() - Static method in class org.restlet.service.EncoderService
-
Returns the list of default ignored media types.
- getDefaultLanguage() - Method in class org.restlet.service.MetadataService
-
Returns the default language for representations.
- getDefaultMatchingMode() - Method in class org.restlet.routing.Router
-
Returns the default matching mode to use when selecting routes based on
URIs.
- getDefaultMatchingQuery() - Method in class org.restlet.routing.Router
-
Returns the default setting for whether the routing should be done on
URIs with or without taking into account query string.
- getDefaultMediaType() - Method in class org.restlet.service.MetadataService
-
Returns the default media type for representations.
- getDefaultPort() - Method in class org.restlet.data.Protocol
-
Returns the default port number.
- getDefaultResponseLogMessage(Response, int) - Method in class org.restlet.service.LogService
-
Format a log entry using the default IIS log format.
- getDefaultRoute() - Method in class org.restlet.routing.Router
-
Returns the default route to test if no other one was available after
retrying the maximum number of attempts.
- getDefaultValue() - Method in class org.restlet.routing.Variable
-
Returns the default value to use if the key couldn't be found in the
model.
- getDefaultVariable() - Method in class org.restlet.routing.Template
-
Returns the default variable.
- getDefaultVerifier() - Method in class org.restlet.Context
-
Returns a verifier that can check the validity of the credentials
associated to a request.
- 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.data.ChallengeScheme
-
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.Method
-
Returns the description.
- getDescription() - Method in class org.restlet.data.Protocol
-
Returns the description.
- getDescription() - Method in class org.restlet.data.Status
-
Returns the description.
- getDescription() - Method in class org.restlet.resource.ServerResource
-
Returns the description.
- getDescription() - Method in class org.restlet.Restlet
-
Returns the description.
- getDescription() - Method in class org.restlet.security.Group
-
Returns the description.
- getDescription() - Method in class org.restlet.security.Role
-
Returns the description.
- getDescription() - Method in class org.restlet.util.WrapperRestlet
-
- getDigest() - Method in class org.restlet.representation.Representation
-
Returns the representation digest if any.
- getDigest() - Method in class org.restlet.util.WrapperRepresentation
-
- getDigestAlgorithm() - Method in class org.restlet.data.ChallengeMessage
-
Returns the digest algorithm.
- getDigestRef() - Method in class org.restlet.data.ChallengeResponse
-
- getDimensions() - Method in class org.restlet.resource.Resource
-
Returns the modifiable set of selecting dimensions on which the response
entity may vary.
- getDimensions() - Method in class org.restlet.Response
-
Returns the modifiable set of selecting dimensions on which the response
entity may vary.
- getDimensions() - Method in class org.restlet.util.WrapperResponse
-
Returns the set of selecting dimensions on which the response entity may
vary.
- getDisposition() - Method in class org.restlet.representation.Representation
-
Returns the disposition characteristics of the representation.
- getDisposition() - Method in class org.restlet.util.WrapperRepresentation
-
- getDomain() - Method in class org.restlet.data.Cookie
-
Returns the domain name.
- getDomainRefs() - Method in class org.restlet.data.ChallengeRequest
-
Returns the base URI references that collectively define the protected
domains for the digest authentication.
- getEmail() - Method in class org.restlet.security.User
-
Returns the email.
- getEncoderService() - Method in class org.restlet.Application
-
Returns the encoder service.
- getEncoding(String) - Method in class org.restlet.service.MetadataService
-
Returns the encoding associated to this extension.
- getEncodingParameter() - Method in class org.restlet.service.TunnelService
-
Returns the name of the parameter containing the accepted encoding.
- getEncodings() - Method in class org.restlet.representation.Variant
-
Returns the modifiable list of encodings applied to the entity-body.
- getEncodings() - Method in class org.restlet.util.WrapperRepresentation
-
- getEnroler() - Method in class org.restlet.security.Authenticator
-
Returns the enroler invoked upon successful authentication to update the
subject with new principals.
- getEnroler() - Method in class org.restlet.security.Realm
-
Returns an enroler that can add the user roles based on user principals.
- getEntity() - Method in class org.restlet.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.
- getEntityAsText() - Method in class org.restlet.Message
-
Returns the entity as text.
- getEphemeralPort() - Method in class org.restlet.Server
-
Returns the actual ephemeral port used when the listening port is set to
'0'.
- getExecutorService() - Method in class org.restlet.Context
-
Returns the executor service.
- getExpectations() - Method in class org.restlet.data.ClientInfo
-
Returns the client expectations.
- getExpirationDate() - Method in class org.restlet.representation.Representation
-
Returns the future date when this representation expire.
- getExpirationDate() - Method in class org.restlet.util.WrapperRepresentation
-
- getExposedHeaders() - Method in class org.restlet.service.CorsService
-
Returns a modifiable whitelist of headers an origin server allows for the
requested resource.
- getExtension(Metadata) - Method in class org.restlet.service.MetadataService
-
Returns the first extension mapping to this metadata.
- getExtensions() - Method in class org.restlet.data.Reference
-
Returns the optional extensions for hierarchical identifiers.
- getExtensionsAsArray() - Method in class org.restlet.data.Reference
-
Returns the extensions as an array or null if no extension is found.
- getFile() - Method in class org.restlet.data.LocalReference
-
Gets the local file corresponding to the reference.
- getFile() - Method in class org.restlet.representation.FileRepresentation
-
Returns the file handle.
- getFilename() - Method in class org.restlet.data.Disposition
-
Returns the value of the "filename" parameter.
- getFinderClass() - Method in class org.restlet.Restlet
-
Returns the finder class used to instantiate resource classes.
- 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.
- getFirstName() - Method in class org.restlet.security.User
-
Returns the first 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.
- getForbiddenRoles() - Method in class org.restlet.security.RoleAuthorizer
-
Returns the modifiable list of forbidden roles.
- getForwardedAddresses() - Method in class org.restlet.data.ClientInfo
-
Returns the list of forwarded IP addresses.
- getFragment() - Method in class org.restlet.data.Reference
-
Returns the fragment identifier.
- getFragment(boolean) - Method in class org.restlet.data.Reference
-
Returns the optionnally decoded fragment identifier.
- getFrom() - Method in class org.restlet.data.ClientInfo
-
Returns the email address of the human user controlling the user agent.
- getHeaders() - Method in class org.restlet.Message
-
Returns the series of lower-level HTTP headers.
- getHierarchicalPart() - Method in class org.restlet.data.Reference
-
Returns the hierarchical part which is equivalent to the scheme specific
part less the query component.
- getHierarchicalPart(boolean) - Method in class org.restlet.data.Reference
-
Returns the optionnally decoded hierarchical part.
- getHomeRef() - Method in class org.restlet.service.StatusService
-
Returns the home URI to propose in case of error.
- getHostDomain() - Method in class org.restlet.data.Reference
-
Returns the host domain name component for server based hierarchical
identifiers.
- getHostDomain(boolean) - Method in class org.restlet.data.Reference
-
Returns the optionally decoded host domain name component.
- getHostDomain() - Method in class org.restlet.routing.VirtualHost
-
Returns the hostRef host domain to match.
- getHostIdentifier() - Method in class org.restlet.data.Reference
-
Returns the host identifier.
- getHostIdentifier(boolean) - Method in class org.restlet.data.Reference
-
Returns the optionnally decoded host identifier.
- getHostPort() - Method in class org.restlet.data.Reference
-
Returns the optional port number for server based hierarchical
identifiers.
- getHostPort() - Method in class org.restlet.routing.VirtualHost
-
Returns the hostRef host port to match.
- getHostRef() - Method in class org.restlet.Request
-
Returns the host reference.
- getHostRef() - Method in class org.restlet.resource.Resource
-
Returns the host reference.
- getHostRef() - Method in class org.restlet.util.WrapperRequest
-
Returns the host reference.
- getHosts() - Method in class org.restlet.Component
-
Returns the modifiable list of virtual hosts.
- getHostScheme() - Method in class org.restlet.routing.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(boolean) - Method in class org.restlet.data.Reference
-
Returns the optionnally decoded absolute resource identifier.
- getIdentifier() - Method in class org.restlet.data.ReferenceList
-
Returns the list identifier.
- getIdentifier() - Method in class org.restlet.security.Authorizer
-
Returns the identifier unique within an application.
- getIdentifier(Request, Response) - Method in class org.restlet.security.SecretVerifier
-
Returns the user identifier.
- getIdentifier() - Method in class org.restlet.security.User
-
Returns the identifier.
- getIgnoredMediaTypes() - Method in class org.restlet.service.EncoderService
-
Returns the media types that should be ignored.
- getInboundRoot() - Method in class org.restlet.Application
-
Returns the inbound root Restlet.
- getIndex() - Method in class org.restlet.data.Range
-
Returns the index from which to start the range.
- getIndexName() - Method in class org.restlet.resource.Directory
-
Returns the index name, without extensions.
- getIndexRepresentation(Variant, ReferenceList) - Method in class org.restlet.resource.Directory
-
Returns an actual index representation for a given variant.
- getIndexVariants(ReferenceList) - Method in class org.restlet.resource.Directory
-
Returns the variant representations of a directory index.
- getInfo() - Method in class org.restlet.resource.ServerResource
-
Returns information about the resource's representation.
- getInfo(Variant) - Method in class org.restlet.resource.ServerResource
-
Returns information about the resource's representation.
- getInstanceSize() - Method in class org.restlet.data.Range
-
Returns the total size of the instance in number of bytes (or range unit).
- getInterestOperations() - Method in class org.restlet.util.SelectionRegistration
-
Returns the IO operations interest.
- getInternalRouter() - Method in class org.restlet.Component
-
Returns the private internal router where Restlets like Applications can
be attached.
- getIpAddress(String) - Static method in class org.restlet.routing.VirtualHost
-
Returns the IP address of a given domain name.
- getJarEntryPath() - Method in class org.restlet.data.LocalReference
-
Returns the JAR entry path.
- getJarFileRef() - Method in class org.restlet.data.LocalReference
-
Returns the JAR file reference.
- getLanguage(String) - Method in class org.restlet.service.MetadataService
-
Returns the language associated to this extension.
- getLanguageParameter() - Method in class org.restlet.service.TunnelService
-
Returns the name of the parameter containing the accepted language.
- getLanguages() - Method in class org.restlet.representation.Variant
-
Returns the modifiable list of languages.
- getLanguages() - Method in class org.restlet.util.WrapperRepresentation
-
- getLast(Request, Response, float) - Method in class org.restlet.util.RouteList
-
Returns the last route match for a given call.
- getLastName() - Method in class org.restlet.security.User
-
Returns the last name.
- getLastSegment() - Method in class org.restlet.data.Reference
-
Returns the last segment of a hierarchical path.
- getLastSegment(boolean) - Method in class org.restlet.data.Reference
-
Returns the optionnally decoded last segment.
- getLastSegment(boolean, boolean) - Method in class org.restlet.data.Reference
-
Returns the optionnally decoded last segment.
- getLocalHostAddress() - Static method in class org.restlet.routing.VirtualHost
-
Returns the local host IP address.
- getLocalHostName() - Static method in class org.restlet.routing.VirtualHost
-
Returns the local host name.
- getLocalSecret(String) - Method in class org.restlet.security.LocalVerifier
-
Returns the local secret associated to a given identifier.
- getLocalSecret(String) - Method in class org.restlet.security.MapVerifier
-
- getLocalSecrets() - Method in class org.restlet.security.MapVerifier
-
Returns the map of local secrets.
- getLocationRef() - Method in class org.restlet.representation.Variant
-
Returns an optional location reference.
- getLocationRef() - Method in class org.restlet.resource.Resource
-
Returns the reference that the client should follow for redirections or
resource creations.
- getLocationRef() - Method in class org.restlet.Response
-
Returns the location reference.
- getLocationRef() - Method in class org.restlet.util.WrapperRepresentation
-
- getLocationRef() - Method in class org.restlet.util.WrapperResponse
-
Returns the reference that the client should follow for redirections or
resource creations.
- getLoggableTemplate() - Method in class org.restlet.service.LogService
-
Returns the URI template of loggable resource references.
- getLogger() - Method in class org.restlet.Context
-
Returns the logger.
- getLogger() - Method in class org.restlet.resource.Resource
-
Returns the logger.
- getLogger() - Method in class org.restlet.Restlet
-
Returns the context's logger.
- getLogger() - Method in class org.restlet.routing.Template
-
Returns the logger to use.
- getLogger() - Method in class org.restlet.util.WrapperRestlet
-
- getLoggerName() - Method in class org.restlet.service.LogService
-
Returns the name of the JDK's logger to use when logging access calls.
- getLogPropertiesRef() - Method in class org.restlet.service.LogService
-
Returns the URI reference of the log properties.
- getLogService() - Method in class org.restlet.Component
-
Returns the global log service.
- getMainAgentProduct() - Method in class org.restlet.data.ClientInfo
-
Returns a Product object based on the name of the user agent.
- getMainType() - Method in class org.restlet.data.MediaType
-
Returns the main type.
- getMatch() - Method in class org.restlet.data.Conditions
-
Returns the modifiable list of tags that must be matched.
- getMatchingMode(Restlet) - Method in class org.restlet.routing.Router
-
Returns the matching mode for the target Restlet.
- getMatchingMode() - Method in class org.restlet.routing.Template
-
Returns the matching mode to use when parsing a formatted reference.
- getMatchingMode() - Method in class org.restlet.routing.TemplateRoute
-
Returns the matching mode to use on the template when parsing a formatted
reference.
- getMatrix() - Method in class org.restlet.data.Reference
-
Returns the optional matrix for hierarchical identifiers.
- getMatrix(boolean) - Method in class org.restlet.data.Reference
-
Returns the optionnally decoded matrix.
- getMatrix() - Method in class org.restlet.resource.Resource
-
Returns the resource reference's optional matrix.
- getMatrixAsForm() - Method in class org.restlet.data.Reference
-
Returns the optional matrix as a form.
- getMatrixAsForm(CharacterSet) - Method in class org.restlet.data.Reference
-
Returns the optional matrix as a form submission.
- getMatrixString() - Method in class org.restlet.data.Form
-
Formats the form as a matrix path string.
- getMatrixString(CharacterSet) - Method in class org.restlet.data.Form
-
Formats the form as a query string.
- getMatrixValue(String) - Method in class org.restlet.resource.Resource
-
Returns the first value of the matrix parameter given its name if
existing, or null.
- getMaxAge() - Method in class org.restlet.data.CookieSetting
-
Returns the maximum age in seconds.
- getMaxAge() - Method in class org.restlet.service.CorsService
-
Indicates how long (in seconds) the results of a preflight request can be cached in a preflight result cache.
- getMaxAttempts() - Method in class org.restlet.routing.Router
-
Returns the maximum number of attempts if no attachment could be matched
on the first attempt.
- getMaxForwards() - Method in class org.restlet.Request
-
Returns the maximum number of intermediaries.
- getMaxForwards() - Method in class org.restlet.resource.Resource
-
Returns the maximum number of intermediaries.
- getMaxForwards() - Method in class org.restlet.util.WrapperRequest
-
- getMaxRedirects() - Method in class org.restlet.resource.ClientResource
-
Returns the maximum number of redirections that can be automatically
followed for a single call.
- getMediaType() - Method in class org.restlet.representation.Variant
-
Returns the media type.
- getMediaType(String) - Method in class org.restlet.service.MetadataService
-
Returns the mediatype associated to this extension.
- getMediaType() - Method in class org.restlet.util.WrapperRepresentation
-
- getMediaTypeParameter() - Method in class org.restlet.service.TunnelService
-
Returns the name of the parameter containing the accepted media type.
- getMemberGroups() - Method in class org.restlet.security.Group
-
Returns the modifiable list of member groups.
- getMemberUsers() - Method in class org.restlet.security.Group
-
- getMetadata() - Method in class org.restlet.data.Preference
-
Returns the metadata associated with this preference.
- getMetadata(String) - Method in class org.restlet.service.MetadataService
-
Returns the metadata associated to this extension.
- getMetadata(String, Class<T>) - Method in class org.restlet.service.MetadataService
-
Returns the metadata associated to this extension.
- getMetadataService() - Method in class org.restlet.Application
-
Returns the metadata service.
- getMetadataService() - Method in class org.restlet.resource.Resource
-
Returns the application's metadata service or create a new one.
- getMetadataService() - Method in class org.restlet.service.StatusService
-
Returns the service used to select the preferred variant.
- getMethod() - Method in class org.restlet.Request
-
Returns the method.
- getMethod() - Method in class org.restlet.resource.Resource
-
Returns the method.
- getMethod() - Method in class org.restlet.util.WrapperRequest
-
Returns the method.
- getMethodHeader() - Method in class org.restlet.service.TunnelService
-
Returns the name of the header containing the method name.
- getMethodParameter() - Method in class org.restlet.service.TunnelService
-
Returns the method parameter name.
- getMinimumSize() - Method in class org.restlet.service.EncoderService
-
Returns the minimum size a representation must have before compression is
done.
- getMode() - Method in class org.restlet.routing.Redirector
-
Returns the redirection mode.
- getModificationDate() - Method in class org.restlet.representation.RepresentationInfo
-
Returns the last date when this representation was modified.
- getModificationDate() - Method in class org.restlet.util.WrapperRepresentation
-
- getModifiedSince() - Method in class org.restlet.data.Conditions
-
Returns the condition based on the modification date of the requested
variant.
- getMostSpecific(MediaType...) - Static method in class org.restlet.data.MediaType
-
Returns the first of the most specific media type of the given array of
MediaType
s.
- getName() - Method in class org.restlet.data.CacheDirective
-
Returns the name.
- getName() - Method in class org.restlet.data.ChallengeScheme
-
Returns the name.
- getName() - Method in class org.restlet.data.Cookie
-
Returns the name.
- getName() - Method in class org.restlet.data.Expectation
-
Returns the name.
- getName() - Method in class org.restlet.data.Header
-
Returns the name.
- getName() - Method in class org.restlet.data.Metadata
-
Returns the name (ex: "text/html" or "compress" or "iso-8851-1").
- getName() - Method in class org.restlet.data.Method
-
Returns the name.
- getName() - Method in class org.restlet.data.Parameter
-
- getName() - Method in class org.restlet.data.Product
-
Returns the product name.
- getName() - Method in class org.restlet.data.Protocol
-
Returns the name.
- getName() - Method in class org.restlet.data.RecipientInfo
-
Returns the host name and port number or a pseudonym.
- getName() - Method in class org.restlet.data.Tag
-
Returns the name, corresponding to an HTTP opaque tag value.
- getName() - Method in class org.restlet.resource.ServerResource
-
Returns the display name.
- getName() - Method in class org.restlet.Restlet
-
Returns the display name.
- getName() - Method in class org.restlet.security.Group
-
Returns the display name.
- getName() - Method in class org.restlet.security.Realm
-
Returns the name.
- getName() - Method in class org.restlet.security.Role
-
Returns the name.
- getName() - Method in class org.restlet.security.User
-
Returns the user identifier.
- getName() - Method in interface org.restlet.util.NamedValue
-
Returns the name of this parameter.
- getName(int) - Static method in class org.restlet.util.SelectionRegistration
-
Returns the name of the given IO operation.
- getName() - Method in class org.restlet.util.WrapperRestlet
-
- getNames() - Method in class org.restlet.util.Series
-
Returns the set of parameter names (case sensitive).
- getNext() - Method in class org.restlet.resource.ClientResource
-
Returns the next Restlet.
- getNext() - Method in class org.restlet.routing.Filter
-
Returns the next Restlet.
- getNext(Request, Response) - Method in class org.restlet.routing.Router
-
Returns the next Restlet if available.
- getNext() - Method in class org.restlet.Server
-
Returns the next Restlet.
- getNext(Request, Response, float) - Method in class org.restlet.util.RouteList
-
Returns a next route match in a round robin mode for a given call.
- getNext() - Method in class org.restlet.util.ServerList
-
Returns the next Restlet.
- getNextServerNonce() - Method in class org.restlet.data.AuthenticationInfo
-
Returns the next server nonce.
- getNonceCount() - Method in class org.restlet.data.AuthenticationInfo
-
Returns the nonce-count value.
- getNoneMatch() - Method in class org.restlet.data.Conditions
-
Returns the modifiable list of tags that mustn't match.
- getObject() - Method in class org.restlet.representation.ObjectRepresentation
-
Returns the represented object.
- getObjectClasses(Variant) - Method in class org.restlet.service.ConverterService
-
Returns the list of object classes that can be converted from a given
variant.
- getOnError() - Method in class org.restlet.Message
-
Returns the callback invoked when an error occurs when sending the
message.
- getOnResponse() - Method in class org.restlet.Request
-
Returns the callback invoked on response reception.
- getOnResponse() - Method in class org.restlet.resource.ClientResource
-
Returns the callback invoked on response reception.
- getOnResponse() - Method in class org.restlet.util.WrapperRequest
-
- getOnSent() - Method in class org.restlet.Message
-
Returns the callback invoked after sending the message.
- getOnSent() - Method in class org.restlet.resource.ClientResource
-
Returns the callback invoked after sending the request.
- getOnSent() - Method in class org.restlet.resource.ServerResource
-
Returns the callback invoked after sending the response.
- getOpaque() - Method in class org.restlet.data.ChallengeMessage
-
Returns an opaque string of data which should be returned by the client
unchanged.
- getOriginalRef() - Method in class org.restlet.Request
-
Returns the original reference as requested by the client.
- getOriginalRef() - Method in class org.restlet.resource.Resource
-
Returns the original reference as requested by the client.
- getOriginalRef() - Method in class org.restlet.util.WrapperRequest
-
- getOutboundRoot() - Method in class org.restlet.Application
-
Returns the outbound root Restlet.
- getOwner() - Method in class org.restlet.Restlet
-
Returns the owner(s).
- getOwner() - Method in class org.restlet.util.WrapperRestlet
-
- getParameters() - Method in class org.restlet.Context
-
Returns the modifiable series of parameters.
- getParameters() - Method in class org.restlet.data.ChallengeMessage
-
Returns the modifiable series of scheme parameters.
- getParameters() - Method in class org.restlet.data.Disposition
-
Returns the list of disposition parameters.
- getParameters() - Method in class org.restlet.data.Expectation
-
Returns the list of parameters.
- getParameters() - Method in class org.restlet.data.MediaType
-
Returns the unmodifiable list of parameters corresponding to subtype
modifiers.
- getParameters() - Method in class org.restlet.data.Preference
-
Returns the modifiable list of parameters.
- getParameters() - Method in class org.restlet.security.Realm
-
Returns the modifiable series of parameters.
- getParent() - Method in class org.restlet.data.CharacterSet
-
- getParent() - Method in class org.restlet.data.Encoding
-
- getParent() - Method in class org.restlet.data.Language
-
- getParent() - Method in class org.restlet.data.MediaType
-
Returns the parent metadata if available or null.
- getParent() - Method in class org.restlet.data.Metadata
-
Returns the parent metadata if available or null.
- getParent() - Method in class org.restlet.resource.ClientResource
-
Returns the parent resource.
- getParent(Class<? extends T>) - Method in class org.restlet.resource.ClientResource
-
Wraps the parent client resource to proxy calls to the given Java
interface into Restlet method calls.
- getParentRef() - Method in class org.restlet.data.Reference
-
Returns the parent reference of a hierarchical reference.
- getPatchTypes(MediaType) - Method in class org.restlet.service.ConverterService
-
Returns the list of patch media types available for the given
representation types.
- getPath() - Method in class org.restlet.data.Cookie
-
Returns the validity path.
- getPath() - Method in class org.restlet.data.Reference
-
Returns the path component for hierarchical identifiers.
- getPath(boolean) - Method in class org.restlet.data.Reference
-
Returns the optionnally decoded path component.
- getPattern() - Method in class org.restlet.routing.Template
-
Returns the pattern to use for formatting or parsing.
- getPort() - Method in class org.restlet.data.ClientInfo
-
Returns the port number which sent the call.
- getPort() - Method in class org.restlet.data.ServerInfo
-
Returns the port number which received the call.
- getPort() - Method in class org.restlet.Server
-
Returns the listening port if specified.
- getPreferredCharacterSet(List<CharacterSet>) - Method in class org.restlet.data.ClientInfo
-
Returns the preferred character set among a list of supported ones, based
on the client preferences.
- getPreferredEncoding(List<Encoding>) - Method in class org.restlet.data.ClientInfo
-
Returns the preferred encoding among a list of supported ones, based on
the client preferences.
- getPreferredLanguage(List<Language>) - Method in class org.restlet.data.ClientInfo
-
Returns the preferred language among a list of supported ones, based on
the client preferences.
- getPreferredMediaType(List<MediaType>) - Method in class org.restlet.data.ClientInfo
-
Returns the preferred media type among a list of supported ones, based on
the client preferences.
- getPreferredMetadata(List<T>, List<Preference<T>>) - Static method in class org.restlet.data.ClientInfo
-
Returns the preferred metadata taking into account both metadata
supported by the server and client preferences.
- getPreferredPatch(List<MediaType>) - Method in class org.restlet.data.ClientInfo
-
Returns the preferred patch among a list of supported ones, based on the
client preferences.
- getPreferredVariant(List<Variant>) - Method in class org.restlet.resource.ServerResource
-
Returns the preferred variant among a list of available variants.
- getPreferredVariant(List<? extends Variant>, Request, MetadataService) - Method in class org.restlet.service.ConnegService
-
Returns the best variant representation for a given resource according
the the client preferences.
- getPrimaryTag() - Method in class org.restlet.data.Language
-
Returns the primary tag.
- getPrincipal() - Method in class org.restlet.data.ChallengeResponse
-
Gets the principal associated to the identifier property.
- getPrincipals() - Method in class org.restlet.data.ClientInfo
-
Returns the additional client principals.
- getPrincipals(List<Certificate>) - Method in class org.restlet.security.CertificateAuthenticator
-
Extracts the Principal of the subject to use from a chain of certificate.
- getProtocol() - Method in class org.restlet.data.RecipientInfo
-
Returns the protocol used to communicate with the recipient.
- getProtocol() - Method in class org.restlet.Request
-
Returns the protocol used or to be used, if known.
- getProtocol() - Method in class org.restlet.resource.Resource
-
Returns the protocol by first returning the resourceRef.schemeProtocol
property if it is set, or the baseRef.schemeProtocol property otherwise.
- getProtocol() - Method in class org.restlet.util.WrapperRequest
-
Returns the protocol by first returning the baseRef.schemeProtocol
property if it is set, or the resourceRef.schemeProtocol property
otherwise.
- getProtocols() - Method in class org.restlet.Connector
-
Returns the modifiable list of protocols simultaneously supported.
- getProxyChallengeRequests() - Method in class org.restlet.resource.Resource
-
Returns the list of proxy authentication requests sent by an origin
server to a client.
- getProxyChallengeRequests() - Method in class org.restlet.Response
-
Returns the list of authentication requests sent by an origin server to a
client.
- getProxyChallengeRequests() - Method in class org.restlet.util.WrapperResponse
-
Returns the list of authentication requests sent by a proxy to a client.
- getProxyChallengeResponse() - Method in class org.restlet.Request
-
Returns the authentication response sent by a client to a proxy.
- getProxyChallengeResponse() - Method in class org.restlet.resource.Resource
-
Returns the proxy authentication response sent by a client to an origin
server.
- getProxyChallengeResponse() - Method in class org.restlet.util.WrapperRequest
-
Returns the authentication response sent by a client to a proxy.
- getQuality() - Method in class org.restlet.data.AuthenticationInfo
-
Returns the quality of protection.
- getQuality() - Method in class org.restlet.data.ChallengeResponse
-
Returns the chosen quality of protection.
- getQuality() - Method in class org.restlet.data.Preference
-
Returns the quality/preference level.
- getQualityOptions() - Method in class org.restlet.data.ChallengeRequest
-
Returns the available options for quality of protection.
- getQuery() - Method in class org.restlet.data.Reference
-
Returns the optional query component for hierarchical identifiers.
- getQuery(boolean) - Method in class org.restlet.data.Reference
-
Returns the optionnally decoded query component.
- getQuery() - Method in class org.restlet.resource.Resource
-
Returns the resource reference's optional query.
- getQueryAsForm() - Method in class org.restlet.data.Reference
-
Returns the optional query component as a form.
- getQueryAsForm(boolean) - Method in class org.restlet.data.Reference
-
Returns the optional query component as a form.
- getQueryAsForm(CharacterSet) - Method in class org.restlet.data.Reference
-
Returns the optional query component as a form submission.
- getQueryString() - Method in class org.restlet.data.Form
-
Formats the form as a query string.
- getQueryString(CharacterSet) - Method in class org.restlet.data.Form
-
Formats the form as a query string.
- getQueryValue(String) - Method in class org.restlet.resource.Resource
-
Returns the first value of the query parameter given its name if
existing, or null.
- getRandom(Request, Response, float) - Method in class org.restlet.util.RouteList
-
Returns a random route match for a given call.
- getRange() - Method in class org.restlet.representation.Representation
-
Returns the range where in the full content the partial content available
should be applied.
- getRange() - Method in class org.restlet.util.WrapperRepresentation
-
- getRangeDate() - Method in class org.restlet.data.Conditions
-
Returns the range condition based on the modification date of the
requested variant.
- getRanges() - Method in class org.restlet.Request
-
Returns the ranges to return from the target resource's representation.
- getRanges() - Method in class org.restlet.resource.Resource
-
Returns the ranges to return from the target resource's representation.
- getRanges() - Method in class org.restlet.util.WrapperRequest
-
- getRangeService() - Method in class org.restlet.Application
-
Returns the range service.
- getRangeStatus(RepresentationInfo) - Method in class org.restlet.data.Conditions
-
Returns the range conditional status of an entity.
- getRangeStatus(Tag, Date) - Method in class org.restlet.data.Conditions
-
Returns the range conditional status of an entity.
- getRangeTag() - Method in class org.restlet.data.Conditions
-
Returns the range condition based on the entity tag of the requested
variant.
- getRawValue() - Method in class org.restlet.data.ChallengeMessage
-
Returns the raw challenge value.
- getReader() - Method in class org.restlet.representation.BufferingRepresentation
-
- getReader() - Method in class org.restlet.representation.ChannelRepresentation
-
- getReader() - Method in class org.restlet.representation.DigesterRepresentation
-
- getReader() - Method in class org.restlet.representation.EmptyRepresentation
-
- getReader() - Method in class org.restlet.representation.FileRepresentation
-
- getReader() - Method in class org.restlet.representation.ReaderRepresentation
-
- getReader() - Method in class org.restlet.representation.Representation
-
Returns a characters reader with the representation's content.
- getReader() - Method in class org.restlet.representation.StreamRepresentation
-
- getReader() - Method in class org.restlet.representation.StringRepresentation
-
- getReader() - Method in class org.restlet.representation.WriterRepresentation
-
- getReader() - Method in class org.restlet.util.WrapperRepresentation
-
- getReadyOperations() - Method in class org.restlet.util.SelectionRegistration
-
Returns the IO operations ready.
- getRealm(String) - Method in class org.restlet.Component
-
Finds the realm with the given name.
- getRealm() - Method in class org.restlet.data.ChallengeMessage
-
Returns the realm name.
- getRealm() - Method in class org.restlet.security.ChallengeAuthenticator
-
Returns the authentication realm.
- getRealms() - Method in class org.restlet.Component
-
Returns the modifiable list of security realms.
- getReasonPhrase() - Method in class org.restlet.data.Status
-
Returns the reason phrase of this status.
- getRecipientsInfo() - Method in class org.restlet.Message
-
Returns the intermediary recipient information.
- getReference() - Method in class org.restlet.resource.Resource
-
Returns the URI reference.
- getReferrerRef() - Method in class org.restlet.Request
-
Returns the referrer reference if available.
- getReferrerRef() - Method in class org.restlet.resource.Resource
-
Returns the referrer reference if available.
- getReferrerRef() - Method in class org.restlet.util.WrapperRequest
-
Returns the referrer reference if available.
- getRegistration() - Method in class org.restlet.representation.Representation
-
Returns the NIO registration of the related channel with its selector.
- getRegistration() - Method in class org.restlet.util.WrapperRepresentation
-
- getRelativePart() - Method in class org.restlet.data.Reference
-
Returns the relative part of relative references, without the query and
fragment.
- getRelativePart(boolean) - Method in class org.restlet.data.Reference
-
Returns the optionnally decoded relative part.
- getRelativeRef() - Method in class org.restlet.data.Reference
-
Returns the current reference as a relative reference to the current base
reference.
- getRelativeRef(Reference) - Method in class org.restlet.data.Reference
-
Returns the current reference relatively to a base reference.
- getRemainingPart() - Method in class org.restlet.data.Reference
-
Returns the part of the resource identifier remaining after the base
reference.
- getRemainingPart(boolean) - Method in class org.restlet.data.Reference
-
Returns the optionally decoded remaining part.
- getRemainingPart(boolean, boolean) - Method in class org.restlet.data.Reference
-
Returns the optionally decoded remaining part with or without the query
part of the reference.
- getRepresentation(Status, Request, Response) - Method in class org.restlet.service.StatusService
-
- getRequest() - Method in class org.restlet.resource.Resource
-
Returns the handled request.
- getRequest() - Method in exception org.restlet.resource.ResourceException
-
Returns the request associated to this exception.
- getRequest() - Method in class org.restlet.Response
-
Returns the associated request
- getRequest() - Method in class org.restlet.util.WrapperResponse
-
Returns the associated request
- getRequestAttributes() - Method in class org.restlet.resource.Resource
-
Returns the request attributes.
- getRequestCacheDirectives() - Method in class org.restlet.resource.Resource
-
Returns the request cache directives.
- getRequestEntity() - Method in class org.restlet.resource.Resource
-
Returns the request entity representation.
- getRequiredScore() - Method in class org.restlet.routing.Router
-
Returns the minimum score required to have a match.
- getResourceDomain() - Method in class org.restlet.routing.VirtualHost
-
Returns the resourceRef host domain to match.
- getResourcePort() - Method in class org.restlet.routing.VirtualHost
-
Returns the resourceRef host port to match.
- getResourceRef() - Method in class org.restlet.Request
-
Returns the reference of the target resource.
- getResourceRef() - Method in class org.restlet.util.WrapperRequest
-
Returns the reference of the target resource.
- getResourceScheme() - Method in class org.restlet.routing.VirtualHost
-
Returns the resourceRef scheme to match.
- getResponse() - Method in class org.restlet.resource.Resource
-
Returns the handled response.
- getResponse() - Method in exception org.restlet.resource.ResourceException
-
Returns the response associated to this exception.
- getResponseAttributes() - Method in class org.restlet.resource.Resource
-
Returns the response attributes.
- getResponseCacheDirectives() - Method in class org.restlet.resource.Resource
-
Returns the response cache directives.
- getResponseDigest() - Method in class org.restlet.data.AuthenticationInfo
-
Returns the optional response digest for mutual authentication.
- getResponseEntity() - Method in class org.restlet.resource.Resource
-
Returns the response entity representation.
- getResponseLogFormat() - Method in class org.restlet.service.LogService
-
Returns the format used when logging responses.
- getResponseLogMessage(Response, int) - Method in class org.restlet.service.LogService
-
Format an access log entry.
- getRetryAfter() - Method in class org.restlet.Response
-
Indicates how long the service is expected to be unavailable to the
requesting client.
- getRetryAfter() - Method in class org.restlet.util.WrapperResponse
-
- getRetryAttempts() - Method in class org.restlet.resource.ClientResource
-
Returns the number of retry attempts before reporting an error.
- getRetryDelay() - Method in class org.restlet.resource.ClientResource
-
Returns the delay in milliseconds between two retry attempts.
- getRetryDelay() - Method in class org.restlet.routing.Router
-
Returns the delay in milliseconds before a new attempt is made.
- getRiapAuthorityType() - Method in class org.restlet.data.LocalReference
-
Returns the type of authority.
- getRole(String) - Method in class org.restlet.Application
-
Returns the role associated to the given name.
- getRole(String) - Method in class org.restlet.resource.ServerResource
-
Retrieves an existing role or creates a new one if needed based on its
name.
- getRoles() - Method in class org.restlet.Application
-
Returns the modifiable list of roles.
- getRoles() - Method in class org.restlet.data.ClientInfo
-
Returns the authenticated user roles.
- getRootGroups() - Method in class org.restlet.security.MemoryRealm
-
Returns the modifiable list of root groups.
- getRootRef() - Method in class org.restlet.Request
-
Returns the application root reference.
- getRootRef() - Method in class org.restlet.resource.Directory
-
Returns the root URI from which the relative resource URIs will be looked
up.
- getRootRef() - Method in class org.restlet.resource.Resource
-
Returns the application root reference.
- getRootRef() - Method in class org.restlet.util.WrapperRequest
-
Returns the application root reference.
- getRouter() - Method in class org.restlet.routing.Route
-
Returns the parent router.
- getRoutes() - Method in class org.restlet.routing.Router
-
Returns the modifiable list of routes.
- getRoutingMode() - Method in class org.restlet.routing.Router
-
Returns the routing mode.
- getScheme() - Method in class org.restlet.data.ChallengeMessage
-
Returns the scheme used.
- getScheme() - Method in class org.restlet.data.Reference
-
Returns the scheme component.
- getScheme(boolean) - Method in class org.restlet.data.Reference
-
Returns the optionnally decoded scheme component.
- getScheme() - Method in class org.restlet.security.ChallengeAuthenticator
-
Returns the authentication challenge scheme.
- getSchemeName() - Method in class org.restlet.data.Protocol
-
Returns the URI scheme name.
- getSchemeProtocol() - Method in class org.restlet.data.Reference
-
Returns the protocol associated with the scheme component.
- getSchemeSpecificPart() - Method in class org.restlet.data.Reference
-
Returns the scheme specific part.
- getSchemeSpecificPart(boolean) - Method in class org.restlet.data.Reference
-
Returns the optionnally decoded scheme specific part.
- getSecret() - Method in class org.restlet.data.ChallengeResponse
-
Returns the user secret, such as a password or a secret key.
- getSecret(Request, Response) - Method in class org.restlet.security.SecretVerifier
-
Returns the secret provided by the user.
- getSecret() - Method in class org.restlet.security.User
-
Returns the secret.
- getSecretAlgorithm() - Method in class org.restlet.data.ChallengeResponse
-
Returns the digest algorithm name optionally applied on the user secret.
- getSegments() - Method in class org.restlet.data.Reference
-
Returns the list of segments in a hierarchical path.
- getSegments(boolean) - Method in class org.restlet.data.Reference
-
Returns the optionnally decoded list of segments.
- getSelectableChannel() - Method in class org.restlet.util.SelectionRegistration
-
Returns the parent selectable channel.
- getSelectionListener() - Method in class org.restlet.util.SelectionRegistration
-
Returns the selection listener that will be notified.
- getServerAddress() - Method in class org.restlet.routing.VirtualHost
-
Returns the listening server address.
- getServerDispatcher() - Method in class org.restlet.Context
-
Returns a request dispatcher to component's virtual hosts.
- getServerInfo() - Method in class org.restlet.resource.Resource
-
Returns the server-specific information.
- getServerInfo() - Method in class org.restlet.Response
-
Returns the server-specific information.
- getServerInfo() - Method in class org.restlet.util.WrapperResponse
-
Returns the server-specific information.
- getServerNonce() - Method in class org.restlet.data.ChallengeMessage
-
Returns the server nonce.
- getServerNounceCount() - Method in class org.restlet.data.ChallengeResponse
-
Returns the server nonce count.
- getServerNounceCountAsHex() - Method in class org.restlet.data.ChallengeResponse
-
Returns the server nonce count as an hexadecimal string of eight
characters.
- getServerPort() - Method in class org.restlet.routing.VirtualHost
-
Returns the listening server port.
- getServerProtocols() - Method in class org.restlet.service.ConnectorService
-
Returns the modifiable list of required server protocols.
- getServers() - Method in class org.restlet.Component
-
Returns the modifiable list of server connectors.
- getServices() - Method in class org.restlet.Application
-
Returns the modifiable list of services.
- getServices() - Method in class org.restlet.Component
-
Returns the modifiable list of services.
- getSize() - Method in class org.restlet.data.Range
-
Returns the size of the range in number of bytes.
- getSize() - Method in class org.restlet.representation.BufferingRepresentation
-
- getSize() - Method in class org.restlet.representation.FileRepresentation
-
- getSize() - Method in class org.restlet.representation.Representation
-
Returns the total size in bytes if known, UNKNOWN_SIZE (-1) otherwise.
- getSize() - Method in class org.restlet.util.WrapperRepresentation
-
- getStatus(Method, boolean, Tag, Date) - Method in class org.restlet.data.Conditions
-
Returns the conditional status of a variant using a given method.
- getStatus(Method, RepresentationInfo) - Method in class org.restlet.data.Conditions
-
Returns the conditional status of a variant using a given method.
- getStatus() - Method in class org.restlet.data.Warning
-
Returns the special status.
- getStatus() - Method in class org.restlet.resource.Resource
-
Returns the status.
- getStatus() - Method in exception org.restlet.resource.ResourceException
-
Returns the status associated to this exception.
- getStatus() - Method in class org.restlet.Response
-
Returns the status.
- getStatus(Throwable, Request, Response) - Method in class org.restlet.service.StatusService
-
- getStatus(Throwable, Resource) - Method in class org.restlet.service.StatusService
-
- getStatus() - Method in class org.restlet.util.WrapperResponse
-
Returns the status.
- getStatusService() - Method in class org.restlet.Application
-
Returns the status service.
- getStatusService() - Method in class org.restlet.Component
-
- getStatusService() - Method in class org.restlet.resource.Resource
-
Returns the application's status service or create a new one.
- getStream() - Method in class org.restlet.representation.BufferingRepresentation
-
- getStream() - Method in class org.restlet.representation.ChannelRepresentation
-
- getStream() - Method in class org.restlet.representation.CharacterRepresentation
-
- getStream() - Method in class org.restlet.representation.DigesterRepresentation
-
Returns a stream with the representation's content.
- getStream() - Method in class org.restlet.representation.EmptyRepresentation
-
- getStream() - Method in class org.restlet.representation.FileRepresentation
-
- getStream() - Method in class org.restlet.representation.InputRepresentation
-
- getStream() - Method in class org.restlet.representation.OutputRepresentation
-
Returns a stream with the representation's content.
- getStream() - Method in class org.restlet.representation.Representation
-
Returns a stream with the representation's content.
- getStream() - Method in class org.restlet.representation.StringRepresentation
-
- getStream() - Method in class org.restlet.util.WrapperRepresentation
-
- getSubTags() - Method in class org.restlet.data.Language
-
Returns the unmodifiable list of subtags.
- getSubType() - Method in class org.restlet.data.MediaType
-
Returns the sub-type.
- getTag() - Method in class org.restlet.representation.RepresentationInfo
-
Returns the tag.
- getTag() - Method in class org.restlet.util.WrapperRepresentation
-
- getTargetClass() - Method in class org.restlet.resource.Finder
-
Returns the target resource class which must be either a subclass of
ServerResource
.
- getTargetRef() - Method in class org.restlet.data.Reference
-
Returns the target reference.
- getTargetRef(Request, Response) - Method in class org.restlet.routing.Redirector
-
Returns the target reference to redirect to by automatically resolving
URI template variables found using the
Template
class using the
request and response as data models.
- getTargetTemplate() - Method in class org.restlet.routing.Redirector
-
Returns the target URI pattern.
- getTaskService() - Method in class org.restlet.Application
-
Deprecated.
- getTaskService() - Method in class org.restlet.Component
-
Returns a task service to run concurrent tasks.
- getTechnicalName() - Method in class org.restlet.data.ChallengeScheme
-
Returns the technical name (ex: BASIC).
- getTechnicalName() - Method in class org.restlet.data.Protocol
-
Returns the technical name that appears on the wire.
- getTemplate() - Method in class org.restlet.routing.TemplateRoute
-
Returns the reference template to match.
- getText() - Method in class org.restlet.data.Warning
-
Returns the warning text.
- getText() - Method in class org.restlet.representation.AppendableRepresentation
-
- getText() - Method in class org.restlet.representation.BufferingRepresentation
-
- getText() - Method in class org.restlet.representation.DigesterRepresentation
-
- getText() - Method in class org.restlet.representation.EmptyRepresentation
-
- getText() - Method in class org.restlet.representation.FileRepresentation
-
- getText() - Method in class org.restlet.representation.InputRepresentation
-
- getText() - Method in class org.restlet.representation.ReaderRepresentation
-
- getText() - Method in class org.restlet.representation.Representation
-
Converts the representation to a string value.
- getText() - Method in class org.restlet.representation.StringRepresentation
-
- getText() - Method in class org.restlet.util.WrapperRepresentation
-
- getTextRepresentation() - Method in class org.restlet.data.ReferenceList
-
Returns a representation of the list in the "text/uri-list" format.
- getThrowable() - Method in class org.restlet.data.Status
-
Returns the related error or exception.
- getTimeIssued() - Method in class org.restlet.data.ChallengeResponse
-
Returns the time when the response was issued, as returned by System.currentTimeMillis()
.
- getTunnelService() - Method in class org.restlet.Application
-
Returns the tunnel service.
- getType() - Method in class org.restlet.data.Disposition
-
Returns the disposition type.
- getType() - Method in class org.restlet.routing.Variable
-
Returns the type of variable.
- getUnitName() - Method in class org.restlet.data.Range
-
Returns the name of the range unit.
- getUnmodifiedSince() - Method in class org.restlet.data.Conditions
-
Returns the condition based on the modification date of the requested
variant.
- getUpstreamAddress() - Method in class org.restlet.data.ClientInfo
-
Returns the IP address of the upstream client component.
- getUri() - Method in class org.restlet.data.Method
-
Returns the URI of the specification describing the method.
- getUri() - Method in class org.restlet.data.Status
-
Returns the URI of the specification describing the status.
- getUser() - Method in class org.restlet.data.ClientInfo
-
Returns the authenticated user.
- getUser(Principal) - Method in class org.restlet.security.CertificateAuthenticator
-
Creates a new User based on the subject's X500Principal.
- getUserInfo() - Method in class org.restlet.data.Reference
-
Returns the user info component for server based hierarchical
identifiers.
- getUserInfo(boolean) - Method in class org.restlet.data.Reference
-
Returns the optionnally decoded user info component.
- getUsers() - Method in class org.restlet.security.MemoryRealm
-
Returns the modifiable list of users.
- getValue() - Method in class org.restlet.data.CacheDirective
-
Returns the value.
- getValue() - Method in class org.restlet.data.Cookie
-
Returns the value.
- getValue() - Method in class org.restlet.data.Digest
-
Returns the digest value.
- getValue() - Method in class org.restlet.data.Expectation
-
Returns the value.
- getValue() - Method in class org.restlet.data.Header
-
Returns the value.
- getValue() - Method in class org.restlet.data.Parameter
-
- getValue() - Method in interface org.restlet.util.NamedValue
-
Returns the value.
- getValues(String) - Method in class org.restlet.util.Series
-
Returns the values of the parameters with a given name.
- getValues(String, String, boolean) - Method in class org.restlet.util.Series
-
Returns the parameter values with a given name.
- getValuesArray(String) - Method in class org.restlet.util.Series
-
Returns an array of all the values associated to the given parameter
name.
- getValuesArray(String, boolean) - Method in class org.restlet.util.Series
-
Returns an array of all the values associated to the given parameter
name.
- getValuesArray(String, boolean, String) - Method in class org.restlet.util.Series
-
Returns an array of all the values associated to the given parameter
name.
- getValuesArray(String, String) - Method in class org.restlet.util.Series
-
Returns an array of all the values associated to the given parameter
name.
- getValuesMap() - Method in class org.restlet.util.Series
-
Returns a map of name, value pairs.
- getVariableNames() - Method in class org.restlet.routing.Template
-
Returns the list of variable names in the template.
- getVariables() - Method in class org.restlet.routing.Template
-
Returns the modifiable map of variable descriptors.
- getVariants() - Method in class org.restlet.resource.ServerResource
-
Returns a modifiable list of exposed variants for the current request
method.
- getVariants(Method) - Method in class org.restlet.resource.ServerResource
-
Returns a modifiable list of exposed variants for the given method.
- getVariants(Class<?>, Variant) - Method in class org.restlet.service.ConverterService
-
Returns the list of variants that can be converted from a given object
class.
- getVerifier() - Method in class org.restlet.security.ChallengeAuthenticator
-
Returns the credentials verifier.
- getVerifier() - Method in class org.restlet.security.Realm
-
Returns a verifier that can check the validity of the credentials
associated to a request.
- getVersion() - Method in class org.restlet.data.Cookie
-
Returns the cookie specification version.
- getVersion() - Method in class org.restlet.data.Product
-
Returns the version of the product.
- getVersion() - Method in class org.restlet.data.Protocol
-
Returns the version.
- getWakeupListener() - Method in class org.restlet.util.SelectionRegistration
-
Returns the wakeup listener that will be notified.
- getWarnings() - Method in class org.restlet.Message
-
Returns the additional warnings information.
- getWebRepresentation() - Method in class org.restlet.data.Form
-
Returns the form as a Web representation
(MediaType.APPLICATION_WWW_FORM).
- getWebRepresentation(CharacterSet) - Method in class org.restlet.data.Form
-
Returns the form as a Web representation
(MediaType.APPLICATION_WWW_FORM).
- getWebRepresentation() - Method in class org.restlet.data.ReferenceList
-
Returns a representation of the list in "text/html" format.
- getWrappedRepresentation() - Method in class org.restlet.util.WrapperRepresentation
-
Returns the wrapped representation.
- getWrappedRequest() - Method in class org.restlet.util.WrapperRequest
-
Returns the wrapped request.
- getWrappedResponse() - Method in class org.restlet.util.WrapperResponse
-
Returns the wrapped response.
- Group - Class in org.restlet.security
-
Group that contains member groups and users.
- Group() - Constructor for class org.restlet.security.Group
-
Default constructor.
- Group(String, String) - Constructor for class org.restlet.security.Group
-
Constructor.
- Group(String, String, boolean) - Constructor for class org.restlet.security.Group
-
Constructor.
- GZIP - Static variable in class org.restlet.data.Encoding
-
The GNU Zip encoding.
- IDENTITY - Static variable in class org.restlet.data.Encoding
-
The default (identity) encoding.
- IMAGE_ALL - Static variable in class org.restlet.data.MediaType
-
- IMAGE_BMP - Static variable in class org.restlet.data.MediaType
-
- IMAGE_GIF - Static variable in class org.restlet.data.MediaType
-
- IMAGE_ICON - Static variable in class org.restlet.data.MediaType
-
- IMAGE_JPEG - Static variable in class org.restlet.data.MediaType
-
- IMAGE_PNG - Static variable in class org.restlet.data.MediaType
-
- IMAGE_SVG - Static variable in class org.restlet.data.MediaType
-
- IMAGE_TIFF - Static variable in class org.restlet.data.MediaType
-
- inboundServerRedirect(Reference, Request, Response) - Method in class org.restlet.routing.Redirector
-
Redirects a given call to a target reference.
- includes(Metadata) - Method in class org.restlet.data.CharacterSet
-
Indicates if a given character set is included in the current one.
- includes(Metadata) - Method in class org.restlet.data.Encoding
-
Indicates if a given encoding is included in the current one.
- includes(Metadata) - Method in class org.restlet.data.Language
-
Indicates if a given language is included in the current one.
- includes(Metadata) - Method in class org.restlet.data.MediaType
-
- includes(Metadata, boolean) - Method in class org.restlet.data.MediaType
-
- includes(Metadata) - Method in class org.restlet.data.Metadata
-
Indicates if a given metadata is included in the current one.
- includes(Variant) - Method in class org.restlet.representation.Variant
-
Indicates if the current variant includes the given variant.
- INDEX_FIRST - Static variable in class org.restlet.data.Range
-
Index for the first byte (or range unit) of an entity.
- INDEX_LAST - Static variable in class org.restlet.data.Range
-
Index for the last byte (or range unit) of an entity.
- indexOf(Object) - Method in class org.restlet.util.WrapperList
-
Returns the index in this list of the first occurrence of the specified
element, or -1 if this list does not contain this element.
- INFO_CONTINUE - Static variable in class org.restlet.data.Status
-
This interim response (the client has to wait for the final response) is
used to inform the client that the initial part of the request has been
received and has not yet been rejected or completed by the server.
- INFO_DISCONNECTED_OPERATION - Static variable in class org.restlet.data.Status
-
Warning status code, typically returned by a cache, indicating that it is
intentionally disconnected from the rest of the network for a period of
time.
- INFO_HEURISTIC_EXPIRATION - Static variable in class org.restlet.data.Status
-
Warning status code, typically returned by a cache, indicating that it
heuristically chose a freshness lifetime greater than 24 hours and the
response's age is greater than 24 hours.
- INFO_MISC_WARNING - Static variable in class org.restlet.data.Status
-
Warning status code, optionally including arbitrary information to be
presented to a human user, typically returned by a cache.
- INFO_PROCESSING - Static variable in class org.restlet.data.Status
-
This interim response is used to inform the client that the server has
accepted the complete request, but has not yet completed it since the
server has a reasonable expectation that the request will take
significant time to complete.
- INFO_REVALIDATION_FAILED - Static variable in class org.restlet.data.Status
-
Warning status code, typically returned by a cache, indicating that the
response is stale because an attempt to revalidate the response failed,
due to an inability to reach the server.
- INFO_STALE_RESPONSE - Static variable in class org.restlet.data.Status
-
Warning status code, typically returned by a cache, indicating that the
response is stale.
- INFO_SWITCHING_PROTOCOL - Static variable in class org.restlet.data.Status
-
The server understands and is willing to comply with the client's
request, via the Upgrade message header field, for a change in the
application protocol being used on this connection.
- init(Context, Request, Response) - Method in class org.restlet.resource.Resource
-
Initialization method setting the environment of the current resource
instance.
- InputRepresentation - Class in org.restlet.representation
-
Transient representation based on a BIO input stream.
- InputRepresentation(InputStream) - Constructor for class org.restlet.representation.InputRepresentation
-
Constructor.
- InputRepresentation(InputStream, MediaType) - Constructor for class org.restlet.representation.InputRepresentation
-
Constructor.
- InputRepresentation(InputStream, MediaType, long) - Constructor for class org.restlet.representation.InputRepresentation
-
Constructor.
- invokeAll(Collection) - Method in class org.restlet.service.TaskService
-
Executes the given tasks, returning a list of Futures holding their
status and results when all complete.
- invokeAll(Collection, long, TimeUnit) - Method in class org.restlet.service.TaskService
-
Executes the given tasks, returning a list of Futures holding their
status and results when all complete or the timeout expires, whichever
happens first.
- invokeAny(Collection) - Method in class org.restlet.service.TaskService
-
Executes the given tasks, returning the result of one that has completed
successfully (i.e., without throwing an exception), if any do.
- invokeAny(Collection, long, TimeUnit) - Method in class org.restlet.service.TaskService
-
Executes the given tasks, returning the result of one that has completed
successfully (i.e., without throwing an exception), if any do before the
given timeout elapses.
- isAbsolute() - Method in class org.restlet.data.Reference
-
Indicates if the reference is absolute.
- isAcceptingRanges() - Method in class org.restlet.data.ServerInfo
-
Return true if the server accepts range requests for a resource, with the
"byte" range unit.
- isAccessRestricted() - Method in class org.restlet.data.CookieSetting
-
Indicates if cookie access is restricted for untrusted parties.
- isAllowedCredentials() - Method in class org.restlet.service.CorsService
-
If true, adds 'Access-Control-Allow-Credentials' header.
- isAllowingAllRequestedHeaders() - Method in class org.restlet.service.CorsService
-
If true, indicates that the value of 'Access-Control-Request-Headers'
request header will be copied into the 'Access-Control-Allow-Headers'
response header.
- isAnnotated() - Method in class org.restlet.resource.ServerResource
-
Indicates if annotations are supported.
- isAsynchronous() - Method in class org.restlet.Request
-
Indicates if the request is asynchronous.
- isAsynchronous() - Method in class org.restlet.util.WrapperRequest
-
- isAuthenticated() - Method in class org.restlet.data.ClientInfo
-
Indicates if the identifier or principal has been authenticated.
- isAutoCommitting() - Method in class org.restlet.resource.ServerResource
-
Indicates if the response should be automatically committed.
- isAutoCommitting() - Method in class org.restlet.Response
-
Indicates if the response should be automatically committed.
- isAutoCommitting() - Method in class org.restlet.util.WrapperResponse
-
- isAutoDeleting() - Method in class org.restlet.representation.FileRepresentation
-
Indicates if this file should be automatically deleted on release of the
representation.
- isAvailable() - Method in class org.restlet.Client
-
Indicates the underlying connector helper is available.
- isAvailable() - Method in class org.restlet.Connector
-
Indicates the underlying connector helper is available.
- isAvailable() - Method in class org.restlet.representation.BufferingRepresentation
-
- isAvailable() - Method in class org.restlet.representation.Representation
-
Indicates if some fresh content is potentially available, without having
to actually call one of the content manipulation method like getStream()
that would actually consume it.
- isAvailable() - Method in class org.restlet.Server
-
Indicates the underlying connector helper is available.
- isAvailable() - Method in class org.restlet.util.WrapperRepresentation
-
- isBuffered() - Method in class org.restlet.representation.BufferingRepresentation
-
Indicates if the wrapped entity has been already buffered.
- isBytesRange(Range) - Static method in class org.restlet.data.Range
-
Indicates if the unit of the given range is "bytes".
- isCanceling() - Method in class org.restlet.util.SelectionRegistration
-
Indicates if a canceling of the registration has been requested.
- isClientError(int) - Static method in class org.restlet.data.Status
-
Indicates if the status is a client error status, meaning "The request
contains bad syntax or cannot be fulfilled".
- isClientError() - Method in class org.restlet.data.Status
-
Indicates if the status is a client error status, meaning "The request
contains bad syntax or cannot be fulfilled".
- isCommitted() - Method in class org.restlet.resource.ServerResource
-
Indicates if the response has already been committed.
- isCommitted() - Method in class org.restlet.Response
-
Indicates if the response has already been committed.
- isCommitted() - Method in class org.restlet.util.WrapperResponse
-
- isCompatible(Metadata) - Method in class org.restlet.data.Metadata
-
Checks if this metadata is compatible with the given metadata.
- isCompatible(Variant) - Method in class org.restlet.representation.Variant
-
Indicates if the current variant is compatible with the given variant.
- isConcrete() - Method in class org.restlet.data.MediaType
-
Checks if the current media type is concrete.
- isConditional() - Method in class org.restlet.resource.ServerResource
-
Indicates if conditional handling is enabled.
- isConfidential() - Method in class org.restlet.data.Protocol
-
Indicates if the protocol guarantees the confidentially of the messages
exchanged, for example via a SSL-secured connection.
- isConfidential() - Method in class org.restlet.Message
-
Indicates if the message was or will be exchanged confidentially, for
example via a SSL-secured connection.
- isConfidential() - Method in class org.restlet.Request
-
- isConfidential() - Method in class org.restlet.resource.Resource
-
Indicates if the message was or will be exchanged confidentially, for
example via a SSL-secured connection.
- isConfidential() - Method in class org.restlet.Response
-
- isConfidential() - Method in class org.restlet.util.WrapperRequest
-
Indicates if the call came over a confidential channel such as an
SSL-secured connection.
- isConfidential() - Method in class org.restlet.util.WrapperResponse
-
Indicates if the call came over a confidential channel such as an
SSL-secured connection.
- isConnectable() - Method in class org.restlet.util.SelectionRegistration
-
Indicates if the NIO channel is connectable.
- isConnectorError(int) - Static method in class org.restlet.data.Status
-
Indicates if the status is a connector error status, meaning "The
connector failed to send or receive an apparently valid message".
- isConnectorError() - Method in class org.restlet.data.Status
-
Indicates if the status is a connector error status, meaning "The
connector failed to send or receive an apparently valid message".
- isDaemon() - Method in class org.restlet.service.TaskService
-
Indicates whether the threads are created as daemon threads.
- isDebugging() - Method in class org.restlet.Application
-
Indicates if the debugging mode is enabled.
- isDebugging() - Method in class org.restlet.service.LogService
-
- isDecodingOnParse() - Method in class org.restlet.routing.Variable
-
Indicates if the parsed value must be decoded.
- isDeeplyAccessible() - Method in class org.restlet.resource.Directory
-
Indicates if the sub-directories are deeply accessible (true by default).
- isDigit() - Method in class org.restlet.data.CacheDirective
-
Returns true if the directive contains a digit value.
- isEmpty() - Method in class org.restlet.representation.Representation
-
Indicates if the representation is empty.
- isEmpty() - Method in class org.restlet.util.WrapperList
-
Returns true if this list contains no elements.
- isEmpty() - Method in class org.restlet.util.WrapperMap
-
Returns true if this map contains no key-value mappings.
- isEnabled() - Method in class org.restlet.service.Service
-
Indicates if the service should be enabled.
- isEncodingOnFormat() - Method in class org.restlet.routing.Variable
-
Indicates if the formatted value must be encoded.
- isEncodingVariables() - Method in class org.restlet.routing.Template
-
Indicates if the variables must be encoded when formatting the template.
- isEntityAvailable() - Method in class org.restlet.Message
-
Indicates if a content is available and can be sent or received.
- isEntityAvailable() - Method in class org.restlet.Request
-
Indicates if a content is available and can be sent.
- isEntityAvailable() - Method in class org.restlet.util.WrapperRequest
-
Indicates if a content is available and can be sent.
- isEntityAvailable() - Method in class org.restlet.util.WrapperResponse
-
Indicates if a content is available and can be sent.
- isEquivalentTo(Reference) - Method in class org.restlet.data.Reference
-
Returns true if both reference are equivalent, meaning that they resolve
to the same target reference.
- isError(int) - Static method in class org.restlet.data.Status
-
Indicates if the status is an error (client or server) status.
- isError() - Method in class org.restlet.data.Status
-
Indicates if the status is an error (client or server) status.
- isExisting() - Method in class org.restlet.resource.ServerResource
-
Indicates if the identified resource exists.
- isExpectingResponse() - Method in class org.restlet.Request
-
Indicates if an associated response is expected.
- isExpectingResponse() - Method in class org.restlet.util.WrapperRequest
-
- isExtensionsTunnel() - Method in class org.restlet.service.TunnelService
-
Indicates if the client preferences can be tunneled via the extensions.
- isFinal() - Method in class org.restlet.Response
-
Indicates if the response is final or provisional.
- isFixed() - Method in class org.restlet.routing.Variable
-
Returns true if the value is fixed, in which case the "defaultValue"
property is always used.
- isFollowingRedirects() - Method in class org.restlet.resource.ClientResource
-
Indicates if redirections are followed.
- isGenericDelimiter(int) - Static method in class org.restlet.data.Reference
-
Indicates if the given character is a generic URI component delimiter
character.
- isGlobalError(int) - Static method in class org.restlet.data.Status
-
Indicates if the status is a client error status, meaning "The request
contains bad syntax or cannot be fulfilled".
- isGlobalError() - Method in class org.restlet.data.Status
-
Indicates if the status is a global error status, meaning "The server has
definitive information about a particular user".
- isHeadersCleaning() - Method in class org.restlet.routing.Redirector
-
Indicates if the headers must be cleaned.
- isHeadersTunnel() - Method in class org.restlet.service.TunnelService
-
Indicates if the method can be tunneled via the header.
- isHierarchical() - Method in class org.restlet.data.Reference
-
Indicates if the identifier is hierarchical.
- isIdempotent() - Method in class org.restlet.data.Method
-
Indicates if the side-effects of several requests is the same as a single
request.
- isIdentityCheck() - Method in class org.restlet.service.LogService
-
Indicates if the identity check (as specified by RFC1413) is enabled.
- isIncluded(long, long) - Method in class org.restlet.data.Range
-
Indicates if the given index is included in the range.
- isInformational(int) - Static method in class org.restlet.data.Status
-
Indicates if the status is an information status, meaning "request
received, continuing process".
- isInformational() - Method in class org.restlet.data.Status
-
Indicates if the status is an information status, meaning "request
received, continuing process".
- isInheritingRoles() - Method in class org.restlet.security.Group
-
Indicates if the roles of the parent group should be inherited.
- isInRole(String) - Method in class org.restlet.resource.ServerResource
-
Indicates if the authenticated client user associated to the current
request is in the given role name.
- isInterestReady() - Method in class org.restlet.util.SelectionRegistration
-
Indicates if the operations of interest are ready.
- isListingAllowed() - Method in class org.restlet.resource.Directory
-
Indicates if the display of directory listings is allowed when no index
file is found.
- isLoggable() - Method in class org.restlet.Request
-
Indicates if the call is loggable
- isLoggable() - Method in class org.restlet.resource.Resource
-
Indicates if the call is loggable
- isLoggable(Request) - Method in class org.restlet.service.LogService
-
Indicates if the call should be logged during the processing chain.
- isMatchingQuery() - Method in class org.restlet.routing.TemplateRoute
-
Indicates whether the query part should be taken into account when
matching a reference with the template.
- isMethodTunnel() - Method in class org.restlet.service.TunnelService
-
Indicates if the method name can be tunneled.
- isModifiable() - Method in class org.restlet.resource.Directory
-
Indicates if modifications to local resources (most likely files) are
allowed.
- isMultiAuthenticating() - Method in class org.restlet.security.Authenticator
-
Indicates if the authenticator should attempt to authenticate an already
authenticated client.
- isNegotiated() - Method in class org.restlet.resource.ServerResource
-
Indicates if content negotiation of response entities is enabled.
- isNegotiatingContent() - Method in class org.restlet.resource.Directory
-
Indicates if the best content is automatically negotiated.
- ISO_8859_1 - Static variable in class org.restlet.data.CharacterSet
-
The ISO/IEC 8859-1 (Latin 1) character set.
- ISO_8859_10 - Static variable in class org.restlet.data.CharacterSet
-
The ISO/IEC 8859-10 (Latin 6) character set.
- ISO_8859_2 - Static variable in class org.restlet.data.CharacterSet
-
The ISO/IEC 8859-2 (Latin 2) character set.
- ISO_8859_3 - Static variable in class org.restlet.data.CharacterSet
-
The ISO/IEC 8859-3 (Latin 3) character set.
- ISO_8859_4 - Static variable in class org.restlet.data.CharacterSet
-
The ISO/IEC 8859-4 (Latin 4) character set.
- ISO_8859_5 - Static variable in class org.restlet.data.CharacterSet
-
The ISO/IEC 8859-5 (Cyrillic) character set.
- ISO_8859_6 - Static variable in class org.restlet.data.CharacterSet
-
The ISO/IEC 8859-6 (Arabic) character set.
- ISO_8859_7 - Static variable in class org.restlet.data.CharacterSet
-
The ISO/IEC 8859-7 (Greek) character set.
- ISO_8859_8 - Static variable in class org.restlet.data.CharacterSet
-
The ISO/IEC 8859-8 (Hebrew) character set.
- ISO_8859_9 - Static variable in class org.restlet.data.CharacterSet
-
The ISO/IEC 8859-9 (Latin 5) character set.
- isOpaque() - Method in class org.restlet.data.Reference
-
Indicates if the identifier is opaque.
- isOptional() - Method in class org.restlet.security.Authenticator
-
Indicates if the authenticator is not required to succeed.
- isOverwriting() - Method in class org.restlet.service.StatusService
-
Indicates if an existing entity should be overwritten.
- isParent(Reference) - Method in class org.restlet.data.Reference
-
Indicates if the reference is a parent of the hierarchical child
reference.
- isPreferencesTunnel() - Method in class org.restlet.service.TunnelService
-
Indicates if the client preferences can be tunneled via the query
parameters or via file extensions.
- isProvisional() - Method in class org.restlet.Response
-
Indicates if the response is provisional or final.
- isQueryTunnel() - Method in class org.restlet.service.TunnelService
-
Indicates if the method and client preferences can be tunneled via query
parameters or file extensions.
- isReadable() - Method in class org.restlet.util.SelectionRegistration
-
Indicates if the NIO channel is readable.
- isRechallenging() - Method in class org.restlet.security.ChallengeAuthenticator
-
Indicates if a new challenge should be sent when invalid credentials are
received (true by default to conform to HTTP recommendations).
- isRecoverableError() - Method in class org.restlet.data.Status
-
Indicates if an error is recoverable, meaning that simply retrying after
a delay could result in a success.
- isRedirection(int) - Static method in class org.restlet.data.Status
-
Indicates if the status is a redirection status, meaning "Further action
must be taken in order to complete the request".
- isRedirection() - Method in class org.restlet.data.Status
-
Indicates if the status is a redirection status, meaning "Further action
must be taken in order to complete the request".
- isRelative() - Method in class org.restlet.data.Reference
-
Indicates if the reference is relative.
- isReplying() - Method in class org.restlet.data.Method
-
Indicates if the method replies with a response.
- isRequestEntityBuffering() - Method in class org.restlet.resource.ClientResource
-
Indicates if transient or unknown size response entities should be
buffered after being received.
- isRequired() - Method in class org.restlet.routing.Variable
-
Returns true if the variable is required or optional.
- isReserved(int) - Static method in class org.restlet.data.Reference
-
Indicates if the given character is a reserved URI character.
- isResponseEntityBuffering() - Method in class org.restlet.resource.ClientResource
-
Indicates if transient or unknown size response entities should be
buffered after being received.
- isRetryOnError() - Method in class org.restlet.resource.ClientResource
-
Indicates if idempotent requests should be retried on error.
- isSafe() - Method in class org.restlet.data.Method
-
Indicates if it should have the significance of taking an action other
than retrieval.
- isSecure() - Method in class org.restlet.data.CookieSetting
-
Indicates if cookie should only be transmitted by secure means.
- isSelectable() - Method in class org.restlet.representation.Representation
-
Indicates if the representation content supports NIO selection.
- isSelectable() - Method in class org.restlet.util.WrapperRepresentation
-
- isServerError(int) - Static method in class org.restlet.data.Status
-
Indicates if the status is a server error status, meaning "The server
failed to fulfill an apparently valid request".
- isServerError() - Method in class org.restlet.data.Status
-
Indicates if the status is a server error status, meaning "The server
failed to fulfill an apparently valid request".
- isShutdown() - Method in class org.restlet.service.TaskService
-
Returns true if this executor has been shut down.
- isShutdownAllowed() - Method in class org.restlet.service.TaskService
-
- isSkippingResourceForCorsOptions() - Method in class org.restlet.service.CorsService
-
If true, the filter does not call the server resource for OPTIONS method
of CORS request and set Access-Control-Allow-Methods header with
the default methods.
- isStale() - Method in class org.restlet.data.ChallengeRequest
-
Indicates if the previous request from the client was stale.
- isStarted() - Method in class org.restlet.Restlet
-
Indicates if the Restlet is started.
- isStarted() - Method in class org.restlet.security.Realm
-
Indicates if the realm is started.
- isStarted() - Method in class org.restlet.service.Service
-
Indicates if the service is started.
- isStarted() - Method in class org.restlet.util.WrapperRestlet
-
- isStopped() - Method in class org.restlet.Restlet
-
Indicates if the Restlet is stopped.
- isStopped() - Method in class org.restlet.security.Realm
-
Indicates if the realm is stopped.
- isStopped() - Method in class org.restlet.service.Service
-
Indicates if the service is stopped.
- isStopped() - Method in class org.restlet.util.WrapperRestlet
-
- isStrict() - Method in class org.restlet.service.ConnegService
-
Indicates if the conneg algorithm should strictly respect client
preferences or be more flexible.
- isSubDelimiter(int) - Static method in class org.restlet.data.Reference
-
Indicates if the given character is an URI subcomponent delimiter
character.
- isSuccess(int) - Static method in class org.restlet.data.Status
-
Indicates if the status is a success status, meaning "The action was
successfully received, understood, and accepted".
- isSuccess() - Method in class org.restlet.data.Status
-
Indicates if the status is a success status, meaning "The action was
successfully received, understood, and accepted".
- isSynchronous() - Method in class org.restlet.Request
-
Indicates if the request is synchronous.
- isSynchronous() - Method in class org.restlet.util.WrapperRequest
-
- isTerminated() - Method in class org.restlet.service.TaskService
-
Returns true if all tasks have completed following shut down.
- isTransient() - Method in class org.restlet.representation.Representation
-
Indicates if the representation's content is transient, which means that
it can be obtained only once.
- isTransient() - Method in class org.restlet.util.WrapperRepresentation
-
- isUnreserved(int) - Static method in class org.restlet.data.Reference
-
Indicates if the given character is an unreserved URI character.
- isUserAgentTunnel() - Method in class org.restlet.service.TunnelService
-
Indicates if the client preferences can be tunneled according to the user
agent.
- isValid(int) - Static method in class org.restlet.data.Reference
-
Indicates if the given character is a valid URI character.
- isWeak() - Method in class org.restlet.data.Tag
-
Indicates if the tag is weak.
- isWritable() - Method in class org.restlet.util.SelectionRegistration
-
Indicates if the NIO channel is writable.
- iterator() - Method in class org.restlet.util.WrapperList
-
Returns an iterator over the elements in this list in proper sequence.
- schedule(Callable<V>, long, TimeUnit) - Method in class org.restlet.service.TaskService
-
Creates and executes a ScheduledFuture that becomes enabled after the
given delay.
- schedule(Runnable, long, TimeUnit) - Method in class org.restlet.service.TaskService
-
Creates and executes a one-shot action that becomes enabled after the
given delay.
- scheduleAtFixedRate(Runnable, long, long, TimeUnit) - Method in class org.restlet.service.TaskService
-
Creates and executes a periodic action that becomes enabled first after
the given initial delay, and subsequently with the given period; that is
executions will commence after initialDelay then
initialDelay+period, then initialDelay + 2 * period,
and so on.
- scheduleWithFixedDelay(Runnable, long, long, TimeUnit) - Method in class org.restlet.service.TaskService
-
Creates and executes a periodic action that becomes enabled first after
the given initial delay, and subsequently with the given delay between
the termination of one execution and the commencement of the next.
- score(Request, Response) - Method in class org.restlet.routing.Route
-
Returns the score for a given call (between 0 and 1.0).
- score(Request, Response) - Method in class org.restlet.routing.TemplateRoute
-
Returns the score for a given call (between 0 and 1.0).
- SDC - Static variable in class org.restlet.data.ChallengeScheme
-
Secure Data Connector scheme.
- SDC - Static variable in class org.restlet.data.Protocol
-
SDC (Secure Data Connector) protocol.
- SecretVerifier - Class in org.restlet.security
-
Verifier of identifier/secret couples.
- SecretVerifier() - Constructor for class org.restlet.security.SecretVerifier
-
- SelectionListener - Interface in org.restlet.util
-
Callback interface when a NIO selection occurs on the selectable object.
- SelectionRegistration - Class in org.restlet.util
-
Represents a unique registration between a NIO selector and a selectable
channel.
- SelectionRegistration(int, SelectionListener, WakeupListener) - Constructor for class org.restlet.util.SelectionRegistration
-
Constructor.
- SelectionRegistration(SelectableChannel, int, SelectionListener, WakeupListener) - Constructor for class org.restlet.util.SelectionRegistration
-
Constructor.
- Series<T extends NamedValue<java.lang.String>> - Class in org.restlet.util
-
Modifiable list of entries with many helper methods.
- Series(Class<T>) - Constructor for class org.restlet.util.Series
-
Constructor.
- Series(Class<T>, int) - Constructor for class org.restlet.util.Series
-
Constructor.
- Series(Class<T>, List<T>) - Constructor for class org.restlet.util.Series
-
Constructor.
- Server - Class in org.restlet
-
Connector acting as a generic server.
- Server(Context, List<Protocol>, int, Restlet) - Constructor for class org.restlet.Server
-
Constructor.
- Server(Context, List<Protocol>, String, int, Restlet) - Constructor for class org.restlet.Server
-
Constructor.
- Server(Context, List<Protocol>, String, int, Restlet, String) - Constructor for class org.restlet.Server
-
Constructor.
- Server(Context, Protocol) - Constructor for class org.restlet.Server
-
Constructor.
- Server(Context, Protocol, Class<? extends ServerResource>) - Constructor for class org.restlet.Server
-
Constructor.
- Server(Context, Protocol, int) - Constructor for class org.restlet.Server
-
Constructor.
- Server(Context, Protocol, int, Class<? extends ServerResource>) - Constructor for class org.restlet.Server
-
Constructor.
- Server(Context, Protocol, int, Restlet) - Constructor for class org.restlet.Server
-
Constructor.
- Server(Context, Protocol, Restlet) - Constructor for class org.restlet.Server
-
Constructor using the protocol's default port.
- Server(Context, Protocol, String, int, Restlet) - Constructor for class org.restlet.Server
-
Constructor.
- Server(List<Protocol>, int, Restlet) - Constructor for class org.restlet.Server
-
Constructor.
- Server(List<Protocol>, String, int, Restlet) - Constructor for class org.restlet.Server
-
Constructor.
- Server(Protocol) - Constructor for class org.restlet.Server
-
Constructor.
- Server(Protocol, Class<? extends ServerResource>) - Constructor for class org.restlet.Server
-
Constructor using the protocol's default port.
- Server(Protocol, int) - Constructor for class org.restlet.Server
-
Constructor.
- Server(Protocol, int, Class<? extends ServerResource>) - Constructor for class org.restlet.Server
-
Constructor.
- Server(Protocol, int, Restlet) - Constructor for class org.restlet.Server
-
Constructor.
- Server(Protocol, Restlet) - Constructor for class org.restlet.Server
-
Constructor using the protocol's default port.
- Server(Protocol, String) - Constructor for class org.restlet.Server
-
Constructor using the protocol's default port.
- Server(Protocol, String, Class<? extends ServerResource>) - Constructor for class org.restlet.Server
-
Constructor using the protocol's default port.
- Server(Protocol, String, int) - Constructor for class org.restlet.Server
-
Constructor.
- Server(Protocol, String, int, Restlet) - Constructor for class org.restlet.Server
-
Constructor.
- Server(Protocol, String, Restlet) - Constructor for class org.restlet.Server
-
Constructor using the protocol's default port.
- SERVER_ERROR_BAD_GATEWAY - Static variable in class org.restlet.data.Status
-
The server, while acting as a gateway or proxy, received an invalid
response from the upstream server it accessed in attempting to fulfill
the request.
- SERVER_ERROR_GATEWAY_TIMEOUT - Static variable in class org.restlet.data.Status
-
The server, while acting as a gateway or proxy, could not connect to the
upstream server.
- SERVER_ERROR_INSUFFICIENT_STORAGE - Static variable in class org.restlet.data.Status
-
This status code means the method could not be performed on the resource
because the server is unable to store the representation needed to
successfully complete the request.
- SERVER_ERROR_INTERNAL - Static variable in class org.restlet.data.Status
-
The server encountered an unexpected condition which prevented it from
fulfilling the request.
- SERVER_ERROR_NOT_IMPLEMENTED - Static variable in class org.restlet.data.Status
-
The server does not support the functionality required to fulfill the
request.
- SERVER_ERROR_SERVICE_UNAVAILABLE - Static variable in class org.restlet.data.Status
-
The server is currently unable to handle the request due to a temporary
overloading or maintenance of the server.
- SERVER_ERROR_VERSION_NOT_SUPPORTED - Static variable in class org.restlet.data.Status
-
The server does not support, or refuses to support, the HTTP protocol
version that was used in the request message.
- ServerInfo - Class in org.restlet.data
-
Server specific data related to a call.
- ServerInfo() - Constructor for class org.restlet.data.ServerInfo
-
Constructor.
- ServerList - Class in org.restlet.util
-
Modifiable list of server connectors.
- ServerList(Context, Restlet) - Constructor for class org.restlet.util.ServerList
-
Constructor.
- serverRedirect(Restlet, Reference, Request, Response) - Method in class org.restlet.routing.Redirector
-
Redirects a given call on the server-side to a next Restlet with a given
target reference.
- ServerResource - Class in org.restlet.resource
-
Base class for server-side resources.
- ServerResource() - Constructor for class org.restlet.resource.ServerResource
-
Default constructor.
- Service - Class in org.restlet.service
-
Generic service associated to a component or an application.
- Service() - Constructor for class org.restlet.service.Service
-
Constructor.
- Service(boolean) - Constructor for class org.restlet.service.Service
-
Constructor.
- ServiceList - Class in org.restlet.util
-
Modifiable list of services.
- ServiceList(Context) - Constructor for class org.restlet.util.ServiceList
-
Constructor.
- set(String, String) - Method in class org.restlet.util.Series
-
Replaces the value of the first parameter with the given name and removes
all other parameters with the same name.
- set(String, String, boolean) - Method in class org.restlet.util.Series
-
Replaces the value of the first parameter with the given name and removes
all other parameters with the same name.
- set(List<Service>) - Method in class org.restlet.util.ServiceList
-
Sets the list of services.
- set(Service) - Method in class org.restlet.util.ServiceList
-
Replaces or adds a service.
- set(int, E) - Method in class org.restlet.util.WrapperList
-
Replaces the element at the specified position in this list with the
specified element.
- setAcceptedCharacterSets(List<Preference<CharacterSet>>) - Method in class org.restlet.data.ClientInfo
-
Sets the character set preferences.
- setAcceptedEncodings(List<Preference<Encoding>>) - Method in class org.restlet.data.ClientInfo
-
Sets the encoding preferences.
- setAcceptedLanguages(List<Preference<Language>>) - Method in class org.restlet.data.ClientInfo
-
Sets the language preferences.
- setAcceptedMediaTypes(List<Preference<MediaType>>) - Method in class org.restlet.data.ClientInfo
-
Sets the media type preferences.
- setAcceptedPatches(List<Preference<MediaType>>) - Method in class org.restlet.data.ClientInfo
-
Sets the patch preferences.
- setAcceptingRanges(boolean) - Method in class org.restlet.data.ServerInfo
-
Indicates if the server accepts range requests for a resource, with the
"byte" range unit.
- setAccessControlAllowCredentials(Boolean) - Method in class org.restlet.Response
-
When used as part of a response to a preflight CORS request, indicates
whether or not the actual request can be made using credentials.
- setAccessControlAllowHeaders(Set<String>) - Method in class org.restlet.Response
-
Sets the set of headers allowed by the actual request on the current
resource when used as part of a response to a preflight CORS request.
- setAccessControlAllowMethods(Set<Method>) - Method in class org.restlet.Response
-
Sets the set of methods allowed by the actual request on the current
resource when used as part of a response to a preflight CORS request.
- setAccessControlAllowOrigin(String) - Method in class org.restlet.Response
-
When used in the context of CORS support, it sets the URI an origin
server allows for the requested resource.
- setAccessControlExposeHeaders(Set<String>) - Method in class org.restlet.Response
-
Sets the list of headers an origin server allows for the requested
resource.
- setAccessControlMaxAge(int) - Method in class org.restlet.Response
-
When used as part of a response to a preflight CORS request, indicates how long (in seconds) the results of a
preflight request can be cached in a preflight result cache.
- setAccessControlRequestHeaders(Set<String>) - Method in class org.restlet.Request
-
Sets the set of headers the client is willing to use in future request to
this resource.
- setAccessControlRequestHeaders(Set<String>) - Method in class org.restlet.util.WrapperRequest
-
Sets the access control request headers of the target resource.
- setAccessControlRequestMethod(Method) - Method in class org.restlet.Request
-
Sets the method the client is willing to use in future request to this
resource.
- setAccessControlRequestMethod(Method) - Method in class org.restlet.util.WrapperRequest
-
Sets the access control request method of the target resource.
- setAccessRestricted(boolean) - Method in class org.restlet.data.CookieSetting
-
Indicates whether to restrict cookie access to untrusted parties.
- setAddress(String) - Method in class org.restlet.data.ClientInfo
-
Sets the client's IP address.
- setAddress(String) - Method in class org.restlet.data.ServerInfo
-
Sets the IP address which received the call.
- setAddress(String) - Method in class org.restlet.Server
-
Sets the optional listening IP address (local host used if null).
- setAge(int) - Method in class org.restlet.Response
-
Sets the estimated amount of time since a response was generated or
revalidated by the origin server.
- setAge(int) - Method in class org.restlet.util.WrapperResponse
-
- setAgent(String) - Method in class org.restlet.data.ClientInfo
-
Sets the agent name (ex: "Restlet-Framework/2.0").
- setAgent(String) - Method in class org.restlet.data.ServerInfo
-
Sets the agent name (ex: "Restlet-Framework/2.0").
- setAgent(String) - Method in class org.restlet.data.Warning
-
Sets the agent.
- setAgentAttributes(Map<String, String>) - Method in class org.restlet.data.ClientInfo
-
Sets a list of attributes taken from the name of the user agent.
- setAgentProducts(List<Product>) - Method in class org.restlet.data.ClientInfo
-
Sets the list of product tokens from the user agent name.
- setAllowedCredentials(boolean) - Method in class org.restlet.service.CorsService
-
If true, adds 'Access-Control-Allow-Credentials' header.
- setAllowedHeaders(Set<String>) - Method in class org.restlet.service.CorsService
-
Sets the value of the 'Access-Control-Allow-Headers' response header.
- setAllowedMethods(Set<Method>) - Method in class org.restlet.resource.ServerResource
-
Sets the set of methods allowed on the requested resource.
- setAllowedMethods(Set<Method>) - Method in class org.restlet.Response
-
Sets the set of methods allowed on the requested resource.
- setAllowedMethods(Set<Method>) - Method in class org.restlet.util.WrapperResponse
-
- setAllowedOrigins(Set<String>) - Method in class org.restlet.service.CorsService
-
Sets the value of 'Access-Control-Allow-Origin' header.
- setAllowingAllRequestedHeaders(boolean) - Method in class org.restlet.service.CorsService
-
If true, copies the value of 'Access-Control-Request-Headers' request
header into the 'Access-Control-Allow-Headers' response header.
- setAnnotated(boolean) - Method in class org.restlet.resource.ServerResource
-
Indicates if annotations are supported.
- setAnonymousMethods(List<Method>) - Method in class org.restlet.security.MethodAuthorizer
-
Sets the modifiable list of methods authorized for anonymous users.
- setApplication(Application) - Method in class org.restlet.resource.Resource
-
Sets the parent application.
- setApplication(Application) - Method in class org.restlet.security.Role
-
Sets the parent application.
- setAttribute(String, Object) - Method in class org.restlet.resource.ClientResource
-
Sets the request attribute value.
- setAttribute(String, Object) - Method in class org.restlet.resource.Resource
-
Sets the request or response attribute value.
- setAttribute(String, Object) - Method in class org.restlet.resource.ServerResource
-
Sets the response attribute value.
- setAttributes(Map<String, Object>) - Method in class org.restlet.Context
-
Sets the modifiable map of attributes.
- setAttributes(Map<String, Object>) - Method in class org.restlet.Message
-
Sets the modifiable map of attributes.
- setAuthenticated(boolean) - Method in class org.restlet.data.ClientInfo
-
Indicates if the identifier or principal has been authenticated.
- setAuthenticatedMethods(List<Method>) - Method in class org.restlet.security.MethodAuthorizer
-
Sets the modifiable list of methods authorized for authenticated users.
- setAuthenticationInfo(AuthenticationInfo) - Method in class org.restlet.Response
-
Sets the authentication information sent by an origin server to a client
after a successful authentication attempt.
- setAuthenticationInfo(AuthenticationInfo) - Method in class org.restlet.util.WrapperResponse
-
- setAuthor(String) - Method in class org.restlet.Restlet
-
Sets the author(s).
- setAuthor(String) - Method in class org.restlet.util.WrapperRestlet
-
- setAuthority(String) - Method in class org.restlet.data.Reference
-
Sets the authority component for hierarchical identifiers.
- setAuthorizedRoles(List<Role>) - Method in class org.restlet.security.RoleAuthorizer
-
Sets the modifiable list of authorized roles.
- setAutoCommitting(boolean) - Method in class org.restlet.resource.ServerResource
-
Indicates if the response should be automatically committed.
- setAutoCommitting(boolean) - Method in class org.restlet.Response
-
Indicates if the response should be automatically committed.
- setAutoCommitting(boolean) - Method in class org.restlet.util.WrapperResponse
-
- setAutoDeleting(boolean) - Method in class org.restlet.representation.FileRepresentation
-
Indicates if this file should be automatically deleted on release of the
representation.
- setAvailable(boolean) - Method in class org.restlet.representation.Representation
-
Indicates if some fresh content is available.
- setAvailable(boolean) - Method in class org.restlet.util.WrapperRepresentation
-
- setBaseRef(Reference) - Method in class org.restlet.data.Reference
-
Sets the base reference for relative references.
- setBaseRef(String) - Method in class org.restlet.data.Reference
-
Sets the base reference for relative references.
- setBuffer(byte[]) - Method in class org.restlet.representation.BufferingRepresentation
-
Sets the buffered content as an array of bytes.
- setBuffered(boolean) - Method in class org.restlet.representation.BufferingRepresentation
-
Indicates if the wrapped entity has been already buffered.
- setCacheDirectives(List<CacheDirective>) - Method in class org.restlet.Message
-
Sets the cache directives.
- setCanceling(boolean) - Method in class org.restlet.util.SelectionRegistration
-
Sets interest in canceling the registration.
- setCertificates(List<Certificate>) - Method in class org.restlet.data.ClientInfo
-
Sets the new client certificates.
- setChallengeRequests(List<ChallengeRequest>) - Method in class org.restlet.resource.ServerResource
-
Sets the list of authentication requests sent by an origin server to a
client.
- setChallengeRequests(List<ChallengeRequest>) - Method in class org.restlet.Response
-
Sets the list of authentication requests sent by an origin server to a
client.
- setChallengeRequests(List<ChallengeRequest>) - Method in class org.restlet.util.WrapperResponse
-
Sets the list of authentication requests sent by an origin server to a
client.
- setChallengeResponse(ChallengeResponse) - Method in class org.restlet.Request
-
Sets the authentication response sent by a client to an origin server.
- setChallengeResponse(ChallengeResponse) - Method in class org.restlet.resource.ClientResource
-
Sets the authentication response sent by a client to an origin server.
- setChallengeResponse(ChallengeScheme, String, String) - Method in class org.restlet.resource.ClientResource
-
Sets the authentication response sent by a client to an origin server
given a scheme, identifier and secret.
- setChallengeResponse(ChallengeResponse) - Method in class org.restlet.util.WrapperRequest
-
Sets the authentication response sent by a client to an origin server.
- setChannel(ReadableByteChannel) - Method in class org.restlet.representation.ReadableRepresentation
-
Sets the readable channel.
- setCharacterSet(CharacterSet) - Method in class org.restlet.representation.StringRepresentation
-
- setCharacterSet(CharacterSet) - Method in class org.restlet.representation.Variant
-
Sets the character set or null if not applicable.
- setCharacterSet(CharacterSet) - Method in class org.restlet.util.WrapperRepresentation
-
- setCharacterSetParameter(String) - Method in class org.restlet.service.TunnelService
-
Sets the character set parameter name.
- setChildRoles(List<Role>) - Method in class org.restlet.security.Role
-
Sets the modifiable list of child roles.
- setCipherSuite(String) - Method in class org.restlet.data.ClientInfo
-
Sets the SSL Cipher Suite, if available and accessible.
- setClientDispatcher(Restlet) - Method in class org.restlet.Context
-
Sets the client dispatcher.
- setClientInfo(ClientInfo) - Method in class org.restlet.Request
-
Sets the client-specific information.
- setClientInfo(ClientInfo) - Method in class org.restlet.resource.ClientResource
-
Sets the client-specific information.
- setClientInfo(ClientInfo) - Method in class org.restlet.util.WrapperRequest
-
- setClientNonce(String) - Method in class org.restlet.data.AuthenticationInfo
-
Sets the client nonce.
- setClientNonce(String) - Method in class org.restlet.data.ChallengeResponse
-
Sets the client nonce.
- setClientProtocols(List<Protocol>) - Method in class org.restlet.service.ConnectorService
-
Sets the modifiable list of required client protocols.
- setClients(ClientList) - Method in class org.restlet.Component
-
Sets the modifiable list of client connectors.
- setComment(String) - Method in class org.restlet.data.CookieSetting
-
Sets the comment for the user.
- setComment(String) - Method in class org.restlet.data.Product
-
Sets the facultative comment.
- setComment(String) - Method in class org.restlet.data.RecipientInfo
-
Sets the optional comment, typically the software agent name.
- setCommitted(boolean) - Method in class org.restlet.resource.ServerResource
-
Indicates if the response has already been committed.
- setCommitted(boolean) - Method in class org.restlet.Response
-
Indicates if the response has already been committed.
- setCommitted(boolean) - Method in class org.restlet.util.WrapperResponse
-
- setComparator(Comparator<Reference>) - Method in class org.restlet.resource.Directory
-
Sets the reference comparator used to sort index pages.
- setConditional(boolean) - Method in class org.restlet.resource.ServerResource
-
Indicates if conditional handling is enabled.
- setConditions(Conditions) - Method in class org.restlet.Request
-
Sets the conditions applying to this request.
- setConditions(Conditions) - Method in class org.restlet.resource.ClientResource
-
Sets the conditions applying to this request.
- setConditions(Conditions) - Method in class org.restlet.util.WrapperRequest
-
- setConnectorService(ConnectorService) - Method in class org.restlet.Application
-
Sets the connector service.
- setConnegService(ConnegService) - Method in class org.restlet.Application
-
Sets the content negotiation service.
- setConnegService(ConnegService) - Method in class org.restlet.service.StatusService
-
Sets the service used to select the preferred variant.
- setContactEmail(String) - Method in class org.restlet.service.StatusService
-
Sets the email address to contact in case of error.
- setContext(Context) - Method in class org.restlet.Application
-
- setContext(Context) - Method in class org.restlet.Component
-
- setContext(Context) - Method in class org.restlet.Restlet
-
Sets the context.
- setContext(Context) - Method in class org.restlet.routing.VirtualHost
-
- setContext(Context) - Method in class org.restlet.service.Service
-
Sets the context.
- setContext(Context) - Method in class org.restlet.util.ClientList
-
Sets the context.
- setContext(Context) - Method in class org.restlet.util.ServerList
-
Sets the context.
- setContext(Context) - Method in class org.restlet.util.ServiceList
-
Sets the context.
- setContext(Context) - Method in class org.restlet.util.WrapperRestlet
-
- setConverterService(ConverterService) - Method in class org.restlet.Application
-
Sets the converter service.
- setConverterService(ConverterService) - Method in class org.restlet.service.StatusService
-
Sets the service used to convert between status/throwable and
representation.
- setCookies(Series<Cookie>) - Method in class org.restlet.Request
-
Sets the modifiable series of cookies provided by the client.
- setCookies(Series<Cookie>) - Method in class org.restlet.resource.ClientResource
-
Sets the cookies provided by the client.
- setCookies(Series<Cookie>) - Method in class org.restlet.util.WrapperRequest
-
- setCookieSettings(Series<CookieSetting>) - Method in class org.restlet.resource.ServerResource
-
Sets the cookie settings provided by the server.
- setCookieSettings(Series<CookieSetting>) - Method in class org.restlet.Response
-
Sets the modifiable series of cookie settings provided by the server.
- setCookieSettings(Series<CookieSetting>) - Method in class org.restlet.util.WrapperResponse
-
- setCorePoolSize(int) - Method in class org.restlet.service.TaskService
-
Sets the core pool size defining the maximum number of threads.
- setCreationDate(Date) - Method in class org.restlet.data.Disposition
-
Sets the creation date parameter.
- setCurrent(Application) - Static method in class org.restlet.Application
-
Sets the context to associated with the current thread.
- setCurrent(Context) - Static method in class org.restlet.Context
-
Sets the context to associated with the current thread.
- setCurrent(Response) - Static method in class org.restlet.Response
-
Sets the response associated with the current thread.
- setCurrent(Integer) - Static method in class org.restlet.routing.VirtualHost
-
Sets the virtual host code associated with the current thread.
- setDaemon(boolean) - Method in class org.restlet.service.TaskService
-
Indicates whether or not the threads are daemon threads.
- setDate(String, Date) - Method in class org.restlet.data.Disposition
-
Sets a Date parameter.
- setDate(Date) - Method in class org.restlet.data.Warning
-
Sets the warning date.
- setDate(Date) - Method in class org.restlet.Message
-
Sets the date and time at which the message was originated.
- setDebugging(boolean) - Method in class org.restlet.Application
-
Indicates if the debugging mode is enabled.
- setDebugging(boolean) - Method in class org.restlet.service.LogService
-
- setDecoderService(DecoderService) - Method in class org.restlet.Application
-
Sets the decoder service.
- setDecodingOnParse(boolean) - Method in class org.restlet.routing.Variable
-
Indicates if the parsed value must be decoded.
- setDeeplyAccessible(boolean) - Method in class org.restlet.resource.Directory
-
Indicates if the sub-directories are deeply accessible (true by default).
- setDefaultAllowedMethods(Set<Method>) - Method in class org.restlet.service.CorsService
-
- setDefaultCharacterSet(CharacterSet) - Method in class org.restlet.service.MetadataService
-
Sets the default character set for local representations.
- setDefaultEncoding(Encoding) - Method in class org.restlet.service.MetadataService
-
Sets the default encoding for local representations.
- setDefaultEnroler(Enroler) - Method in class org.restlet.Context
-
Sets an enroler that can add the user roles based on authenticated user
principals.
- setDefaultHost(VirtualHost) - Method in class org.restlet.Component
-
Sets the default virtual host.
- setDefaultLanguage(Language) - Method in class org.restlet.service.MetadataService
-
Sets the default language for local representations.
- setDefaultMatchingMode(int) - Method in class org.restlet.routing.Router
-
Sets the default matching mode to use when selecting routes based on
URIs.
- setDefaultMatchingQuery(boolean) - Method in class org.restlet.routing.Router
-
Sets the default setting for whether the routing should be done on URIs
with or without taking into account query string.
- setDefaultMediaType(MediaType) - Method in class org.restlet.service.MetadataService
-
Sets the default media type for local representations.
- setDefaultRoute(Route) - Method in class org.restlet.routing.Router
-
Sets the default route tested if no other one was available.
- setDefaultValue(String) - Method in class org.restlet.routing.Variable
-
Sets the default value to use if the key couldn't be found in the model.
- setDefaultVariable(Variable) - Method in class org.restlet.routing.Template
-
Sets the variable to use, if no variable is given.
- setDefaultVerifier(Verifier) - Method in class org.restlet.Context
-
Sets a local verifier that can check the validity of user/secret couples
based on Restlet default authorization model.
- setDescription(String) - Method in class org.restlet.resource.ServerResource
-
Sets the description.
- setDescription(String) - Method in class org.restlet.Restlet
-
Sets the description.
- setDescription(String) - Method in class org.restlet.security.Group
-
Sets the description.
- setDescription(String) - Method in class org.restlet.security.Role
-
Sets the description.
- setDescription(String) - Method in class org.restlet.util.WrapperRestlet
-
- setDigest(Digest) - Method in class org.restlet.representation.Representation
-
Sets the representation digest.
- setDigest(Digest) - Method in class org.restlet.util.WrapperRepresentation
-
- setDigestAlgorithm(String) - Method in class org.restlet.data.ChallengeMessage
-
Sets the digest algorithm.
- setDigestRef(Reference) - Method in class org.restlet.data.ChallengeResponse
-
Sets the digest URI reference.
- setDigit(boolean) - Method in class org.restlet.data.CacheDirective
-
Indicates if the directive is a digit value.
- setDimensions(Set<Dimension>) - Method in class org.restlet.resource.ServerResource
-
Sets the set of dimensions on which the response entity may vary.
- setDimensions(Set<Dimension>) - Method in class org.restlet.Response
-
Sets the set of dimensions on which the response entity may vary.
- setDimensions(Set<Dimension>) - Method in class org.restlet.util.WrapperResponse
-
- setDisposition(Disposition) - Method in class org.restlet.representation.Representation
-
Sets the disposition characteristics of the representation.
- setDisposition(Disposition) - Method in class org.restlet.util.WrapperRepresentation
-
- setDomain(String) - Method in class org.restlet.data.Cookie
-
Sets the domain name.
- setDomainRefs(List<Reference>) - Method in class org.restlet.data.ChallengeRequest
-
Sets the URI references that define the protection domains for the digest
authentication.
- setDomainUris(Collection<String>) - Method in class org.restlet.data.ChallengeRequest
-
Sets the URI references that define the protection domains for the digest
authentication.
- setEmail(String) - Method in class org.restlet.security.User
-
Sets the email.
- setEnabled(boolean) - Method in class org.restlet.service.Service
-
Indicates if the service should be enabled.
- setEncoderService(EncoderService) - Method in class org.restlet.Application
-
Sets the encoder service.
- setEncodingOnFormat(boolean) - Method in class org.restlet.routing.Variable
-
Indicates if the formatted value must be encoded.
- setEncodingParameter(String) - Method in class org.restlet.service.TunnelService
-
Sets the name of the parameter containing the accepted encoding.
- setEncodings(List<Encoding>) - Method in class org.restlet.representation.Variant
-
Sets the list of encodings applied to the entity-body.
- setEncodings(List<Encoding>) - Method in class org.restlet.util.WrapperRepresentation
-
- setEncodingVariables(boolean) - Method in class org.restlet.routing.Template
-
Indicates if the variables must be encoded when formatting the template.
- setEnroler(Enroler) - Method in class org.restlet.security.Authenticator
-
Sets the enroler invoked upon successful authentication.
- setEnroler(Enroler) - Method in class org.restlet.security.Realm
-
Sets an enroler that can add the user roles based on user principals.
- setEntity(Representation) - Method in class org.restlet.Message
-
Sets the entity representation.
- setEntity(String, MediaType) - Method in class org.restlet.Message
-
Sets a textual entity.
- setEntity(Representation) - Method in class org.restlet.util.WrapperRequest
-
Sets the entity representation.
- setEntity(String, MediaType) - Method in class org.restlet.util.WrapperRequest
-
Sets a textual entity.
- setEntity(Representation) - Method in class org.restlet.util.WrapperResponse
-
Sets the entity representation.
- setEntity(String, MediaType) - Method in class org.restlet.util.WrapperResponse
-
Sets a textual entity.
- setEntityBuffering(boolean) - Method in class org.restlet.resource.ClientResource
-
Indicates if transient entities should be buffered after being received
or before being sent.
- setExecutorService(ScheduledExecutorService) - Method in class org.restlet.Context
-
Sets the executor service.
- setExisting(boolean) - Method in class org.restlet.resource.ServerResource
-
Indicates if the identified resource exists.
- setExpectations(List<Expectation>) - Method in class org.restlet.data.ClientInfo
-
Sets the client expectations.
- setExpirationDate(Date) - Method in class org.restlet.representation.Representation
-
Sets the future date when this representation expire.
- setExpirationDate(Date) - Method in class org.restlet.util.WrapperRepresentation
-
- setExposedHeaders(Set<String>) - Method in class org.restlet.service.CorsService
-
Sets the value of 'Access-Control-Expose-Headers' response header.
- setExtensions(String) - Method in class org.restlet.data.Reference
-
Sets the extensions for hierarchical identifiers.
- setExtensions(String[]) - Method in class org.restlet.data.Reference
-
Sets the extensions based on an array of extension tokens (without dots).
- setExtensionsTunnel(boolean) - Method in class org.restlet.service.TunnelService
-
Indicates if the client preferences can be tunneled via the extensions.
- setFile(File) - Method in class org.restlet.representation.FileRepresentation
-
Sets the file handle.
- setFilename(String) - Method in class org.restlet.data.Disposition
-
Sets the value of the "filename" parameter.
- setFinderClass(Class<? extends Finder>) - Method in class org.restlet.Restlet
-
Sets the finder class to instantiate.
- setFirstName(String) - Method in class org.restlet.security.User
-
Sets the first name.
- setFixed(boolean) - Method in class org.restlet.routing.Variable
-
Indicates if the value is fixed
- setFollowingRedirects(boolean) - Method in class org.restlet.resource.ClientResource
-
Indicates if redirections are followed.
- setForbiddenRoles(List<Role>) - Method in class org.restlet.security.RoleAuthorizer
-
Sets the modifiable list of forbidden roles.
- setForwardedAddresses(List<String>) - Method in class org.restlet.data.ClientInfo
-
Sets the list of forwarded IP addresses.
- setFragment(String) - Method in class org.restlet.data.Reference
-
Sets the fragment identifier.
- setFrom(String) - Method in class org.restlet.data.ClientInfo
-
Sets the email address of the human user controlling the user agent.
- setHeadersCleaning(boolean) - Method in class org.restlet.routing.Redirector
-
Indicates if the headers must be cleaned.
- setHeadersTunnel(boolean) - Method in class org.restlet.service.TunnelService
-
Indicates if the method can be tunneled via the header.
- setHomeRef(Reference) - Method in class org.restlet.service.StatusService
-
Sets the home URI to propose in case of error.
- setHostDomain(String) - Method in class org.restlet.data.Reference
-
Sets the host domain component for server based hierarchical identifiers.
- setHostDomain(String) - Method in class org.restlet.routing.VirtualHost
-
Sets the hostRef host domain to match.
- setHostPort(Integer) - Method in class org.restlet.data.Reference
-
Sets the optional port number for server based hierarchical identifiers.
- setHostPort(String) - Method in class org.restlet.routing.VirtualHost
-
Sets the hostRef host port to match.
- setHostRef(Reference) - Method in class org.restlet.Request
-
Sets the host reference.
- setHostRef(String) - Method in class org.restlet.Request
-
Sets the host reference using an URI string.
- setHostRef(Reference) - Method in class org.restlet.resource.ClientResource
-
Sets the host reference.
- setHostRef(String) - Method in class org.restlet.resource.ClientResource
-
Sets the host reference using an URI string.
- setHostRef(Reference) - Method in class org.restlet.util.WrapperRequest
-
Sets the host reference.
- setHostRef(String) - Method in class org.restlet.util.WrapperRequest
-
Sets the host reference using an URI string.
- setHosts(List<VirtualHost>) - Method in class org.restlet.Component
-
Sets the modifiable list of virtual hosts.
- setHostScheme(String) - Method in class org.restlet.routing.VirtualHost
-
Sets the hostRef scheme to match.
- setIdentifier(String) - Method in class org.restlet.data.ChallengeResponse
-
Sets the user identifier, such as a login name or an access key.
- setIdentifier(String) - Method in class org.restlet.data.Reference
-
Sets the absolute resource identifier.
- setIdentifier(Reference) - Method in class org.restlet.data.ReferenceList
-
Sets the list reference.
- setIdentifier(String) - Method in class org.restlet.data.ReferenceList
-
Sets the list reference.
- setIdentifier(String) - Method in class org.restlet.security.Authorizer
-
Sets the identifier unique within an application.
- setIdentifier(String) - Method in class org.restlet.security.User
-
Sets the identifier.
- setIdentityCheck(boolean) - Method in class org.restlet.service.LogService
-
Indicates if the identity check (as specified by RFC1413) is enabled.
- setInboundRoot(Class<? extends ServerResource>) - Method in class org.restlet.Application
-
Sets the inbound root Resource class.
- setInboundRoot(Restlet) - Method in class org.restlet.Application
-
Sets the inbound root Restlet.
- setIndex(long) - Method in class org.restlet.data.Range
-
Sets the index from which to start the range.
- setIndexName(String) - Method in class org.restlet.resource.Directory
-
Sets the index name, without extensions.
- setInheritingRoles(boolean) - Method in class org.restlet.security.Group
-
Indicates if the roles of the parent group should be inherited.
- setInstanceSize(long) - Method in class org.restlet.data.Range
-
Sets the total size of the instance in number of bytes (or range unit).
- setInterestOperations(int) - Method in class org.restlet.util.SelectionRegistration
-
Sets the IO operations interest.
- setInternalRouter(Router) - Method in class org.restlet.Component
-
Sets the private internal router were Restlets like Applications can be
attached.
- setLanguageParameter(String) - Method in class org.restlet.service.TunnelService
-
Sets the name of the parameter containing the accepted language.
- setLanguages(List<Language>) - Method in class org.restlet.representation.Variant
-
Sets the list of languages.
- setLanguages(List<Language>) - Method in class org.restlet.util.WrapperRepresentation
-
- setLastName(String) - Method in class org.restlet.security.User
-
Sets the last name.
- setLastSegment(String) - Method in class org.restlet.data.Reference
-
Sets the last segment of the path.
- setListener(ReadingListener) - Method in class org.restlet.representation.Representation
-
Sets a listener for NIO read events.
- setListingAllowed(boolean) - Method in class org.restlet.resource.Directory
-
Indicates if the display of directory listings is allowed when no index
file is found.
- setLocalSecrets(Map<String, char[]>) - Method in class org.restlet.security.MapVerifier
-
Sets the modifiable map of local secrets.
- setLocationRef(Reference) - Method in class org.restlet.representation.Variant
-
Sets the optional identifier.
- setLocationRef(String) - Method in class org.restlet.representation.Variant
-
Sets the identifier from a URI string.
- setLocationRef(Reference) - Method in class org.restlet.resource.ServerResource
-
Sets the reference that the client should follow for redirections or
resource creations.
- setLocationRef(String) - Method in class org.restlet.resource.ServerResource
-
Sets the reference that the client should follow for redirections or
resource creations.
- setLocationRef(Reference) - Method in class org.restlet.Response
-
Sets the reference that the client should follow for redirections or
resource creations.
- setLocationRef(String) - Method in class org.restlet.Response
-
Sets the reference that the client should follow for redirections or
resource creations.
- setLocationRef(Reference) - Method in class org.restlet.util.WrapperRepresentation
-
- setLocationRef(String) - Method in class org.restlet.util.WrapperRepresentation
-
- setLocationRef(Reference) - Method in class org.restlet.util.WrapperResponse
-
Sets the reference that the client should follow for redirections or
resource creations.
- setLocationRef(String) - Method in class org.restlet.util.WrapperResponse
-
Sets the reference that the client should follow for redirections or
resource creations.
- setLoggable(boolean) - Method in class org.restlet.Request
-
Indicates if the call is loggable
- setLoggable(boolean) - Method in class org.restlet.resource.ClientResource
-
Indicates if the call is loggable
- setLoggableTemplate(String) - Method in class org.restlet.service.LogService
-
Sets the URI template of loggable resource references.
- setLoggableTemplate(Template) - Method in class org.restlet.service.LogService
-
Sets the URI template of loggable resource references.
- setLogger(Logger) - Method in class org.restlet.Context
-
Sets the logger.
- setLogger(String) - Method in class org.restlet.Context
-
Sets the logger.
- setLogger(Logger) - Method in class org.restlet.routing.Template
-
Sets the logger to use.
- setLoggerName(String) - Method in class org.restlet.service.LogService
-
Sets the name of the JDK's logger to use when logging access calls.
- setLogPropertiesRef(Reference) - Method in class org.restlet.service.LogService
-
Sets the URI reference of the log properties.
- setLogPropertiesRef(String) - Method in class org.restlet.service.LogService
-
Sets the URI reference of the log properties.
- setLogService(LogService) - Method in class org.restlet.Component
-
Sets the global log service.
- setMatch(List<Tag>) - Method in class org.restlet.data.Conditions
-
Sets the modifiable list of tags that must be matched.
- setMatchingMode(int) - Method in class org.restlet.routing.Template
-
Sets the matching mode to use when parsing a formatted reference.
- setMatchingMode(int) - Method in class org.restlet.routing.TemplateRoute
-
Sets the matching mode to use on the template when parsing a formatted
reference.
- setMatchingQuery(boolean) - Method in class org.restlet.routing.TemplateRoute
-
Sets whether the matching should be done on the URI with or without query
string.
- setMaxAge(int) - Method in class org.restlet.data.CookieSetting
-
Sets the maximum age in seconds.
- setMaxAge(int) - Method in class org.restlet.service.CorsService
-
Sets the value of 'Access-Control-Max-Age' response header.
- setMaxAttempts(int) - Method in class org.restlet.routing.Router
-
Sets the maximum number of attempts if no attachment could be matched on
the first attempt.
- setMaxForwards(int) - Method in class org.restlet.Request
-
Sets the maximum number of intermediaries.
- setMaxForwards(int) - Method in class org.restlet.util.WrapperRequest
-
- setMaxRedirects(int) - Method in class org.restlet.resource.ClientResource
-
Sets the maximum number of redirections that can be automatically
followed for a single call.
- setMediaType(MediaType) - Method in class org.restlet.representation.Variant
-
Sets the media type.
- setMediaType(MediaType) - Method in class org.restlet.util.WrapperRepresentation
-
- setMediaTypeParameter(String) - Method in class org.restlet.service.TunnelService
-
Sets the name of the parameter containing the accepted media type.
- setMemberGroups(List<Group>) - Method in class org.restlet.security.Group
-
Sets the modifiable list of member groups.
- setMemberUsers(List<User>) - Method in class org.restlet.security.Group
-
Sets the modifiable list of member user references.
- setMetadata(T) - Method in class org.restlet.data.Preference
-
Sets the metadata associated with this preference.
- setMetadataService(MetadataService) - Method in class org.restlet.Application
-
Sets the metadata service.
- setMetadataService(MetadataService) - Method in class org.restlet.service.StatusService
-
Sets the service used to select the preferred variant.
- setMethod(Method) - Method in class org.restlet.Request
-
Sets the method called.
- setMethod(Method) - Method in class org.restlet.resource.ClientResource
-
Sets the method called.
- setMethod(Method) - Method in class org.restlet.util.WrapperRequest
-
Sets the method called.
- setMethodHeader(String) - Method in class org.restlet.service.TunnelService
-
Sets the name of the header containing the method name.
- setMethodParameter(String) - Method in class org.restlet.service.TunnelService
-
Sets the method parameter name.
- setMethodTunnel(boolean) - Method in class org.restlet.service.TunnelService
-
Indicates if the method name can be tunneled.
- setMinimumSize(long) - Method in class org.restlet.service.EncoderService
-
Sets the minimum size a representation must have before compression is
done.
- setMode(int) - Method in class org.restlet.routing.Redirector
-
Sets the redirection mode.
- setModifiable(boolean) - Method in class org.restlet.resource.Directory
-
Indicates if modifications to local resources are allowed.
- setModificationDate(Date) - Method in class org.restlet.data.Disposition
-
Sets the modification date parameter.
- setModificationDate(Date) - Method in class org.restlet.representation.RepresentationInfo
-
Sets the last date when this representation was modified.
- setModificationDate(Date) - Method in class org.restlet.util.WrapperRepresentation
-
- setModifiedSince(Date) - Method in class org.restlet.data.Conditions
-
Sets the condition based on the modification date of the requested
variant.
- setMultiAuthenticating(boolean) - Method in class org.restlet.security.Authenticator
-
Indicates if the authenticator should attempt to authenticate an already
authenticated client.
- setName(String) - Method in class org.restlet.data.CacheDirective
-
Sets the name.
- setName(String) - Method in class org.restlet.data.Cookie
-
Sets the name.
- setName(String) - Method in class org.restlet.data.Expectation
-
Sets the name.
- setName(String) - Method in class org.restlet.data.Header
-
Sets the name.
- setName(String) - Method in class org.restlet.data.Parameter
-
- setName(String) - Method in class org.restlet.data.Product
-
Sets the product name.
- setName(String) - Method in class org.restlet.data.RecipientInfo
-
Sets the host name and port number or a pseudonym.
- setName(String) - Method in class org.restlet.resource.ServerResource
-
Sets the display name.
- setName(String) - Method in class org.restlet.Restlet
-
Sets the display name.
- setName(String) - Method in class org.restlet.security.Group
-
Sets the display name.
- setName(String) - Method in class org.restlet.security.Realm
-
Sets the name.
- setName(String) - Method in class org.restlet.security.Role
-
Sets the name.
- setName(String) - Method in class org.restlet.util.WrapperRestlet
-
- setNegotiated(boolean) - Method in class org.restlet.resource.ServerResource
-
Indicates if content negotiation of response entities is enabled.
- setNegotiatingContent(boolean) - Method in class org.restlet.resource.Directory
-
Indicates if the best content is automatically negotiated.
- setNext(Uniform) - Method in class org.restlet.resource.ClientResource
-
Sets the next handler such as a Restlet or a Filter.
- setNext(Class<? extends ServerResource>) - Method in class org.restlet.routing.Filter
-
- setNext(Restlet) - Method in class org.restlet.routing.Filter
-
Sets the next Restlet.
- setNext(Class<? extends ServerResource>) - Method in class org.restlet.Server
-
Sets the next Restlet as a Finder for a given resource class.
- setNext(Restlet) - Method in class org.restlet.Server
-
Sets the next Restlet.
- setNext(Restlet) - Method in class org.restlet.util.ServerList
-
Sets the next Restlet.
- setNextServerNonce(String) - Method in class org.restlet.data.AuthenticationInfo
-
Sets the next server nonce.
- setNoInterest() - Method in class org.restlet.util.SelectionRegistration
-
Sets interest in no IO operations.
- setNonceCount(int) - Method in class org.restlet.data.AuthenticationInfo
-
Sets the nonce-count value.
- setNoneMatch(List<Tag>) - Method in class org.restlet.data.Conditions
-
Sets the modifiable list of tags that mustn't match.
- setObject(T) - Method in class org.restlet.representation.ObjectRepresentation
-
Sets the represented object.
- setOnError(Uniform) - Method in class org.restlet.Message
-
Sets the callback invoked when an error occurs when sending the message.
- setOnResponse(Uniform) - Method in class org.restlet.Request
-
Sets the callback invoked on response reception.
- setOnResponse(Uniform) - Method in class org.restlet.resource.ClientResource
-
Sets the callback invoked on response reception.
- setOnResponse(Uniform) - Method in class org.restlet.util.WrapperRequest
-
- setOnSent(Uniform) - Method in class org.restlet.Message
-
Sets the callback invoked after sending the message.
- setOnSent(Uniform) - Method in class org.restlet.resource.ClientResource
-
Sets the callback invoked after sending the request.
- setOnSent(Uniform) - Method in class org.restlet.resource.ServerResource
-
Sets the callback invoked after sending the response.
- setOpaque(String) - Method in class org.restlet.data.ChallengeMessage
-
Sets an opaque string of data which should be returned by the client
unchanged.
- setOptional(boolean) - Method in class org.restlet.security.Authenticator
-
Indicates if the authenticator is not required to succeed.
- setOriginalRef(Reference) - Method in class org.restlet.Request
-
Sets the original reference requested by the client.
- setOriginalRef(Reference) - Method in class org.restlet.resource.ClientResource
-
Sets the original reference requested by the client.
- setOriginalRef(Reference) - Method in class org.restlet.util.WrapperRequest
-
- setOutboundRoot(Class<? extends ServerResource>) - Method in class org.restlet.Application
-
Sets the outbound root Resource class.
- setOutboundRoot(Restlet) - Method in class org.restlet.Application
-
Sets the outbound root Restlet.
- setOverwriting(boolean) - Method in class org.restlet.service.StatusService
-
Indicates if an existing entity should be overwritten.
- setOwner(String) - Method in class org.restlet.Restlet
-
Sets the owner(s).
- setOwner(String) - Method in class org.restlet.util.WrapperRestlet
-
- setParameters(Series<Parameter>) - Method in class org.restlet.Context
-
Sets the modifiable series of parameters.
- setParameters(Series<Parameter>) - Method in class org.restlet.data.ChallengeMessage
-
Sets the parameters.
- setParameters(Series<Parameter>) - Method in class org.restlet.data.Disposition
-
Sets the list of disposition parameters.
- setParameters(List<Parameter>) - Method in class org.restlet.data.Expectation
-
Sets the list of parameters.
- setParameters(Series<Parameter>) - Method in class org.restlet.data.Preference
-
Sets the modifiable list of parameters.
- setParameters(Series<Parameter>) - Method in class org.restlet.security.Realm
-
Sets the modifiable series of parameters.
- setPath(String) - Method in class org.restlet.data.Cookie
-
Sets the validity path.
- setPath(String) - Method in class org.restlet.data.Reference
-
Sets the path component for hierarchical identifiers.
- setPattern(String) - Method in class org.restlet.routing.Template
-
Sets the pattern to use for formatting or parsing.
- setPort(int) - Method in class org.restlet.data.ClientInfo
-
Sets the port number which sent the call.
- setPort(int) - Method in class org.restlet.data.ServerInfo
-
Sets the port number which received the call.
- setPort(int) - Method in class org.restlet.Server
-
Sets the listening port if specified.
- setPreferencesTunnel(boolean) - Method in class org.restlet.service.TunnelService
-
Indicates if the client preferences can be tunneled via the query
parameters.
- setPrincipals(List<Principal>) - Method in class org.restlet.data.ClientInfo
-
Sets the additional client principals.
- setProtocol(Protocol) - Method in class org.restlet.data.RecipientInfo
-
Sets the protocol used to communicate with the recipient.
- setProtocol(Protocol) - Method in class org.restlet.data.Reference
-
Sets the scheme component based on this protocol.
- setProtocol(Protocol) - Method in class org.restlet.Request
-
Sets the protocol used or to be used.
- setProtocol(Protocol) - Method in class org.restlet.resource.ClientResource
-
Sets the protocol used or to be used.
- setProtocol(Protocol) - Method in class org.restlet.util.WrapperRequest
-
- setProtocols(List<Protocol>) - Method in class org.restlet.Connector
-
Sets the list of protocols simultaneously supported.
- setProxyChallengeRequests(List<ChallengeRequest>) - Method in class org.restlet.resource.ServerResource
-
Sets the list of proxy authentication requests sent by an origin server
to a client.
- setProxyChallengeRequests(List<ChallengeRequest>) - Method in class org.restlet.Response
-
Sets the modifiable list of authentication requests sent by a proxy to a
client.
- setProxyChallengeRequests(List<ChallengeRequest>) - Method in class org.restlet.util.WrapperResponse
-
Sets the list of authentication requests sent by a proxy to a client.
- setProxyChallengeResponse(ChallengeResponse) - Method in class org.restlet.Request
-
Sets the authentication response sent by a client to a proxy.
- setProxyChallengeResponse(ChallengeResponse) - Method in class org.restlet.resource.ClientResource
-
Sets the proxy authentication response sent by a client to an origin
server.
- setProxyChallengeResponse(ChallengeScheme, String, String) - Method in class org.restlet.resource.ClientResource
-
Sets the proxy authentication response sent by a client to an origin
server given a scheme, identifier and secret.
- setProxyChallengeResponse(ChallengeResponse) - Method in class org.restlet.util.WrapperRequest
-
Sets the authentication response sent by a client to a proxy.
- setQuality(String) - Method in class org.restlet.data.AuthenticationInfo
-
Sets the quality of protection.
- setQuality(String) - Method in class org.restlet.data.ChallengeResponse
-
Sets the chosen quality of protection.
- setQuality(float) - Method in class org.restlet.data.Preference
-
Sets the quality/preference level.
- setQualityOptions(List<String>) - Method in class org.restlet.data.ChallengeRequest
-
Sets the available options for quality of protection.
- setQuery(String) - Method in class org.restlet.data.Reference
-
Sets the query component for hierarchical identifiers.
- setQueryTunnel(boolean) - Method in class org.restlet.service.TunnelService
-
Indicates if the method and client preferences can be tunneled via query
parameters.
- setQueryValue(String, String) - Method in class org.restlet.resource.Resource
-
Sets the query value for the named parameter.
- setRange(Range) - Method in class org.restlet.representation.Representation
-
Sets the range where in the full content the partial content available
should be applied.
- setRange(Range) - Method in class org.restlet.util.WrapperRepresentation
-
- setRangeDate(Date) - Method in class org.restlet.data.Conditions
-
Sets the range condition based on the modification date of the requested
variant.
- setRanges(List<Range>) - Method in class org.restlet.Request
-
Sets the modifiable list of ranges to return from the target resource's
representation.
- setRanges(List<Range>) - Method in class org.restlet.resource.ClientResource
-
Sets the ranges to return from the target resource's representation.
- setRanges(List<Range>) - Method in class org.restlet.util.WrapperRequest
-
- setRangeService(RangeService) - Method in class org.restlet.Application
-
Sets the range service.
- setRangeTag(Tag) - Method in class org.restlet.data.Conditions
-
Sets the range condition based on the entity tag of the requested
variant.
- setRawValue(String) - Method in class org.restlet.data.ChallengeMessage
-
Sets the raw value.
- setReadDate(Date) - Method in class org.restlet.data.Disposition
-
Sets the read date parameter.
- setReader(Reader) - Method in class org.restlet.representation.ReaderRepresentation
-
Sets the reader to use.
- setReadInterest() - Method in class org.restlet.util.SelectionRegistration
-
Sets interest in IO read operations.
- setReadyOperations(int) - Method in class org.restlet.util.SelectionRegistration
-
Sets the IO operations ready.
- setRealm(String) - Method in class org.restlet.data.ChallengeMessage
-
Sets the realm name.
- setRealm(String) - Method in class org.restlet.security.ChallengeAuthenticator
-
Sets the authentication realm.
- setRealms(List<Realm>) - Method in class org.restlet.Component
-
Sets the list of realms.
- setRechallenging(boolean) - Method in class org.restlet.security.ChallengeAuthenticator
-
Indicates if a new challenge should be sent when invalid credentials are
received.
- setRecipientsInfo(List<RecipientInfo>) - Method in class org.restlet.Message
-
Sets the modifiable list of intermediary recipients.
- setReference(Reference) - Method in class org.restlet.resource.ClientResource
-
Sets the resource's reference.
- setReference(String) - Method in class org.restlet.resource.ClientResource
-
Sets the resource's reference using an URI string.
- setReferrerRef(Reference) - Method in class org.restlet.Request
-
Sets the referrer reference if available.
- setReferrerRef(String) - Method in class org.restlet.Request
-
Sets the referrer reference if available using an URI string.
- setReferrerRef(Reference) - Method in class org.restlet.resource.ClientResource
-
Sets the referrer reference if available.
- setReferrerRef(String) - Method in class org.restlet.resource.ClientResource
-
Sets the referrer reference if available using an URI string.
- setReferrerRef(Reference) - Method in class org.restlet.util.WrapperRequest
-
Sets the referrer reference if available.
- setReferrerRef(String) - Method in class org.restlet.util.WrapperRequest
-
Sets the referrer reference if available using an URI string.
- setRelativePart(String) - Method in class org.restlet.data.Reference
-
Sets the relative part for relative references only.
- setRequest(Request) - Method in class org.restlet.resource.Resource
-
Sets the handled request.
- setRequest(Request) - Method in class org.restlet.Response
-
Sets the associated request.
- setRequest(Request) - Method in class org.restlet.util.WrapperResponse
-
Sets the associated request.
- setRequest(WrapperRequest) - Method in class org.restlet.util.WrapperResponse
-
Sets the associated request.
- setRequestEntityBuffering(boolean) - Method in class org.restlet.resource.ClientResource
-
Indicates if transient or unknown size response entities should be
buffered after being received.
- setRequired(boolean) - Method in class org.restlet.routing.Variable
-
Indicates if the variable is required or optional.
- setRequiredScore(float) - Method in class org.restlet.routing.Router
-
Sets the score required to have a match.
- setResourceDomain(String) - Method in class org.restlet.routing.VirtualHost
-
Sets the resourceRef host domain to match.
- setResourcePort(String) - Method in class org.restlet.routing.VirtualHost
-
Sets the resourceRef host port to match.
- setResourceRef(Reference) - Method in class org.restlet.Request
-
Sets the target resource reference.
- setResourceRef(String) - Method in class org.restlet.Request
-
Sets the target resource reference using an URI string.
- setResourceRef(Reference) - Method in class org.restlet.util.WrapperRequest
-
Sets the target resource reference.
- setResourceRef(String) - Method in class org.restlet.util.WrapperRequest
-
Sets the target resource reference using an URI string.
- setResourceScheme(String) - Method in class org.restlet.routing.VirtualHost
-
Sets the resourceRef scheme to match.
- setResponse(Response) - Method in class org.restlet.resource.Resource
-
Sets the handled response.
- setResponseDigest(String) - Method in class org.restlet.data.AuthenticationInfo
-
Sets the optional response digest for mutual authentication.
- setResponseEntityBuffering(boolean) - Method in class org.restlet.resource.ClientResource
-
Indicates if transient or unknown size response entities should be
buffered after being received.
- setResponseLogFormat(String) - Method in class org.restlet.service.LogService
-
Sets the format to use when logging responses.
- setRetryAfter(Date) - Method in class org.restlet.Response
-
Indicates how long the service is expected to be unavailable to the
requesting client.
- setRetryAfter(Date) - Method in class org.restlet.util.WrapperResponse
-
- setRetryAttempts(int) - Method in class org.restlet.resource.ClientResource
-
Sets the number of retry attempts before reporting an error.
- setRetryDelay(long) - Method in class org.restlet.resource.ClientResource
-
Sets the delay in milliseconds between two retry attempts.
- setRetryDelay(long) - Method in class org.restlet.routing.Router
-
Sets the delay in milliseconds before a new attempt is made.
- setRetryOnError(boolean) - Method in class org.restlet.resource.ClientResource
-
Indicates if idempotent requests should be retried on error.
- setRoles(List<Role>) - Method in class org.restlet.Application
-
Sets the modifiable list of roles.
- setRoles(List<Role>) - Method in class org.restlet.data.ClientInfo
-
Sets the authenticated user roles.
- setRootGroups(List<Group>) - Method in class org.restlet.security.MemoryRealm
-
Sets the modifiable list of root groups.
- setRootRef(Reference) - Method in class org.restlet.Request
-
Sets the application root reference.
- setRootRef(Reference) - Method in class org.restlet.resource.Directory
-
Sets the root URI from which the relative resource URIs will be lookep
up.
- setRootRef(Reference) - Method in class org.restlet.util.WrapperRequest
-
Sets the application root reference.
- setRouter(Router) - Method in class org.restlet.routing.Route
-
Sets the parent router.
- setRoutes(RouteList) - Method in class org.restlet.routing.Router
-
Sets the modifiable list of routes.
- setRoutingMode(int) - Method in class org.restlet.routing.Router
-
Sets the routing mode.
- setScheme(ChallengeScheme) - Method in class org.restlet.data.ChallengeMessage
-
Sets the scheme used.
- setScheme(String) - Method in class org.restlet.data.Reference
-
Sets the scheme component.
- setSchemeSpecificPart(String) - Method in class org.restlet.data.Reference
-
Sets the scheme specific part.
- setSecret(char[]) - Method in class org.restlet.data.ChallengeResponse
-
Sets the user secret, such as a password or a secret key.
- setSecret(String) - Method in class org.restlet.data.ChallengeResponse
-
Sets the user secret, such as a password or a secret key.
- setSecret(char[]) - Method in class org.restlet.security.User
-
Sets the secret.
- setSecretAlgorithm(String) - Method in class org.restlet.data.ChallengeResponse
-
Sets the digest algorithm name optionally applied on the user secret.
- setSecure(boolean) - Method in class org.restlet.data.CookieSetting
-
Indicates if cookie should only be transmitted by secure means.
- setSegments(List<String>) - Method in class org.restlet.data.Reference
-
Sets the segments of a hierarchical path.
- setSelectionListener(SelectionListener) - Method in class org.restlet.util.SelectionRegistration
-
Sets the selection listener that will be notified.
- setServerAddress(String) - Method in class org.restlet.routing.VirtualHost
-
Sets the listening server address.
- setServerDispatcher(Restlet) - Method in class org.restlet.Context
-
Sets the server dispatcher.
- setServerInfo(ServerInfo) - Method in class org.restlet.resource.ServerResource
-
Sets the server-specific information.
- setServerInfo(ServerInfo) - Method in class org.restlet.Response
-
Sets the server-specific information.
- setServerInfo(ServerInfo) - Method in class org.restlet.util.WrapperResponse
-
- setServerNonce(String) - Method in class org.restlet.data.ChallengeMessage
-
Sets the server nonce.
- setServerNounceCount(int) - Method in class org.restlet.data.ChallengeResponse
-
Sets the server nonce count.
- setServerPort(String) - Method in class org.restlet.routing.VirtualHost
-
Sets the listening server port.
- setServerProtocols(List<Protocol>) - Method in class org.restlet.service.ConnectorService
-
Sets the modifiable list of required server protocols.
- setServers(ServerList) - Method in class org.restlet.Component
-
Sets the modifiable list of server connectors.
- setShutdownAllowed(boolean) - Method in class org.restlet.service.TaskService
-
- setSize(long) - Method in class org.restlet.data.Disposition
-
Sets the value of the "size" parameter.
- setSize(long) - Method in class org.restlet.data.Range
-
Sets the size of the range in number of bytes.
- setSize(long) - Method in class org.restlet.representation.Representation
-
Sets the expected size in bytes if known, -1 otherwise.
- setSize(long) - Method in class org.restlet.util.WrapperRepresentation
-
- setSkippingResourceForCorsOptions(boolean) - Method in class org.restlet.service.CorsService
-
Sets the value of skipResourceForCorsOptions field.
- setStale(boolean) - Method in class org.restlet.data.ChallengeRequest
-
Indicates if the previous request from the client was stale.
- setStatus(Status) - Method in class org.restlet.data.Warning
-
Sets the special status.
- setStatus(Status) - Method in class org.restlet.resource.ServerResource
-
Sets the status.
- setStatus(Status, String) - Method in class org.restlet.resource.ServerResource
-
Sets the status.
- setStatus(Status, Throwable) - Method in class org.restlet.resource.ServerResource
-
Sets the status.
- setStatus(Status, Throwable, String) - Method in class org.restlet.resource.ServerResource
-
Sets the status.
- setStatus(Status) - Method in class org.restlet.Response
-
Sets the status.
- setStatus(Status, String) - Method in class org.restlet.Response
-
Sets the status.
- setStatus(Status, Throwable) - Method in class org.restlet.Response
-
Sets the status.
- setStatus(Status, Throwable, String) - Method in class org.restlet.Response
-
Sets the status.
- setStatus(Status) - Method in class org.restlet.util.WrapperResponse
-
Sets the status.
- setStatus(Status, String) - Method in class org.restlet.util.WrapperResponse
-
Sets the status.
- setStatus(Status, Throwable) - Method in class org.restlet.util.WrapperResponse
-
- setStatus(Status, Throwable, String) - Method in class org.restlet.util.WrapperResponse
-
- setStatusService(StatusService) - Method in class org.restlet.Application
-
Sets the status service.
- setStatusService(StatusService) - Method in class org.restlet.Component
-
- setStream(InputStream) - Method in class org.restlet.representation.InputRepresentation
-
Sets the input stream to use.
- setStrict(boolean) - Method in class org.restlet.service.ConnegService
-
Indicates if the conneg algorithm should strictly respect client
preferences or be more flexible.
- setTag(Tag) - Method in class org.restlet.representation.RepresentationInfo
-
Sets the tag.
- setTag(Tag) - Method in class org.restlet.util.WrapperRepresentation
-
- setTargetClass(Class<? extends ServerResource>) - Method in class org.restlet.resource.Finder
-
Sets the target resource class which must be a subclass of
ServerResource
.
- setTargetTemplate(String) - Method in class org.restlet.routing.Redirector
-
Sets the target URI pattern.
- setTaskService(TaskService) - Method in class org.restlet.Application
-
Sets the task service.
- setTaskService(TaskService) - Method in class org.restlet.Component
-
Sets the task service.
- setTemplate(Template) - Method in class org.restlet.routing.TemplateRoute
-
Sets the reference template to match.
- setText(String) - Method in class org.restlet.data.Warning
-
Sets the warning text.
- setText(CharSequence) - Method in class org.restlet.representation.AppendableRepresentation
-
- setText(CharSequence) - Method in class org.restlet.representation.StringRepresentation
-
Sets the string value.
- setText(String) - Method in class org.restlet.representation.StringRepresentation
-
Sets the string value.
- setTimeIssued(long) - Method in class org.restlet.data.ChallengeResponse
-
Sets the time when the response was issued, as returned by System.currentTimeMillis()
.
- setTransient(boolean) - Method in class org.restlet.representation.Representation
-
Indicates if the representation's content is transient.
- setTransient(boolean) - Method in class org.restlet.util.WrapperRepresentation
-
- setTunnelService(TunnelService) - Method in class org.restlet.Application
-
Sets the tunnel service.
- setType(String) - Method in class org.restlet.data.Disposition
-
Sets the disposition type.
- setType(int) - Method in class org.restlet.routing.Variable
-
Sets the type of variable.
- setUnitName(String) - Method in class org.restlet.data.Range
-
Sets the name of the range unit.
- setUnmodifiedSince(Date) - Method in class org.restlet.data.Conditions
-
Sets the condition based on the modification date of the requested
variant.
- setUser(User) - Method in class org.restlet.data.ClientInfo
-
Sets the authenticated user.
- setUserAgentTunnel(boolean) - Method in class org.restlet.service.TunnelService
-
Indicates if the client preferences can be tunneled according to the user
agent.
- setUserInfo(String) - Method in class org.restlet.data.Reference
-
Sets the user info component for server based hierarchical identifiers.
- setUsers(List<User>) - Method in class org.restlet.security.MemoryRealm
-
Sets the modifiable list of users.
- setValue(String) - Method in class org.restlet.data.CacheDirective
-
Sets the value.
- setValue(String) - Method in class org.restlet.data.Cookie
-
Sets the value.
- setValue(String) - Method in class org.restlet.data.Expectation
-
Sets the value.
- setValue(String) - Method in class org.restlet.data.Header
-
Sets the value.
- setValue(String) - Method in class org.restlet.data.Parameter
-
- setValue(V) - Method in interface org.restlet.util.NamedValue
-
Sets the value.
- setVariables(Map<String, Variable>) - Method in class org.restlet.routing.Template
-
Sets the modifiable map of variables.
- setVerifier(Verifier) - Method in class org.restlet.security.ChallengeAuthenticator
-
Sets the credentials verifier.
- setVerifier(Verifier) - Method in class org.restlet.security.Realm
-
Sets a verifier that can check the validity of the credentials associated
to a request.
- setVersion(int) - Method in class org.restlet.data.Cookie
-
Sets the cookie specification version.
- setVersion(String) - Method in class org.restlet.data.Product
-
Sets the version of the product.
- setWakeupListener(WakeupListener) - Method in class org.restlet.util.SelectionRegistration
-
Sets the wakeup listener that will be notified.
- setWarnings(List<Warning>) - Method in class org.restlet.Message
-
Sets the additional warnings information.
- setWriteInterest() - Method in class org.restlet.util.SelectionRegistration
-
Sets interest in IO read operations.
- sharedMaxAge(int) - Static method in class org.restlet.data.CacheDirective
-
Creates a "s-maxage" directive.
- shutdown() - Method in class org.restlet.service.TaskService
-
Initiates an orderly shutdown in which previously submitted tasks are
executed, but no new tasks will be accepted.
- shutdownNow() - Method in class org.restlet.service.TaskService
-
Attempts to stop all actively executing tasks, halts the processing of
waiting tasks, and returns a list of the tasks that were awaiting
execution.
- SIP - Static variable in class org.restlet.data.Protocol
-
SIP protocol.
- SIPS - Static variable in class org.restlet.data.Protocol
-
SIPS protocol (via SSL socket).
- size() - Method in class org.restlet.util.WrapperList
-
Returns the number of elements in this list.
- size() - Method in class org.restlet.util.WrapperMap
-
Returns the number of key-value mappings in this map.
- SIZE_MAX - Static variable in class org.restlet.data.Range
-
Maximum size available from the index.
- SKIP - Static variable in class org.restlet.routing.Filter
-
- SMTP - Static variable in class org.restlet.data.Protocol
-
SMTP protocol.
- SMTP_PLAIN - Static variable in class org.restlet.data.ChallengeScheme
-
Plain SMTP scheme.
- SMTPS - Static variable in class org.restlet.data.Protocol
-
SMTPS protocol (via SSL/TLS socket).
- sort(List<Method>) - Static method in class org.restlet.data.Method
-
Sorts the given list of methods by name.
- SPANISH - Static variable in class org.restlet.data.Language
-
Spanish language.
- start() - Method in class org.restlet.Application
-
Starts the application, all the enabled associated services then the
inbound and outbound roots.
- start() - Method in class org.restlet.Client
-
- start() - Method in class org.restlet.Component
-
Starts the component.
- start() - Method in class org.restlet.Restlet
-
Starts the Restlet.
- start() - Method in class org.restlet.routing.Filter
-
Starts the filter and the next Restlet if attached.
- start() - Method in class org.restlet.routing.Router
-
Starts the filter and the attached routes.
- start() - Method in class org.restlet.security.Realm
-
Starts the realm.
- start() - Method in class org.restlet.Server
-
- start() - Method in class org.restlet.service.LogService
-
- start() - Method in class org.restlet.service.Service
-
Starts the Restlet.
- start() - Method in class org.restlet.service.TaskService
-
- start() - Method in class org.restlet.util.ServiceList
-
Starts each service.
- start() - Method in class org.restlet.util.WrapperRestlet
-
- startClients() - Method in class org.restlet.Component
-
Starts the client connectors.
- startHelper() - Method in class org.restlet.Component
-
Starts the internal helper allowing incoming requests to be served.
- startRealms() - Method in class org.restlet.Component
-
Starts the realms.
- startRouters() - Method in class org.restlet.Component
-
Starts the virtual hosts and the internal router.
- startServers() - Method in class org.restlet.Component
-
Starts the server connectors.
- startServices() - Method in class org.restlet.Component
-
Starts the associated services.
- Status - Class in org.restlet.data
-
Status to return after handling a call.
- Status(int) - Constructor for class org.restlet.data.Status
-
Constructor.
- Status(int, String) - Constructor for class org.restlet.data.Status
-
Constructor.
- Status(int, String, String) - Constructor for class org.restlet.data.Status
-
Constructor.
- Status(int, String, String, String) - Constructor for class org.restlet.data.Status
-
Constructor.
- Status(int, Throwable) - Constructor for class org.restlet.data.Status
-
Constructor.
- Status(int, Throwable, String) - Constructor for class org.restlet.data.Status
-
Constructor.
- Status(int, Throwable, String, String) - Constructor for class org.restlet.data.Status
-
Constructor.
- Status(int, Throwable, String, String, String) - Constructor for class org.restlet.data.Status
-
Constructor.
- Status(Status, String) - Constructor for class org.restlet.data.Status
-
Constructor.
- Status(Status, String, String) - Constructor for class org.restlet.data.Status
-
Constructor.
- Status(Status, Throwable) - Constructor for class org.restlet.data.Status
-
Constructor.
- Status(Status, Throwable, String) - Constructor for class org.restlet.data.Status
-
Constructor.
- Status(Status, Throwable, String, String) - Constructor for class org.restlet.data.Status
-
Constructor.
- Status - Annotation Type in org.restlet.resource
-
Annotation for Throwable
that map to HTTP error statuses.
- StatusService - Class in org.restlet.service
-
Service to handle error statuses.
- StatusService() - Constructor for class org.restlet.service.StatusService
-
Constructor.
- StatusService(boolean) - Constructor for class org.restlet.service.StatusService
-
Constructor.
- StatusService(boolean, ConverterService, MetadataService, ConnegService) - Constructor for class org.restlet.service.StatusService
-
Constructor.
- stop() - Method in class org.restlet.Application
-
Stops the application, the inbound and outbound roots then all the
enabled associated services.
- stop() - Method in class org.restlet.Client
-
- stop() - Method in class org.restlet.Component
-
Stops the component.
- stop() - Method in class org.restlet.Restlet
-
Stops the Restlet.
- STOP - Static variable in class org.restlet.routing.Filter
-
Indicates that the request processing should stop and return the current
response from the filter.
- stop() - Method in class org.restlet.routing.Filter
-
Stops the filter and the next Restlet if attached.
- stop() - Method in class org.restlet.routing.Router
-
Stops the filter and the attached routes.
- stop() - Method in class org.restlet.security.Realm
-
Stops the realm.
- stop() - Method in class org.restlet.Server
-
- stop() - Method in class org.restlet.service.Service
-
Stops the Restlet.
- stop() - Method in class org.restlet.service.TaskService
-
- stop() - Method in class org.restlet.util.ServiceList
-
Stops each service.
- stop() - Method in class org.restlet.util.WrapperRestlet
-
- stopClients() - Method in class org.restlet.Component
-
Stops the client connectors.
- stopHelper() - Method in class org.restlet.Component
-
Stops the internal helper allowing incoming requests to be served.
- stopRealms() - Method in class org.restlet.Component
-
Stops the realms.
- stopRouters() - Method in class org.restlet.Component
-
Stops the virtual hosts and the internal router.
- stopServers() - Method in class org.restlet.Component
-
Stops the server connectors.
- stopServices() - Method in class org.restlet.Component
-
Stops the associated services.
- StreamRepresentation - Class in org.restlet.representation
-
Representation based on a BIO stream.
- StreamRepresentation(MediaType) - Constructor for class org.restlet.representation.StreamRepresentation
-
Constructor.
- StringReadingListener - Class in org.restlet.util
-
Selection listener notifying new content as a string.
- StringReadingListener(Representation) - Constructor for class org.restlet.util.StringReadingListener
-
Default constructor.
- StringReadingListener(Representation, int) - Constructor for class org.restlet.util.StringReadingListener
-
Constructor.
- StringRepresentation - Class in org.restlet.representation
-
Represents an Unicode string that can be converted to any character set
supported by Java.
- StringRepresentation(char[]) - Constructor for class org.restlet.representation.StringRepresentation
-
Constructor.
- StringRepresentation(CharSequence) - Constructor for class org.restlet.representation.StringRepresentation
-
Constructor.
- StringRepresentation(CharSequence, Language) - Constructor for class org.restlet.representation.StringRepresentation
-
Constructor.
- StringRepresentation(CharSequence, MediaType) - Constructor for class org.restlet.representation.StringRepresentation
-
Constructor.
- StringRepresentation(CharSequence, MediaType, Language) - Constructor for class org.restlet.representation.StringRepresentation
-
Constructor.
- StringRepresentation(CharSequence, MediaType, Language, CharacterSet) - Constructor for class org.restlet.representation.StringRepresentation
-
Constructor.
- subList(int, int) - Method in class org.restlet.data.ReferenceList
-
Returns a view of the portion of this list between the specified
fromIndex, inclusive, and toIndex, exclusive.
- subList(int, int) - Method in class org.restlet.util.RouteList
-
Returns a view of the portion of this list between the specified
fromIndex, inclusive, and toIndex, exclusive.
- subList(int, int) - Method in class org.restlet.util.Series
-
Returns a view of the portion of this list between the specified
fromIndex, inclusive, and toIndex, exclusive.
- subList(String) - Method in class org.restlet.util.Series
-
Returns a list of all the values associated to the parameter name.
- subList(String, boolean) - Method in class org.restlet.util.Series
-
Returns a list of all the values associated to the parameter name.
- subList(int, int) - Method in class org.restlet.util.WrapperList
-
Returns a view of the portion of this list between the specified
fromIndex, inclusive, and toIndex, exclusive.
- submit(Callable<T>) - Method in class org.restlet.service.TaskService
-
Submits a value-returning task for execution and returns a Future
representing the pending results of the task.
- submit(Runnable) - Method in class org.restlet.service.TaskService
-
- submit(Runnable, T) - Method in class org.restlet.service.TaskService
-
- SUCCESS_ACCEPTED - Static variable in class org.restlet.data.Status
-
The request has been accepted for processing, but the processing has not
been completed.
- SUCCESS_CREATED - Static variable in class org.restlet.data.Status
-
The request has been fulfilled and resulted in a new resource being
created.
- SUCCESS_MISC_PERSISTENT_WARNING - Static variable in class org.restlet.data.Status
-
Warning status code, optionally including arbitrary information to be
presented to a human user, typically returned by a cache.
- SUCCESS_MULTI_STATUS - Static variable in class org.restlet.data.Status
-
This response is used to inform the client that the HTTP response entity
contains a set of status codes generated during the method invocation.
- SUCCESS_NO_CONTENT - Static variable in class org.restlet.data.Status
-
The server has fulfilled the request but does not need to return an
entity-body (for example after a DELETE), and might want to return
updated meta-information.
- SUCCESS_NON_AUTHORITATIVE - Static variable in class org.restlet.data.Status
-
The request has succeeded but the returned meta-information in the
entity-header does not come from the origin server, but is gathered from
a local or a third-party copy.
- SUCCESS_OK - Static variable in class org.restlet.data.Status
-
The request has succeeded.
- SUCCESS_PARTIAL_CONTENT - Static variable in class org.restlet.data.Status
-
The server has fulfilled the partial GET request for the resource
assuming the request has included a Range header field indicating the
desired range.
- SUCCESS_RESET_CONTENT - Static variable in class org.restlet.data.Status
-
The server has fulfilled the request and the user agent SHOULD reset the
document view which caused the request to be sent.
- SUCCESS_TRANSFORMATION_APPLIED - Static variable in class org.restlet.data.Status
-
Warning status code, typically returned by a cache or a proxy, indicating
that the response has been transformed.
- suspend() - Method in class org.restlet.util.SelectionRegistration
-
Suspend interest in new listener notifications.