A B C D E F G H I K L M P R S T U V W

A

AccessLogFileHandler - Class in com.noelios.restlet.util

Log file handler that uses the AccessLogFormatter by default.

AccessLogFileHandler() - Constructor for class com.noelios.restlet.util.AccessLogFileHandler

Constructor.

AccessLogFileHandler(String) - Constructor for class com.noelios.restlet.util.AccessLogFileHandler

Constructor.

AccessLogFileHandler(String, boolean) - Constructor for class com.noelios.restlet.util.AccessLogFileHandler

Constructor.

AccessLogFileHandler(String, int, int) - Constructor for class com.noelios.restlet.util.AccessLogFileHandler

Constructor.

AccessLogFileHandler(String, int, int, boolean) - Constructor for class com.noelios.restlet.util.AccessLogFileHandler

Constructor.

AccessLogFormatter - Class in com.noelios.restlet.util

Log record formatter which simply outputs the message on a new line.

AccessLogFormatter() - Constructor for class com.noelios.restlet.util.AccessLogFormatter

addAdditionalHeaders(Series<Parameter>, Series<Parameter>) - Method in class com.noelios.restlet.http.HttpConverter

Adds additional headers if they are non-standard headers.

addEntityHeaders(Representation, Series<Parameter>) - Static method in class com.noelios.restlet.http.HttpServerConverter

Copies the entity headers from the Representation to the Series.

addEntityHeaders(HttpResponse) - Method in class com.noelios.restlet.http.HttpServerConverter

Adds the entity headers for the handled uniform call.

addFilter(Filter) - Method in class com.noelios.restlet.ChainHelper

Adds a new filter to the chain.

addParameters(Form) - Method in class com.noelios.restlet.util.FormReader

Adds the parameters into a given form.

addRequestHeaders(HttpClientCall, Request) - Method in class com.noelios.restlet.http.HttpClientConverter

Adds the request headers of a uniform call to a HTTP client call.

addResponseHeaders(Response, Series<Parameter>) - Static method in class com.noelios.restlet.http.HttpServerConverter

Copies the headers from the Response to the given Series.

addResponseHeaders(HttpResponse) - Method in class com.noelios.restlet.http.HttpServerConverter

Adds the response headers for the handled uniform call.

afterHandle(Request, Response) - Method in class com.noelios.restlet.application.Decoder

Allows filtering after its handling by the target Restlet.

afterHandle(Request, Response) - Method in class com.noelios.restlet.application.Encoder

Allows filtering after its handling by the target Restlet.

afterHandle(Request, Response) - Method in class com.noelios.restlet.application.RangeFilter

afterHandle(Request, Response) - Method in class com.noelios.restlet.LogFilter

Allows filtering after processing by the next Restlet.

afterHandle(Request, Response) - Method in class com.noelios.restlet.StatusFilter

Allows filtering after its handling by the target Restlet.

anyNull(Object...) - Static method in class com.noelios.restlet.authentication.AuthenticationUtils

Indicates if any of the objects is null.

appendComment(CharSequence, Appendable) - Static method in class com.noelios.restlet.http.HttpUtils

Appends a source string as an HTTP comment.

appendQuote(CharSequence, Appendable) - Static method in class com.noelios.restlet.http.HttpUtils

Appends a source string as an HTTP quoted string.

appendQuotedString(Appendable) - Method in class com.noelios.restlet.http.HeaderReader

Appends the next quoted string.

appendUriEncoded(CharSequence, Appendable, CharacterSet) - Static method in class com.noelios.restlet.http.HttpUtils

Appends a source string as an URI encoded string.

ApplicationHelper - Class in com.noelios.restlet.application

Application implementation.

ApplicationHelper(Application) - Constructor for class com.noelios.restlet.application.ApplicationHelper

Constructor.

ApplicationStatusFilter - Class in com.noelios.restlet.application

Status filter that tries to obtain ouput representation from an application.

ApplicationStatusFilter(Application) - Constructor for class com.noelios.restlet.application.ApplicationStatusFilter

Constructor.

ATTRIBUTE_HEADERS - Static variable in class com.noelios.restlet.http.HttpConstants

ATTRIBUTE_HTTPS_CIPHER_SUITE - Static variable in class com.noelios.restlet.http.HttpConstants

ATTRIBUTE_HTTPS_CLIENT_CERTIFICATES - Static variable in class com.noelios.restlet.http.HttpConstants

ATTRIBUTE_HTTPS_KEY_SIZE - Static variable in class com.noelios.restlet.http.HttpConstants

ATTRIBUTE_VERSION - Static variable in class com.noelios.restlet.http.HttpConstants

authenticate(ChallengeResponse, Request, Guard) - Method in class com.noelios.restlet.authentication.AuthenticationHelper

Indicates if the call is properly authenticated.

authenticate(Request, Guard) - Static method in class com.noelios.restlet.authentication.AuthenticationUtils

Indicates if the request is properly authenticated.

authenticate(ChallengeResponse, Request, Guard) - Method in class com.noelios.restlet.authentication.HttpDigestHelper

authenticate(Request, Guard) - Method in class com.noelios.restlet.Engine

AuthenticationHelper - Class in com.noelios.restlet.authentication

Base class for authentication helpers.

AuthenticationHelper(ChallengeScheme, boolean, boolean) - Constructor for class com.noelios.restlet.authentication.AuthenticationHelper

Constructor.

AuthenticationUtils - Class in com.noelios.restlet.authentication

