Package | Description |
---|---|
org.restlet |
Core classes of the API.
|
org.restlet.data |
Information exchanged by components.
|
org.restlet.engine |
Implementation of Restlet API.
|
org.restlet.engine.http |
Supports HTTP connectors.
|
org.restlet.engine.http.connector |
New advanced internal HTTP connector.
|
org.restlet.engine.http.header |
Supports HTTP header parsing and formatting.
|
org.restlet.engine.http.security |
Supports HTTP security.
|
org.restlet.engine.security |
Supports security.
|
org.restlet.engine.util |
General utilities.
|
org.restlet.ext.netty.internal | |
org.restlet.ext.simple.internal | |
org.restlet.security |
Classes related to security.
|
org.restlet.util |
Various utility classes.
|
Modifier and Type | Method and Description |
---|---|
Series<Parameter> |
Context.getParameters()
Returns the modifiable series of parameters.
|
Modifier and Type | Method and Description |
---|---|
void |
Context.setParameters(Series<Parameter> parameters)
Sets the modifiable series of parameters.
|
Modifier and Type | Class and Description |
---|---|
class |
CacheDirective
Directive for caching mechanisms along the call chain.
|
class |
Cookie
Cookie provided by a client.
|
class |
CookieSetting
Cookie setting provided by a server.
|
class |
Expectation
Particular server behavior that is required by a client.
|
Modifier and Type | Method and Description |
---|---|
static Parameter |
Parameter.create(java.lang.CharSequence name,
java.lang.CharSequence value)
Creates a parameter.
|
Parameter |
Form.createEntry(java.lang.String name,
java.lang.String value) |
Modifier and Type | Method and Description |
---|---|
Series<Parameter> |
Form.createSeries(java.util.List<Parameter> delegate) |
Series<Parameter> |
Preference.getParameters()
Returns the modifiable list of parameters.
|
Series<Parameter> |
MediaType.getParameters()
Returns the unmodifiable list of parameters.
|
java.util.List<Parameter> |
Expectation.getParameters()
Returns the list of parameters.
|
Series<Parameter> |
ChallengeMessage.getParameters()
Returns the modifiable series of scheme parameters.
|
Series<Parameter> |
Disposition.getParameters()
Returns the list of disposition parameters.
|
Modifier and Type | Method and Description |
---|---|
int |
Parameter.compareTo(Parameter o)
Compares this object with the specified object for order.
|
Modifier and Type | Method and Description |
---|---|
Series<Parameter> |
Form.createSeries(java.util.List<Parameter> delegate) |
void |
Expectation.setParameters(java.util.List<Parameter> parameters)
Sets the list of parameters.
|
void |
Preference.setParameters(Series<Parameter> parameters)
Sets the modifiable list of parameters.
|
void |
ChallengeMessage.setParameters(Series<Parameter> parameters)
Sets the parameters.
|
void |
Disposition.setParameters(Series<Parameter> parameters)
Sets the list of disposition parameters.
|
Constructor and Description |
---|
ChallengeMessage(ChallengeScheme scheme,
Series<Parameter> parameters)
Constructor.
|
ChallengeMessage(ChallengeScheme scheme,
java.lang.String realm,
Series<Parameter> parameters)
Constructor.
|
ChallengeResponse(ChallengeScheme scheme,
java.lang.String identifier,
Series<Parameter> parameters)
Constructor.
|
Disposition(java.lang.String type,
Series<Parameter> parameters)
Constructor.
|
Form(java.util.List<Parameter> delegate)
Constructor.
|
MediaType(java.lang.String name,
Series<Parameter> parameters)
Constructor.
|
MediaType(java.lang.String name,
Series<Parameter> parameters,
java.lang.String description)
Constructor.
|
Preference(T metadata,
float quality,
Series<Parameter> parameters)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
Series<Parameter> |
RestletHelper.getHelpedParameters()
Returns the helped Restlet parameters.
|
Modifier and Type | Method and Description |
---|---|
Series<Parameter> |
HttpResponse.getHeaders()
Returns the HTTP headers.
|
Series<Parameter> |
HttpRequest.getHeaders()
Returns the HTTP headers.
|
Series<Parameter> |
Call.getRequestHeaders()
Returns the modifiable list of request headers.
|
Series<Parameter> |
Call.getResponseHeaders()
Returns the modifiable list of server headers.
|
Modifier and Type | Method and Description |
---|---|
Series<Parameter> |
ConnectedRequest.getHeaders()
Returns the HTTP headers.
|
Modifier and Type | Method and Description |
---|---|
protected void |
Connection.addEntityHeaders(Representation entity,
Series<Parameter> headers)
Adds the entity headers for the given response.
|
protected void |
Connection.addGeneralHeaders(Message message,
Series<Parameter> headers)
|
protected void |
ClientConnection.addRequestHeaders(Request request,
Series<Parameter> headers)
Adds the request headers.
|
protected void |
ServerConnection.addResponseHeaders(Response response,
Series<Parameter> headers)
Adds the response headers.
|
protected void |
ClientConnection.copyResponseTransportHeaders(Series<Parameter> headers,
Response response)
Copies headers into a response.
|
Representation |
Connection.createInboundEntity(Series<Parameter> headers)
Returns the inbound message entity if available.
|
protected ConnectedRequest |
ServerConnection.createRequest(Context context,
ServerConnection connection,
java.lang.String methodName,
java.lang.String resourceUri,
java.lang.String version,
Series<Parameter> headers,
Representation entity,
boolean confidential,
java.security.Principal userPrincipal)
Creates a new request.
|
protected void |
Connection.writeMessage(Response message,
Series<Parameter> headers)
Writes the message and its headers.
|
protected void |
Connection.writeMessageHead(Response message,
java.io.OutputStream headStream,
Series<Parameter> headers)
Writes the message head to the given output stream.
|
protected void |
Connection.writeMessageHead(Response message,
Series<Parameter> headers)
Writes the message head.
|
Constructor and Description |
---|
ConnectedRequest(Context context,
ServerConnection connection,
Method method,
java.lang.String resourceUri,
java.lang.String version,
Series<Parameter> headers,
Representation entity,
boolean confidential,
java.security.Principal userPrincipal)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
protected Parameter |
HeaderReader.createParameter(java.lang.String name)
Creates a new parameter with a null value.
|
protected Parameter |
CacheDirectiveReader.createParameter(java.lang.String name,
java.lang.String value) |
protected Parameter |
HeaderReader.createParameter(java.lang.String name,
java.lang.String value)
Creates a new parameter.
|
protected Parameter |
ExpectationReader.createParameter(java.lang.String name,
java.lang.String value) |
static Parameter |
HeaderReader.readHeader(java.lang.CharSequence header)
Read a header.
|
static Parameter |
HeaderReader.readHeader(java.io.InputStream is,
java.lang.StringBuilder sb)
Read a header.
|
Parameter |
HeaderReader.readParameter()
Reads the next pair as a parameter.
|
Parameter |
ParameterReader.readValue() |
Modifier and Type | Method and Description |
---|---|
protected Series<Parameter> |
PreferenceReader.extractMediaParams(Series<Parameter> parameters)
Extract the media parameters.
|
Modifier and Type | Method and Description |
---|---|
static void |
CacheDirectiveReader.addValues(Parameter header,
java.util.Collection<CacheDirective> collection)
Adds values to the given collection.
|
static void |
DimensionReader.addValues(Parameter header,
java.util.Collection<Dimension> collection)
Adds values to the given collection.
|
static void |
MethodReader.addValues(Parameter header,
java.util.Collection<Method> collection)
Adds values to the given collection.
|
static void |
RecipientInfoReader.addValues(Parameter header,
java.util.Collection<RecipientInfo> collection)
Adds values to the given collection.
|
static void |
WarningReader.addValues(Parameter header,
java.util.Collection<Warning> collection)
Adds values to the given collection.
|
ChallengeWriter |
ChallengeWriter.appendChallengeParameter(Parameter parameter)
Appends a new challenge parameter, prefixed with a comma.
|
HeaderWriter<V> |
HeaderWriter.appendExtension(Parameter extension)
Formats and appends a parameter as an extension.
|
ChallengeWriter |
ChallengeWriter.appendQuotedChallengeParameter(Parameter parameter)
Appends a new parameter, prefixed with a comma.
|
static void |
HeaderUtils.writeHeaderLine(Parameter header,
java.io.OutputStream os)
Writes a header line.
|
Modifier and Type | Method and Description |
---|---|
static void |
HeaderUtils.addEntityHeaders(Representation entity,
Series<Parameter> headers)
Adds the entity headers based on the
Representation to the
Series . |
static void |
HeaderUtils.addExtensionHeaders(Series<Parameter> existingHeaders,
Series<Parameter> additionalHeaders)
Adds extension headers if they are non-standard headers.
|
static void |
HeaderUtils.addExtensionHeaders(Series<Parameter> existingHeaders,
Series<Parameter> additionalHeaders)
Adds extension headers if they are non-standard headers.
|
static void |
HeaderUtils.addGeneralHeaders(Message message,
Series<Parameter> headers)
|
static void |
HeaderUtils.addHeader(java.lang.String headerName,
java.lang.String headerValue,
Series<Parameter> headers)
Adds a header to the given list.
|
static void |
HeaderUtils.addNotModifiedEntityHeaders(Representation entity,
Series<Parameter> headers)
Adds the entity headers based on the
Representation to the
Series when a 304 (Not Modified) status is returned. |
static void |
HeaderUtils.addRequestHeaders(Request request,
Series<Parameter> headers)
|
static void |
HeaderUtils.addResponseHeaders(Response response,
Series<Parameter> headers)
|
static void |
HeaderUtils.copyResponseTransportHeaders(Series<Parameter> headers,
Response response)
Copies headers into a response.
|
protected Preference<T> |
PreferenceReader.createPreference(java.lang.CharSequence metadata,
Series<Parameter> parameters)
Creates a new preference.
|
static Representation |
HeaderUtils.extractEntityHeaders(java.lang.Iterable<Parameter> headers,
Representation representation)
Extracts entity headers and updates a given representation or create an
empty one when at least one entity header is present.
|
protected Series<Parameter> |
PreferenceReader.extractMediaParams(Series<Parameter> parameters)
Extract the media parameters.
|
protected float |
PreferenceReader.extractQuality(Series<Parameter> parameters)
Extract the quality value.
|
static long |
HeaderUtils.getContentLength(Series<Parameter> headers)
Returns the content length of the request entity if know,
Representation.UNKNOWN_SIZE otherwise. |
static boolean |
HeaderUtils.isChunkedEncoding(Series<Parameter> headers)
Indicates if the entity is chunked.
|
static boolean |
HeaderUtils.isConnectionClose(Series<Parameter> headers)
Indicates if the connection must be closed.
|
Modifier and Type | Method and Description |
---|---|
void |
HttpBasicHelper.formatRawRequest(ChallengeWriter cw,
ChallengeRequest challenge,
Response response,
Series<Parameter> httpHeaders) |
void |
HttpBasicHelper.formatRawResponse(ChallengeWriter cw,
ChallengeResponse challenge,
Request request,
Series<Parameter> httpHeaders) |
void |
HttpBasicHelper.parseRequest(ChallengeRequest challenge,
Response response,
Series<Parameter> httpHeaders) |
void |
HttpBasicHelper.parseResponse(ChallengeResponse challenge,
Request request,
Series<Parameter> httpHeaders) |
Modifier and Type | Method and Description |
---|---|
void |
AuthenticatorHelper.formatRawRequest(ChallengeWriter cw,
ChallengeRequest challenge,
Response response,
Series<Parameter> httpHeaders)
Formats a challenge request as raw credentials.
|
void |
AuthenticatorHelper.formatRawResponse(ChallengeWriter cw,
ChallengeResponse challenge,
Request request,
Series<Parameter> httpHeaders)
Formats a challenge response as raw credentials.
|
void |
SmtpPlainHelper.formatRawResponse(ChallengeWriter cw,
ChallengeResponse challenge,
Request request,
Series<Parameter> httpHeaders) |
static java.lang.String |
AuthenticatorUtils.formatRequest(ChallengeRequest challenge,
Response response,
Series<Parameter> httpHeaders)
Formats a challenge request as a HTTP header value.
|
java.lang.String |
AuthenticatorHelper.formatRequest(ChallengeRequest challenge,
Response response,
Series<Parameter> httpHeaders)
Formats a challenge request as a HTTP header value.
|
static java.lang.String |
AuthenticatorUtils.formatResponse(ChallengeResponse challenge,
Request request,
Series<Parameter> httpHeaders)
Formats a challenge response as a HTTP header value.
|
java.lang.String |
AuthenticatorHelper.formatResponse(ChallengeResponse challenge,
Request request,
Series<Parameter> httpHeaders)
Formats a challenge response as a HTTP header value.
|
void |
DefaultSslContextFactory.init(Series<Parameter> helperParameters)
Sets the following options according to parameters that may have been set
up directly in the HttpsServerHelper parameters.
|
abstract void |
SslContextFactory.init(Series<Parameter> parameters)
Initialize the factory with the given connector parameters.
|
void |
AuthenticatorHelper.parseRequest(ChallengeRequest challenge,
Response response,
Series<Parameter> httpHeaders)
Parses an authenticate header into a challenge request.
|
static java.util.List<ChallengeRequest> |
AuthenticatorUtils.parseRequest(Response response,
java.lang.String header,
Series<Parameter> httpHeaders)
Parses an authenticate header into a list of challenge request.
|
void |
AuthenticatorHelper.parseResponse(ChallengeResponse challenge,
Request request,
Series<Parameter> httpHeaders)
Parses an authorization header into a challenge response.
|
static ChallengeResponse |
AuthenticatorUtils.parseResponse(Request request,
java.lang.String header,
Series<Parameter> httpHeaders)
Parses an authorization header into a challenge response.
|
Modifier and Type | Method and Description |
---|---|
static Parameter |
FormUtils.create(java.lang.CharSequence name,
java.lang.CharSequence value,
boolean decode,
CharacterSet characterSet)
Creates a parameter.
|
static Parameter |
FormUtils.getFirstParameter(Representation post,
java.lang.String name)
Reads the first parameter with the given name.
|
static Parameter |
FormUtils.getFirstParameter(java.lang.String query,
java.lang.String name,
CharacterSet characterSet,
char separator)
Reads the first parameter with the given name.
|
Parameter |
FormReader.readFirstParameter(java.lang.String name)
Reads the first parameter with the given name.
|
Parameter |
FormReader.readNextParameter()
Reads the next parameter available or null.
|
Modifier and Type | Method and Description |
---|---|
static boolean |
FormUtils.isParameterFound(Parameter searchedParam,
MediaType mediaRange)
Indicates if the searched parameter is specified in the given media
range.
|
Modifier and Type | Method and Description |
---|---|
Series<Parameter> |
NettyServerCall.getRequestHeaders() |
Modifier and Type | Method and Description |
---|---|
Series<Parameter> |
SimpleCall.getRequestHeaders()
Returns the list of request headers.
|
Modifier and Type | Method and Description |
---|---|
Series<Parameter> |
Realm.getParameters()
Returns the modifiable series of parameters.
|
Modifier and Type | Method and Description |
---|---|
void |
Realm.setParameters(Series<Parameter> parameters)
Sets the modifiable series of parameters.
|
Modifier and Type | Class and Description |
---|---|
class |
Series<E extends Parameter>
Modifiable list of entries with many helper methods.
|
Modifier and Type | Method and Description |
---|---|
static Series<? extends Parameter> |
Series.unmodifiableSeries(Series<? extends Parameter> series)
Returns an unmodifiable view of the specified series.
|
Modifier and Type | Method and Description |
---|---|
static Series<? extends Parameter> |
Series.unmodifiableSeries(Series<? extends Parameter> series)
Returns an unmodifiable view of the specified series.
|
Copyright © 2005-2012. All Rights Reserved.