Package | Description |
---|---|
org.restlet |
Core classes of the API.
|
org.restlet.resource |
Client and server resource classes.
|
org.restlet.routing |
Classes related to call routing.
|
org.restlet.security |
Classes related to security.
|
org.restlet.service |
Services used by applications and components.
|
org.restlet.util |
Various utility classes.
|
Modifier and Type | Method and Description |
---|---|
static Request |
Request.getCurrent()
Returns the request associated to the current thread.
|
Request |
Response.getRequest()
Returns the associated request
|
Modifier and Type | Method and Description |
---|---|
Response |
Restlet.handle(Request request)
Handles a call.
|
void |
Server.handle(Request request,
Response response) |
void |
Component.handle(Request request,
Response response) |
void |
Client.handle(Request request,
Response response) |
void |
Uniform.handle(Request request,
Response response)
Handles a uniform call.
|
void |
Restlet.handle(Request request,
Response response)
Handles a call.
|
void |
Application.handle(Request request,
Response response) |
void |
Restlet.handle(Request request,
Response response,
Uniform onResponseCallback)
Handles a call.
|
void |
Restlet.handle(Request request,
Uniform onReceivedCallback)
Handles a call.
|
void |
Response.setRequest(Request request)
Sets the associated request.
|
Constructor and Description |
---|
Request(Request request)
Copy constructor.
|
Response(Request request)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
Request |
ClientResource.createRequest()
Creates a new request by cloning the one wrapped by this class.
|
Request |
ResourceException.getRequest()
Returns the request associated to this exception.
|
Request |
Resource.getRequest()
Returns the handled request.
|
Modifier and Type | Method and Description |
---|---|
ServerResource |
Finder.create(java.lang.Class<? extends ServerResource> targetClass,
Request request,
Response response)
Creates a new instance of a given
ServerResource subclass. |
ServerResource |
Finder.create(Request request,
Response response)
Creates a new instance of the
ServerResource subclass designated
by the "targetClass" property. |
protected Response |
ClientResource.createResponse(Request request)
Creates a new response for the given request.
|
void |
ClientResource.doError(Request request,
Response response)
By default, it throws a new resource exception.
|
void |
ClientResource.doError(Status errorStatus,
Request request,
Response response)
By default, it throws a new resource exception.
|
ServerResource |
Finder.find(Request request,
Response response)
Finds the target
ServerResource if available. |
void |
Directory.handle(Request request,
Response response) |
void |
Finder.handle(Request request,
Response response)
Handles a call.
|
protected void |
ClientResource.handle(Request request,
Response response,
java.util.List<Reference> references,
int retryAttempt,
Uniform next)
Handle the call and follow redirection for safe methods.
|
Response |
ClientResource.handleOutbound(Request request)
Handles the outbound call by invoking the next handler.
|
void |
Resource.init(Context context,
Request request,
Response response)
Initialization method setting the environment of the current resource
instance.
|
protected void |
ClientResource.redirect(Request request,
Response response,
java.util.List<Reference> references,
int retryAttempt,
Uniform next)
Effectively redirects a client call.
|
protected void |
ClientResource.retry(Request request,
Response response,
java.util.List<Reference> references,
int retryAttempt,
Uniform next)
Effectively retries a failed client call.
|
void |
Resource.setRequest(Request request)
Sets the handled request.
|
Constructor and Description |
---|
ClientResource(Context context,
Request request)
Constructor.
|
ClientResource(Context context,
Request request,
Response response)
Constructor.
|
ClientResource(Request request)
Constructor.
|
ClientResource(Request request,
Response response)
Constructor.
|
ResourceException(Status status,
Request request,
Response response)
Constructor.
|
ResourceException(Status status,
java.lang.Throwable cause,
Request request,
Response response)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
protected void |
Filter.afterHandle(Request request,
Response response)
Allows filtering after processing by the next Restlet.
|
protected int |
Validator.beforeHandle(Request request,
Response response)
Allows filtering before its handling by the target Restlet.
|
protected int |
Extractor.beforeHandle(Request request,
Response response)
Allows filtering before its handling by the target Restlet.
|
protected int |
TemplateRoute.beforeHandle(Request request,
Response response)
Allows filtering before its handling by the target Restlet.
|
protected int |
Filter.beforeHandle(Request request,
Response response)
Allows filtering before processing by the next Restlet.
|
protected int |
Filter.doHandle(Request request,
Response response)
Handles the call by distributing it to the next Restlet.
|
protected void |
Router.doHandle(Restlet next,
Request request,
Response response)
|
java.lang.String |
Template.format(Request request,
Response response)
Creates a formatted string based on the given request and response.
|
protected Route |
Router.getCustom(Request request,
Response response)
Returns the matched route according to a custom algorithm.
|
Restlet |
Router.getNext(Request request,
Response response)
Returns the next Restlet if available.
|
protected Reference |
Redirector.getTargetRef(Request request,
Response response)
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. |
void |
Redirector.handle(Request request,
Response response)
Handles a call by redirecting using the selected redirection mode.
|
void |
Router.handle(Request request,
Response response)
Handles a call by invoking the next Restlet if it is available.
|
void |
Filter.handle(Request request,
Response response)
Handles a call by first invoking the beforeHandle() method for
pre-filtering, then distributing the call to the next Restlet via the
doHandle() method.
|
protected void |
Redirector.inboundServerRedirect(Reference targetRef,
Request request,
Response response)
Redirects a given call to a target reference.
|
protected void |
Redirector.outboundServerRedirect(Reference targetRef,
Request request,
Response response)
Redirects a given call to a target reference.
|
int |
Template.parse(java.lang.String formattedString,
Request request)
Attempts to parse a formatted reference.
|
protected void |
Redirector.rewrite(Request initialRequest)
Optionally updates the request sent in the
Redirector.MODE_SERVER_INBOUND
and Redirector.MODE_SERVER_OUTBOUND modes. |
void |
Redirector.rewriteLocation(Request request,
Response response)
Rewrite the location of the response, and the Location of the entity, if
any.
|
abstract float |
Route.score(Request request,
Response response)
Returns the score for a given call (between 0 and 1.0).
|
float |
TemplateRoute.score(Request request,
Response response)
Returns the score for a given call (between 0 and 1.0).
|
protected void |
Redirector.serverRedirect(Restlet next,
Reference targetRef,
Request request,
Response response)
Redirects a given call on the server-side to a next Restlet with a given
target reference.
|
Modifier and Type | Method and Description |
---|---|
protected boolean |
ChallengeAuthenticator.authenticate(Request request,
Response response)
Authenticates the call, relying on the verifier to check the credentials
provided (in general an identifier + secret couple).
|
protected boolean |
CertificateAuthenticator.authenticate(Request request,
Response response)
Authenticates the call using the X.509 client certificate.
|
protected abstract boolean |
Authenticator.authenticate(Request request,
Response response)
Attempts to authenticate the subject sending the request.
|
protected int |
Authenticator.authenticated(Request request,
Response response)
Invoked upon successful authentication.
|
boolean |
RoleAuthorizer.authorize(Request request,
Response response)
Authorizes the request only if its subject is in one of the authorized
roles and in none of the forbidden ones.
|
boolean |
MethodAuthorizer.authorize(Request request,
Response response)
Authorizes the request only if its method is one of the authorized
methods.
|
boolean |
ConfidentialAuthorizer.authorize(Request request,
Response response)
Authorizes the request only if its method is one of the authorized
methods.
|
protected abstract boolean |
Authorizer.authorize(Request request,
Response response)
Attempts to authorize the request.
|
protected int |
Authorizer.authorized(Request request,
Response response)
Invoked upon successful authorization.
|
protected int |
Authorizer.beforeHandle(Request request,
Response response) |
protected int |
Authenticator.beforeHandle(Request request,
Response response)
Handles the authentication by first invoking the
Authenticator.authenticate(Request, Response) method, only if
Authenticator.isMultiAuthenticating() returns true and if
ClientInfo.isAuthenticated() returns false. |
protected User |
SecretVerifier.createUser(java.lang.String identifier,
Request request,
Response response)
Called back to create a new user when valid credentials are provided.
|
protected java.lang.String |
SecretVerifier.getIdentifier(Request request,
Response response)
Returns the user identifier.
|
protected char[] |
SecretVerifier.getSecret(Request request,
Response response)
Returns the secret provided by the user.
|
protected int |
Authenticator.unauthenticated(Request request,
Response response)
Invoked upon failed authentication.
|
protected int |
Authorizer.unauthorized(Request request,
Response response)
Invoked upon failed authorization.
|
int |
SecretVerifier.verify(Request request,
Response response)
Verifies that the proposed secret is correct for the specified request.
|
int |
Verifier.verify(Request request,
Response response)
Attempts to verify the credentials provided by the client user sending
the request.
|
Modifier and Type | Method and Description |
---|---|
Variant |
ConnegService.getPreferredVariant(java.util.List<? extends Variant> variants,
Request request,
MetadataService metadataService)
Returns the best variant representation for a given resource according
the the client preferences.
|
Representation |
StatusService.getRepresentation(Status status,
Request request,
Response response)
Deprecated.
|
Status |
StatusService.getStatus(java.lang.Throwable throwable,
Request request,
Response response)
Deprecated.
Use
StatusService.toStatus(Throwable, Request, Response) instead. |
boolean |
LogService.isLoggable(Request request)
Indicates if the call should be logged during the processing chain.
|
Representation |
StatusService.toRepresentation(Status status,
Request request,
Response response)
Returns a representation for the given status.
|
Status |
StatusService.toStatus(java.lang.Throwable throwable,
Request request,
Response response)
Returns a status for a given exception or error.
|
Modifier and Type | Class and Description |
---|---|
class |
WrapperRequest
Request wrapper.
|
Modifier and Type | Method and Description |
---|---|
Request |
WrapperResponse.getRequest()
Returns the associated request
|
protected Request |
WrapperRequest.getWrappedRequest()
Returns the wrapped request.
|
Modifier and Type | Method and Description |
---|---|
static Resolver<?> |
Resolver.createResolver(Request request,
Response response)
Creates a resolver that is based on a call (request, response couple).
|
Route |
RouteList.getBest(Request request,
Response response,
float requiredScore)
Returns the best route match for a given call.
|
Route |
RouteList.getFirst(Request request,
Response response,
float requiredScore)
Returns the first route match for a given call.
|
Route |
RouteList.getLast(Request request,
Response response,
float requiredScore)
Returns the last route match for a given call.
|
Route |
RouteList.getNext(Request request,
Response response,
float requiredScore)
Returns a next route match in a round robin mode for a given call.
|
Route |
RouteList.getRandom(Request request,
Response response,
float requiredScore)
Returns a random route match for a given call.
|
void |
WrapperRestlet.handle(Request request,
Response response) |
void |
WrapperResponse.setRequest(Request request)
Sets the associated request.
|
Constructor and Description |
---|
WrapperRequest(Request wrappedRequest)
Constructor.
|
Copyright © 2005-2024 Restlet.