Authentication utilities.

AuthenticationUtils() - Constructor for class com.noelios.restlet.authentication.AuthenticationUtils

available() - Method in class com.noelios.restlet.application.RangeInputStream

available() - Method in class com.noelios.restlet.http.InputEntityStream

B

Base64 - Class in com.noelios.restlet.util

Minimal but fast Base64 codec.

Base64() - Constructor for class com.noelios.restlet.util.Base64

beforeHandle(Request, Response) - Method in class com.noelios.restlet.application.Decoder

Allows filtering before its handling by the target Restlet.

beforeHandle(Request, Response) - Method in class com.noelios.restlet.application.Encoder

Allows filtering before its handling by the target Restlet.

beforeHandle(Request, Response) - Method in class com.noelios.restlet.application.TunnelFilter

beforeHandle(Request, Response) - Method in class com.noelios.restlet.component.HostRoute

Allows filtering before processing by the next Restlet.

beforeHandle(Request, Response) - Method in class com.noelios.restlet.LogFilter

Allows filtering before processing by the next Restlet.

blockingLock() - Method in class com.noelios.restlet.http.ReadableEntityChannel

C

canDecode(Representation) - Method in class com.noelios.restlet.application.Decoder

Indicates if a representation can be decoded.

canDecode() - Method in class com.noelios.restlet.application.DecodeRepresentation

Indicates if the decoding can happen.

canEncode(Representation) - Method in class com.noelios.restlet.application.Encoder

Indicates if a representation can be encoded.

canEncode() - Method in class com.noelios.restlet.application.EncodeRepresentation

Indicates if the encoding can happen.

ChainHelper<T extends Restlet> - Class in com.noelios.restlet

Chain helper serving as base class for Application and Component helpers.

ChainHelper(T) - Constructor for class com.noelios.restlet.ChainHelper

Constructor.

challenge(Response, boolean, Guard) - Method in class com.noelios.restlet.authentication.AuthenticationHelper

Challenges the client by adding a challenge request to the response and by setting the status to CLIENT_ERROR_UNAUTHORIZED.

challenge(Response, boolean, Guard) - Static method in class com.noelios.restlet.authentication.AuthenticationUtils

Challenges the client by adding a challenge request to the response and by setting the status to CLIENT_ERROR_UNAUTHORIZED.

challenge(Response, boolean, Guard) - Method in class com.noelios.restlet.authentication.HttpDigestHelper

challenge(Response, boolean, Guard) - Method in class com.noelios.restlet.Engine

checkExtensionsConsistency(File, MetadataService) - Method in class com.noelios.restlet.local.FileClientHelper

Check that all extensions of the file correspond to a known metadata.

ChildClientDispatcher - Class in com.noelios.restlet.component

Client dispatcher for a component child.

ChildClientDispatcher(ChildContext) - Constructor for class com.noelios.restlet.component.ChildClientDispatcher

Constructor.

ChildContext - Class in com.noelios.restlet.component

Context based on a parent component's context but dedicated to a child Restlet, typically to an application.

ChildContext(Context) - Constructor for class com.noelios.restlet.component.ChildContext

Constructor.

ChunkedInputStream - Class in com.noelios.restlet.http

InputStream to wrap a source InputStream that has been chunked.

ChunkedInputStream(InputStream) - Constructor for class com.noelios.restlet.http.ChunkedInputStream

Constructor.

ChunkedOutputStream - Class in com.noelios.restlet.http

OutputStream to write data in the HTTP chunked encoding format to a destination OutputStream.

ChunkedOutputStream(OutputStream) - Constructor for class com.noelios.restlet.http.ChunkedOutputStream

Convenience constructor to use a default chunk size size of 2048.

ChunkedOutputStream(OutputStream, int) - Constructor for class com.noelios.restlet.http.ChunkedOutputStream

ClapClientHelper - Class in com.noelios.restlet.local

Connector to the resources accessed via class loaders.

ClapClientHelper(Client) - Constructor for class com.noelios.restlet.local.ClapClientHelper

Constructor.

clear() - Method in class com.noelios.restlet.ChainHelper

Clears the chain.

ClientHelper - Class in com.noelios.restlet

Client connector helper.

ClientHelper(Client) - Constructor for class com.noelios.restlet.ClientHelper

Constructor.

ClientRoute - Class in com.noelios.restlet.component

Router scorer based on a target client connector.

ClientRoute(Router, Client) - Constructor for class com.noelios.restlet.component.ClientRoute

Constructor.

ClientRouter - Class in com.noelios.restlet.component

Router that collects calls from all applications and dispatches them to the appropriate client connectors.

ClientRouter(Component) - Constructor for class com.noelios.restlet.component.ClientRouter

Constructor.

clone() - Method in class com.noelios.restlet.util.DefaultSslContextFactory

This class is likely to contain sensitive information; cloning is therefore not allowed.

close() - Method in class com.noelios.restlet.http.ChunkedInputStream

Close this input stream but do not close the underlying stream.

close() - Method in class com.noelios.restlet.http.ChunkedOutputStream

Closes this output stream for writing but does not close the wrapped stream.

close() - Method in class com.noelios.restlet.http.InputEntityStream

close() - Method in class com.noelios.restlet.util.KeepAliveInputStream

close() - Method in class com.noelios.restlet.util.KeepAliveOutputStream

close() - Method in class com.noelios.restlet.util.TraceHandler

com.noelios.restlet - package com.noelios.restlet

Core classes of the implementation.

com.noelios.restlet.application - package com.noelios.restlet.application

Implementation of Applications.

com.noelios.restlet.authentication - package com.noelios.restlet.authentication

Support for pluggable authentication.

com.noelios.restlet.component - package com.noelios.restlet.component

Implementation of Components.

com.noelios.restlet.http - package com.noelios.restlet.http

Implementation of HTTP Connectors.

com.noelios.restlet.local - package com.noelios.restlet.local

Implementation of local Clients.

com.noelios.restlet.util - package com.noelios.restlet.util

Implementation utilities.

commit(HttpClientCall, Request, Response) - Method in class com.noelios.restlet.http.HttpClientConverter

Commits the changes to a handled HTTP client call back into the original uniform call.

commit(HttpResponse) - Method in class com.noelios.restlet.http.HttpServerConverter

Commits the changes to a handled uniform call back into the original HTTP call.

complete() - Method in class com.noelios.restlet.http.HttpServerCall

Complete the response

complete() - Method in class com.noelios.restlet.http.StreamServerCall

ComponentClientDispatcher - Class in com.noelios.restlet.component

Component client dispatcher.

ComponentClientDispatcher(ComponentContext) - Constructor for class com.noelios.restlet.component.ComponentClientDispatcher

Constructor.

ComponentContext - Class in com.noelios.restlet.component

Context allowing access to the component's connectors.

ComponentContext(ComponentHelper) - Constructor for class com.noelios.restlet.component.ComponentContext

Constructor.

ComponentHelper - Class in com.noelios.restlet.component

Component helper.

ComponentHelper(Component) - Constructor for class com.noelios.restlet.component.ComponentHelper

Constructor.

ComponentServerDispatcher - Class in com.noelios.restlet.component

Component server dispatcher.

ComponentServerDispatcher(ComponentContext) - Constructor for class com.noelios.restlet.component.ComponentServerDispatcher

Constructor.

ComponentStatusFilter - Class in com.noelios.restlet.component

Status filter that tries to obtain ouput representation from an application.

ComponentStatusFilter(Component) - Constructor for class com.noelios.restlet.component.ComponentStatusFilter

Constructor.

configureBlocking(boolean) - Method in class com.noelios.restlet.http.ReadableEntityChannel

ConnectorHelper<T extends Connector> - Class in com.noelios.restlet

Base connector helper.

ConnectorHelper(T) - Constructor for class com.noelios.restlet.ConnectorHelper

Constructor.

ContentType - Class in com.noelios.restlet.http

Association of a media type and a character set.

ContentType(String) - Constructor for class com.noelios.restlet.http.ContentType

Constructor.

CookieReader - Class in com.noelios.restlet.http

Cookie header reader.

CookieReader(String) - Constructor for class com.noelios.restlet.http.CookieReader

Constructor.

CookieUtils - Class in com.noelios.restlet.http

Cookie manipulation utilities.

CookieUtils() - Constructor for class com.noelios.restlet.http.CookieUtils

copyResponseEntityHeaders(Iterable<Parameter>, Representation) - Static method in class com.noelios.restlet.http.HttpClientCall

Copies entity headers into a response and ensures that a non null representation is returned when at least one entity header is present.

copyResponseHeaders(Iterable<Parameter>, Response) - Method in class com.noelios.restlet.Engine

Copies the given header parameters into the given Response.

copyResponseHeaders(Response, Series<Parameter>) - Method in class com.noelios.restlet.Engine

Copies the headers of the given Response into the given Series.

copyResponseTransportHeaders(Iterable<Parameter>, Response) - Static method in class com.noelios.restlet.http.HttpClientConverter

Copies headers into a response.

create(Request) - Method in class com.noelios.restlet.http.HttpClientHelper

Creates a low-level HTTP client call from a high-level request.

create(Request) - Method in class com.noelios.restlet.http.StreamClientHelper

create(CharSequence, CharSequence, boolean, CharacterSet) - Static method in class com.noelios.restlet.util.FormUtils

Creates a parameter.

createChildContext() - Method in class com.noelios.restlet.component.ChildContext

createChildContext() - Method in class com.noelios.restlet.component.ComponentContext

createDecoderFilter(Application) - Method in class com.noelios.restlet.application.ApplicationHelper

Creates a new decoder filter.

createDirectoryResource(Directory, Request, Response) - Method in class com.noelios.restlet.Engine

createHelper(Application) - Method in class com.noelios.restlet.Engine

createHelper(Client, String) - Method in class com.noelios.restlet.Engine

createHelper(Component) - Method in class com.noelios.restlet.Engine

createHelper(Server, String) - Method in class com.noelios.restlet.Engine

createLogFilter(Context, LogService) - Method in class com.noelios.restlet.ChainHelper

Creates a new log filter.

createParameter(CharSequence, CharSequence) - Static method in class com.noelios.restlet.http.HttpUtils

Creates a parameter.

createPreference(CharSequence, Series<Parameter>) - Method in class com.noelios.restlet.http.PreferenceReader

Creates a new preference.

createRangeFilter(Context) - Method in class com.noelios.restlet.application.ApplicationHelper

Creates a new Range filter.

createReference(String, String, String, String) - Method in class com.noelios.restlet.local.EntityClientHelper

Generate a Reference for a variant name (which is URL decoded) and handle the translation between the incoming requested path (which is URL encoded).

createServerSocket() - Method in class com.noelios.restlet.http.StreamServerHelper

Create a server socket channel and bind it to the given address

createSocket(String, int) - Method in class com.noelios.restlet.http.StreamClientCall

Creates the socket that will be used to send the request and get the response.

createSocketAddress() - Method in class com.noelios.restlet.http.StreamServerHelper

Creates a socket address to listen on.

createSslContext() - Method in class com.noelios.restlet.util.DefaultSslContextFactory

Creates a configured and initialised SSLContext from the values set via the various setters of this class.

createSslContext() - Method in class com.noelios.restlet.util.SslContextFactory

Creates a configured and initialised SSLContext.

createStatusFilter(Application) - Method in class com.noelios.restlet.application.ApplicationHelper

Creates a new status filter.

createStatusFilter(Component) - Method in class com.noelios.restlet.component.ComponentHelper

Creates a new status filter.

createTunnelFilter(Context) - Method in class com.noelios.restlet.application.ApplicationHelper

Creates a new tunnel filter.

createVaryHeader(Collection<Dimension>) - Static method in class com.noelios.restlet.http.HttpUtils

Creates a vary header from the given dimensions.

D

decode(Representation) - Method in class com.noelios.restlet.application.Decoder

Decodes a given representation if its encodings are supported by NRE.

decode(String) - Static method in class com.noelios.restlet.util.Base64

Decodes a base64 string into bytes.

Decoder - Class in com.noelios.restlet.application

Filter decompressing entities.

Decoder(Context) - Constructor for class com.noelios.restlet.application.Decoder

Constructor to only decode request entities before handling.

Decoder(Context, boolean, boolean) - Constructor for class com.noelios.restlet.application.Decoder

Constructor.

DecodeRepresentation - Class in com.noelios.restlet.application

Representation that decodes a wrapped representation if its encoding is supported.

DecodeRepresentation(Representation) - Constructor for class com.noelios.restlet.application.DecodeRepresentation

Constructor.

DefaultAccessLogFormatter - Class in com.noelios.restlet.util

Access log record formatter which writes a header describing the default log format.

DefaultAccessLogFormatter() - Constructor for class com.noelios.restlet.util.DefaultAccessLogFormatter

DefaultSslContextFactory - Class in com.noelios.restlet.util

This SslContextFactory makes it possible to configure most basic options when building an SSLContext.

DefaultSslContextFactory() - Constructor for class com.noelios.restlet.util.DefaultSslContextFactory

DESCRIPTOR_AUTHENTICATION - Static variable in class com.noelios.restlet.Engine

DESCRIPTOR_AUTHENTICATION_PATH - Static variable in class com.noelios.restlet.Engine

DESCRIPTOR_CLIENT - Static variable in class com.noelios.restlet.Engine

DESCRIPTOR_CLIENT_PATH - Static variable in class com.noelios.restlet.Engine

DESCRIPTOR_PATH - Static variable in class com.noelios.restlet.Engine

DESCRIPTOR_SERVER - Static variable in class com.noelios.restlet.Engine

DESCRIPTOR_SERVER_PATH - Static variable in class com.noelios.restlet.Engine

DirectoryResource - Class in com.noelios.restlet.local

Resource supported by a set of context representations (from file system, class loaders and webapp context).

DirectoryResource(Directory, Request, Response) - Constructor for class com.noelios.restlet.local.DirectoryResource

This constructor aims at answering the following questions:
does this request target a directory? does this request target a directory, with an index file? should this request be redirected (target is a directory with no trailing "/")? does this request target a file?
The following constraints must be taken into account:
the underlying helper may not support content negotiation and be able to return the list of possible variants of the target file (e.g.

doHandle(Request, Response) - Method in class com.noelios.restlet.component.ChildClientDispatcher

Transmits the call to the parent component except if the call is internal as denoted by the Protocol.RIAP protocol and targets this child application.

doHandle(Request, Response) - Method in class com.noelios.restlet.component.ComponentClientDispatcher

doHandle(Request, Response) - Method in class com.noelios.restlet.component.ComponentServerDispatcher

doHandle(Request, Response) - Method in class com.noelios.restlet.StatusFilter

Handles the call by distributing it to the next Restlet.

doHandle(Request, Response) - Method in class com.noelios.restlet.TemplateDispatcher

Actually handles the call.

E

encode(ClientInfo, Representation) - Method in class com.noelios.restlet.application.Encoder

Encodes a given representation if an encoding is supported by the client.

encode(byte[], boolean) - Static method in class com.noelios.restlet.util.Base64

Encodes an entire byte array into a Base64 string, with optional newlines after every 76 characters.

encode(byte[], int, int, boolean) - Static method in class com.noelios.restlet.util.Base64

Encodes specified bytes into a Base64 string, with optional newlines after every 76 characters.

ENCODE_ALL_SIZES - Static variable in class com.noelios.restlet.application.Encoder

Indicates if the encoding should always occur, regardless of the size.

Encoder - Class in com.noelios.restlet.application

Filter compressing entities.

Encoder(Context) - Constructor for class com.noelios.restlet.application.Encoder

Constructor using the default media types and with Encoder.ENCODE_ALL_SIZES setting.

Encoder(Context, boolean, boolean, long, List<MediaType>, List<MediaType>) - Constructor for class com.noelios.restlet.application.Encoder

Constructor.

EncodeRepresentation - Class in com.noelios.restlet.application

Content that encodes a wrapped content.

EncodeRepresentation(Encoding, Representation) - Constructor for class com.noelios.restlet.application.EncodeRepresentation

Constructor.

Engine - Class in com.noelios.restlet

Restlet factory supported by the engine.

Engine() - Constructor for class com.noelios.restlet.Engine

Constructor that will automatically attempt to discover connectors.

Engine(boolean) - Constructor for class com.noelios.restlet.Engine

Constructor.

Entity - Class in com.noelios.restlet.local

Represents a local entity, for example a regular file or a directory.

Entity() - Constructor for class com.noelios.restlet.local.Entity

EntityClientHelper - Class in com.noelios.restlet.local

Connector to the local entities.

EntityClientHelper(Client) - Constructor for class com.noelios.restlet.local.EntityClientHelper

Constructor.

exists() - Method in class com.noelios.restlet.local.Entity

Indicates if the entity does exist.

exists() - Method in class com.noelios.restlet.local.FileEntity

extractKeySize(String) - Static method in class com.noelios.restlet.http.HttpsUtils

Extract the SSL key size of a given cipher suite.

extractMediaParams(Series<Parameter>) - Method in class com.noelios.restlet.http.PreferenceReader

Extract the media parameters.

extractQuality(Series<Parameter>) - Method in class com.noelios.restlet.http.PreferenceReader

Extract the quality value.

F

FileClientHelper - Class in com.noelios.restlet.local

Connector to the file resources accessible.

FileClientHelper(Client) - Constructor for class com.noelios.restlet.local.FileClientHelper

Constructor.

FileEntity - Class in com.noelios.restlet.local

Local entity based on a regular File.

FileEntity(File) - Constructor for class com.noelios.restlet.local.FileEntity

Constructor.

findHelper(ChallengeScheme, boolean, boolean) - Method in class com.noelios.restlet.Engine

Finds the authentication helper supporting the given scheme.

fireContextChanged(Restlet, Context) - Method in class com.noelios.restlet.Engine

Indicates that a Restlet's context has changed.

flush() - Method in class com.noelios.restlet.http.ChunkedOutputStream

Writes the current chunk and flushes the wrapped stream.

flush() - Method in class com.noelios.restlet.util.TraceHandler

format(ChallengeRequest) - Method in class com.noelios.restlet.authentication.AuthenticationHelper

Formats a challenge request as a HTTP header value.

format(ChallengeResponse, Request, Series<Parameter>) - Method in class com.noelios.restlet.authentication.AuthenticationHelper

Formats a challenge response as raw credentials.

format(ChallengeRequest) - Static method in class com.noelios.restlet.authentication.AuthenticationUtils

Formats a challenge request as a HTTP header value.

format(ChallengeResponse, Request, Series<Parameter>) - Static method in class com.noelios.restlet.authentication.AuthenticationUtils

Formats a challenge response as raw credentials.

format(ChallengeRequest) - Method in class com.noelios.restlet.authentication.HttpAmazonS3Helper

format(Cookie) - Static method in class com.noelios.restlet.http.CookieUtils

Formats a cookie.

format(Cookie, Appendable) - Static method in class com.noelios.restlet.http.CookieUtils

Formats a cookie setting.

format(CookieSetting) - Static method in class com.noelios.restlet.http.CookieUtils

Formats a cookie setting.

format(CookieSetting, Appendable) - Static method in class com.noelios.restlet.http.CookieUtils

Formats a cookie setting.

format(List<Cookie>) - Static method in class com.noelios.restlet.http.CookieUtils

Formats a list of cookies as an HTTP header.

format(List<? extends Preference<?>>) - Static method in class com.noelios.restlet.http.PreferenceUtils

Formats a list of preferences with a comma separator.

format(Preference, Appendable) - Static method in class com.noelios.restlet.http.PreferenceUtils

Formats a preference.

format(Request, Response) - Method in class com.noelios.restlet.LogFilter

Format a log entry.

format(LogRecord) - Method in class com.noelios.restlet.util.AccessLogFormatter

formatContentDisposition(String) - Static method in class com.noelios.restlet.http.HttpServerCall

Format fileName as a Content-Disposition header value

formatContentRange(Range, long) - Static method in class com.noelios.restlet.util.RangeUtils

Format range as a Content-Range header value

formatCookie(Cookie) - Method in class com.noelios.restlet.Engine

formatCookieSetting(CookieSetting) - Method in class com.noelios.restlet.Engine

formatCredentials(StringBuilder, ChallengeResponse, Request, Series<Parameter>) - Method in class com.noelios.restlet.authentication.AuthenticationHelper

Formats a challenge response as raw credentials.

formatCredentials(StringBuilder, ChallengeResponse, Request, Series<Parameter>) - Method in class com.noelios.restlet.authentication.HttpAmazonS3Helper

formatCredentials(StringBuilder, ChallengeResponse, Request, Series<Parameter>) - Method in class com.noelios.restlet.authentication.HttpBasicHelper

formatCredentials(StringBuilder, ChallengeResponse, Request, Series<Parameter>) - Method in class com.noelios.restlet.authentication.HttpDigestHelper

formatCredentials(StringBuilder, ChallengeResponse, Request, Series<Parameter>) - Method in class com.noelios.restlet.authentication.SmtpPlainHelper

formatDate(Date, boolean) - Static method in class com.noelios.restlet.http.HttpCall

Formats a date as a header string.

formatDefault(Request, Response, int) - Method in class com.noelios.restlet.LogFilter

Format a log entry using the default format.

formatDimensions(Collection<Dimension>) - Method in class com.noelios.restlet.Engine

formatParameters(StringBuilder, Series<Parameter>, ChallengeRequest) - Method in class com.noelios.restlet.authentication.AuthenticationHelper

Formats the parameters of a challenge request, to be appended to the scheme technical name and realm.

formatParameters(StringBuilder, Series<Parameter>, ChallengeRequest) - Method in class com.noelios.restlet.authentication.HttpDigestHelper

formatProduct(CharSequence, CharSequence, Appendable) - Static method in class com.noelios.restlet.http.HttpUtils

Formats a product description.

formatQuality(float, Appendable) - Static method in class com.noelios.restlet.http.PreferenceUtils

Formats a quality value.
If the quality is invalid, an IllegalArgumentException is thrown.

formatRanges(List<Range>) - Static method in class com.noelios.restlet.util.RangeUtils

Format ranges as a Range header value

formatUserAgent(List<Product>) - Method in class com.noelios.restlet.Engine

FormReader - Class in com.noelios.restlet.util

Form reader.

FormReader(Representation) - Constructor for class com.noelios.restlet.util.FormReader

Constructor.
In case the representation does not define a character set, the UTF-8 character set is used.

FormReader(String, char) - Constructor for class com.noelios.restlet.util.FormReader

Constructor.

FormReader(String, CharacterSet, char) - Constructor for class com.noelios.restlet.util.FormReader

Constructor.

FormUtils - Class in com.noelios.restlet.util

Representation of a Web form containing submitted parameters.

FormUtils() - Constructor for class com.noelios.restlet.util.FormUtils

G

getAcceptedMediaTypes() - Method in class com.noelios.restlet.application.Encoder

Returns the media types that should be encoded.

getBaseName() - Method in class com.noelios.restlet.local.DirectoryResource

Returns the local base name of the file.

getBaseName(String, MetadataService) - Static method in class com.noelios.restlet.local.Entity

Return the base name that is to say the longest part of a given name without known extensions (beginning from the left).

getBaseName(MetadataService) - Method in class com.noelios.restlet.local.Entity

Return the base name of this entity that is to say the longest part of the name without known extensions (beginning from the left).

getBestClassName(Class<?>) - Static method in class com.noelios.restlet.component.ChildContext

Return the best class name.

getBestEncoding(ClientInfo) - Method in class com.noelios.restlet.application.Encoder

Returns the best supported encoding for a given client.

getChallengeResponse() - Method in class com.noelios.restlet.http.HttpRequest

getChallengeScheme() - Method in class com.noelios.restlet.authentication.AuthenticationHelper

Returns the supported challenge scheme.

getChannel() - Method in class com.noelios.restlet.application.DecodeRepresentation

Returns a readable byte channel.

getChannel() - Method in class com.noelios.restlet.application.EncodeRepresentation

Returns a readable byte channel.

getCharacterSet() - Method in class com.noelios.restlet.http.ContentType

Returns the character set.

getChild() - Method in class com.noelios.restlet.component.ChildContext

Returns the child.

getChildren() - Method in class com.noelios.restlet.local.Entity

Returns the list of contained entities if the current entity is a directory, null otherwise.

getChildren() - Method in class com.noelios.restlet.local.FileEntity

getClient() - Method in class com.noelios.restlet.component.ClientRoute

Returns the target client.

getClientAddress() - Method in class com.noelios.restlet.http.HttpCall

Returns the client address.
Corresponds to the IP address of the requesting client.

getClientAddress() - Method in class com.noelios.restlet.http.StreamServerCall

getClientDispatcher() - Method in class com.noelios.restlet.component.ChildContext

getClientDispatcher() - Method in class com.noelios.restlet.component.ComponentContext

getClientInfo() - Method in class com.noelios.restlet.http.HttpRequest

Returns the client-specific information.

getClientPort() - Method in class com.noelios.restlet.http.HttpCall

Returns the client port.
Corresponds to the TCP/IP port of the requesting client.

getClientPort() - Method in class com.noelios.restlet.http.StreamServerCall

getClientRouter() - Method in class com.noelios.restlet.component.ComponentHelper

Returns the internal client router.

getComponent() - Method in class com.noelios.restlet.component.ComponentStatusFilter

Returns the component.

getComponentHelper() - Method in class com.noelios.restlet.component.ComponentContext

Returns the component helper.

getConditions() - Method in class com.noelios.restlet.http.HttpRequest

Returns the condition data applying to this call.

getConnectorService(Request) - Method in class com.noelios.restlet.http.HttpCall

Returns the connector service associated to a request.

getConnectTimeout() - Method in class com.noelios.restlet.ClientHelper

Returns the connection timeout.

getContentLength(Series<Parameter>) - Method in class com.noelios.restlet.http.HttpCall

Returns the content length of the request entity if know, Representation.UNKNOWN_SIZE otherwise.

getContentLength() - Method in class com.noelios.restlet.http.HttpClientCall

Returns the content length of the request entity if know, Representation.UNKNOWN_SIZE otherwise.

getContentLength() - Method in class com.noelios.restlet.http.HttpServerCall

Returns the content length of the request entity if know, Representation.UNKNOWN_SIZE otherwise.

getContext() - Method in class com.noelios.restlet.http.HttpConverter

Returns the context.

getContext() - Method in class com.noelios.restlet.TemplateDispatcher

Returns the context.

getConverter() - Method in class com.noelios.restlet.http.HttpClientHelper

Returns the converter from uniform calls to HTTP calls.

getConverter() - Method in class com.noelios.restlet.http.HttpServerHelper

Returns the converter from HTTP calls to uniform calls.

getCookies(List<Cookie>, Map<String, Cookie>) - Static method in class com.noelios.restlet.http.CookieUtils

Gets the cookies whose name is a key in the given map.

getCookies() - Method in class com.noelios.restlet.http.HttpRequest

Returns the cookies provided by the client.

getDefaultAcceptedMediaTypes() - Static method in class com.noelios.restlet.application.Encoder

Returns the list of default encoded media types.

getDefaultIgnoredMediaTypes() - Static method in class com.noelios.restlet.application.Encoder

Returns the list of default ignored media types.

getDefaultLanguage() - Method in class com.noelios.restlet.local.LocalClientHelper

Returns the default language.

getDirectory() - Method in class com.noelios.restlet.local.DirectoryResource

Returns the parent directory handler.

getDirectoryUri() - Method in class com.noelios.restlet.local.DirectoryResource

Returns the context's directory URI (file, clap URI).

getDisabledCipherSuites(Helper<?>) - Static method in class com.noelios.restlet.http.HttpsUtils

Returns the list of disabled cipher suites.

getEnabledCipherSuites(Helper<?>) - Static method in class com.noelios.restlet.http.HttpsUtils

Returns the list of enabled cipher suites.

getEncodings() - Method in class com.noelios.restlet.application.DecodeRepresentation

Returns the encodings applied to the entity.

getEncodings() - Method in class com.noelios.restlet.application.EncodeRepresentation

Returns the applied encodings.

getEntity() - Method in class com.noelios.restlet.http.HttpRequest

Returns the representation provided by the client.

getEntity(String) - Method in class com.noelios.restlet.local.EntityClientHelper

Returns a local entity for the given path.

getEntity(String) - Method in class com.noelios.restlet.local.FileClientHelper

getExtensions(String) - Static method in class com.noelios.restlet.local.DirectoryResource

Returns the set of extensions contained in a given directory entry name.

getExtensions(String, MetadataService) - Static method in class com.noelios.restlet.local.Entity

Returns the list of known extensions taken from a given entity name.

getExtensions(MetadataService) - Method in class com.noelios.restlet.local.Entity

Returns the list of known extensions.

getFile() - Method in class com.noelios.restlet.local.FileEntity

Returns the underlying regular file.

getFirst() - Method in class com.noelios.restlet.ChainHelper

Returns the first Restlet.

getFirstParameter(Representation, String) - Static method in class com.noelios.restlet.util.FormUtils

Reads the first parameter with the given name.

getFirstParameter(String, String, CharacterSet, char) - Static method in class com.noelios.restlet.util.FormUtils

Reads the first parameter with the given name.

getHead(Handler) - Method in class com.noelios.restlet.util.DefaultAccessLogFormatter

getHelper() - Method in class com.noelios.restlet.http.HttpClientCall

Returns the HTTP client helper.

getHelper() - Method in class com.noelios.restlet.http.StreamClientCall

getHostDomain() - Method in class com.noelios.restlet.http.HttpCall

Returns the host domain.

getHostDomain() - Method in class com.noelios.restlet.http.HttpServerCall

Returns the host domain name.

getHostPort() - Method in class com.noelios.restlet.http.HttpCall

Returns the host port.

getHostPort() - Method in class com.noelios.restlet.http.HttpServerCall

Returns the host port.

getHostType() - Method in class com.noelios.restlet.util.IdentClient

Returns the remote host type.

getHttpCall() - Method in class com.noelios.restlet.http.HttpRequest

Returns the low-level HTTP call.

getHttpCall() - Method in class com.noelios.restlet.http.HttpResponse

Returns the low-level HTTP call.

getIgnoredMediaTypes() - Method in class com.noelios.restlet.application.Encoder

Returns the media types that should be ignored.

getInstance() - Static method in class com.noelios.restlet.Engine

Returns the registered Noelios Restlet engine.

getJavaMajorVersion() - Static method in class com.noelios.restlet.Engine

Parses the "java.version" system property and returns the first digit of the version number of the Java Runtime Environment (e.g.

getJavaMinorVersion() - Static method in class com.noelios.restlet.Engine

Parses the "java.version" system property and returns the second digit of the version number of the Java Runtime Environment (e.g.

getJavaUpdateVersion() - Static method in class com.noelios.restlet.Engine

Parses the "java.version" system property and returns the update release number of the Java Runtime Environment (e.g.

getLast() - Method in class com.noelios.restlet.ChainHelper

Returns the last Filter.

getLocalAddress() - Static method in class com.noelios.restlet.http.HttpClientCall

Returns the local IP address or 127.0.0.1 if the resolution fails.

getLogger() - Method in class com.noelios.restlet.authentication.AuthenticationHelper

Returns the context's logger.

getLogger() - Method in class com.noelios.restlet.http.HttpCall

Returns the logger.

getLogger() - Method in class com.noelios.restlet.http.HttpConverter

Returns the logger.

getLogger() - Method in class com.noelios.restlet.TemplateDispatcher

Returns the context's logger.

getLoggerName(String, Object) - Static method in class com.noelios.restlet.component.ChildContext

Returns a non-null logger name.

getMediaType() - Method in class com.noelios.restlet.http.ContentType

Returns the media type.

getMetadataService() - Method in class com.noelios.restlet.application.TunnelFilter

Returns the metadata service of the parent application.

getMetadataService(Request) - Method in class com.noelios.restlet.local.LocalClientHelper

Returns the metadata service associated to a request.

getMethod() - Method in class com.noelios.restlet.http.HttpCall

Returns the request method.

getMinimumSize() - Method in class com.noelios.restlet.application.Encoder

Returns the minimum size a representation must have before compression is done.

getName() - Method in class com.noelios.restlet.local.Entity

Returns the name.

getName() - Method in class com.noelios.restlet.local.FileEntity

getNext(Request, Response) - Method in class com.noelios.restlet.component.ClientRouter

getParameter(Representation, String) - Static method in class com.noelios.restlet.util.FormUtils

Reads the parameters with the given name.
If multiple values are found, a list is returned created.

getParameter(String, String, CharacterSet, char) - Static method in class com.noelios.restlet.util.FormUtils

Reads the parameters with the given name.
If multiple values are found, a list is returned created.

getParameters(Representation, Map<String, Object>) - Static method in class com.noelios.restlet.util.FormUtils

Reads the parameters whose name is a key in the given map.
If a matching parameter is found, its value is put in the map.
If multiple values are found, a list is created and set in the map.

getParameters(String, Map<String, Object>, CharacterSet, char) - Static method in class com.noelios.restlet.util.FormUtils

Reads the parameters whose name is a key in the given map.
If a matching parameter is found, its value is put in the map.
If multiple values are found, a list is created and set in the map.

getParent() - Method in class com.noelios.restlet.local.Entity

Returns the parent directory (if any).

getParent() - Method in class com.noelios.restlet.local.FileEntity

getParentContext() - Method in class com.noelios.restlet.component.ChildContext

Returns the parent context.

getPreferredVariant(ClientInfo, List<Variant>, Language) - Method in class com.noelios.restlet.Engine

getProtocol() - Method in class com.noelios.restlet.http.HttpCall

Returns the exact protocol (HTTP or HTTPS).

getProtocols() - Method in class com.noelios.restlet.ConnectorHelper

Returns the protocols simultaneously supported.

getRanges() - Method in class com.noelios.restlet.http.HttpRequest

getRangeService() - Method in class com.noelios.restlet.application.RangeFilter

Returns the Range service of the parent application.

getReasonPhrase() - Method in class com.noelios.restlet.http.HttpCall

Returns the reason phrase.

getReencodedVariantEntityName(String, String) - Method in class com.noelios.restlet.local.EntityClientHelper

Percent-encodes the given percent-decoded variant name of a resource whose percent-encoded name is given.

getReferrerRef() - Method in class com.noelios.restlet.http.HttpRequest

Returns the referrer reference if available.

getRegisteredAuthentications() - Method in class com.noelios.restlet.Engine

Returns the list of available authentication helpers.

getRegisteredClients() - Method in class com.noelios.restlet.Engine

Returns the list of available client connectors.

getRegisteredServers() - Method in class com.noelios.restlet.Engine

Returns the list of available server connectors.

getRepresentation(Status, Request, Response) - Method in class com.noelios.restlet.application.ApplicationStatusFilter

getRepresentation(Status, Request, Response) - Method in class com.noelios.restlet.component.ComponentStatusFilter

getRepresentation(InputStream) - Method in class com.noelios.restlet.http.HttpClientCall

Returns the representation wrapping the given stream.

getRepresentation(ReadableByteChannel) - Method in class com.noelios.restlet.http.HttpClientCall

Returns the representation wrapping the given channel.

getRepresentation(InputStream) - Method in class com.noelios.restlet.http.StreamClientCall

getRepresentation(MediaType, int) - Method in class com.noelios.restlet.local.Entity

Returns a representation of this local entity.

getRepresentation(MediaType, int) - Method in class com.noelios.restlet.local.FileEntity

getRepresentation(Status, Request, Response) - Method in class com.noelios.restlet.StatusFilter

Returns a representation for the given status.
In order to customize the default representation, this method can be overriden.

getRequestEntity() - Method in class com.noelios.restlet.http.HttpServerCall

Returns the request entity if available.

getRequestEntityChannel() - Method in class com.noelios.restlet.http.HttpClientCall

Returns the request entity channel if it exists.

getRequestEntityChannel(long) - Method in class com.noelios.restlet.http.HttpServerCall

Returns the request entity channel if it exists.

getRequestEntityChannel() - Method in class com.noelios.restlet.http.StreamClientCall

getRequestEntityChannel(long) - Method in class com.noelios.restlet.http.StreamServerCall

getRequestEntityStream() - Method in class com.noelios.restlet.http.HttpClientCall

Returns the request entity stream if it exists.

getRequestEntityStream(long) - Method in class com.noelios.restlet.http.HttpServerCall

Returns the request entity stream if it exists.

getRequestEntityStream() - Method in class com.noelios.restlet.http.StreamClientCall

getRequestEntityStream(long) - Method in class com.noelios.restlet.http.StreamServerCall

getRequestHeadChannel() - Method in class com.noelios.restlet.http.HttpServerCall

Returns the request head channel if it exists.

getRequestHeadChannel() - Method in class com.noelios.restlet.http.StreamServerCall

getRequestHeaders() - Method in class com.noelios.restlet.http.HttpCall

Returns the modifiable list of request headers.

getRequestHeadStr