Uses of Class
org.restlet.Request
Packages that use Request
Package
Description
Core classes of the Restlet API.
Implementation of Restlet API.
Adapters between low-level HTTP calls and high-level Restlet Request and
Response objects.
Supports Restlet applications.
Supports Restlet components.
Integration with Java URLConnection class.
Supports HTTP header parsing and formatting.
Supports local connectors and resources.
Supports the log service.
Supports resources.
Supports security.
General utilities.
Client and server resource classes.
Classes related to call routing.
Classes related to security.
Services used by applications and components.
Various utility classes.
-
Uses of Request in org.restlet
Methods in org.restlet that return RequestModifier and TypeMethodDescriptionstatic RequestRequest.getCurrent()Returns the request associated to the current thread.Response.getRequest()Returns the associated requestMethods in org.restlet with parameters of type RequestModifier and TypeMethodDescriptionvoidvoidvoidfinal ResponseHandles a call.voidHandles a call.final voidHandles a call.final voidHandles a call.voidvoidHandles a uniform call.voidResponse.setRequest(Request request) Sets the associated request.Constructors in org.restlet with parameters of type Request -
Uses of Request in org.restlet.engine
Methods in org.restlet.engine with parameters of type Request -
Uses of Request in org.restlet.engine.adapter
Subclasses of Request in org.restlet.engine.adapterMethods in org.restlet.engine.adapter with parameters of type RequestModifier and TypeMethodDescriptionvoidClientAdapter.commit(ClientCall httpCall, Request request, Response response) Commits the changes to a handled HTTP client call back into the original uniform call.abstract ClientCallCreates a low-level HTTP client call from a high-level request.voidClientCall.sendRequest(Request request) Sends the request to the client.voidClientCall.sendRequest(Request request, Response response, Uniform callback) Sends the request to the client.protected booleanClientCall.shouldRequestBeChunked(Request request) Indicates if the request entity should be chunked.ClientAdapter.toSpecific(HttpClientHelper client, Request request) Converts a low-level HTTP call into a high-level uniform call.Constructors in org.restlet.engine.adapter with parameters of type Request -
Uses of Request in org.restlet.engine.application
Methods in org.restlet.engine.application that return RequestModifier and TypeMethodDescriptionConneg.getRequest()Returns the request including client preferences.Methods in org.restlet.engine.application with parameters of type RequestModifier and TypeMethodDescriptionvoidCorsResponseHelper.addCorsResponseHeaders(Request request, Response response) Adds CORS headers to the given response.protected voidCorsFilter.afterHandle(Request request, Response response) Add CORS headers to responsevoidDecoder.afterHandle(Request request, Response response) Allows filtering after its handling by the target Restlet.voidEncoder.afterHandle(Request request, Response response) Allows filtering after its handling by the target Restlet.protected voidRangeFilter.afterHandle(Request request, Response response) voidStatusFilter.afterHandle(Request request, Response response) Allows filtering after its handling by the target Restlet.protected intCorsFilter.beforeHandle(Request request, Response response) Skip the call to the server resource if theCorsFilter.skippingResourceForCorsOptionsis true and if the current request use the OPTIONS method and is a CORS request.intDecoder.beforeHandle(Request request, Response response) Allows filtering before its handling by the target Restlet.intEncoder.beforeHandle(Request request, Response response) Allows filtering before its handling by the target Restlet.intTunnelFilter.beforeHandle(Request request, Response response) protected intHandles the call by distributing it to the next Restlet.voidIn addition to the default behavior, it saves the current application instance into the current thread.booleanCorsResponseHelper.isCorsRequest(Request request) Returns true if the request is a CORS request.Constructors in org.restlet.engine.application with parameters of type RequestModifierConstructorDescriptionConneg(Request request, MetadataService metadataService) Constructor.FlexibleConneg(Request request, MetadataService metadataService) Constructor.StrictConneg(Request request, MetadataService metadataService) Constructor. -
Uses of Request in org.restlet.engine.component
Methods in org.restlet.engine.component with parameters of type RequestModifier and TypeMethodDescriptionintComponentServerDispatcher.beforeHandle(Request request, Response response) protected intHostRoute.beforeHandle(Request request, Response response) Allows filtering before processing by the next Restlet.protected intprotected intfloatReturns the score for a given call (between 0 and 1.0).floatReturns the score for a given call (between 0 and 1.0). -
Uses of Request in org.restlet.engine.connector
Methods in org.restlet.engine.connector with parameters of type RequestModifier and TypeMethodDescriptionDeprecated.Creates a low-level HTTP client call from a high-level uniform call.voidDeprecated.voidHandles a call by invoking the helped Server'sServer.handle(Request, Response)method.HttpUrlConnectionCall.sendRequest(Request request) Deprecated.Sends the request to the client.voidHttpUrlConnectionCall.sendRequest(Request request, Response response, Uniform callback) Deprecated. -
Uses of Request in org.restlet.engine.header
Methods in org.restlet.engine.header with parameters of type Request -
Uses of Request in org.restlet.engine.local
Methods in org.restlet.engine.local with parameters of type RequestModifier and TypeMethodDescriptionfinal voidHandles a call.voidHandles a call.protected voidClapClientHelper.handleClassLoader(Request request, Response response, ClassLoader classLoader) Handles a call with a given class loader.protected voidEntityClientHelper.handleEntityGet(Request request, Response response, Entity entity) Handles a GET call.protected voidFileClientHelper.handleFile(Request request, Response response, String decodedPath) protected voidFileClientHelper.handleFilePut(Request request, Response response, String path, File file) Handles a PUT call for the FILE protocol.protected voidZipClientHelper.handleGet(Request request, Response response, File file, String entryName, MetadataService metadataService) Handles a GET call.protected voidClapClientHelper.handleLocal(Request request, Response response, String decodedPath) protected voidEntityClientHelper.handleLocal(Request request, Response response, String decodedPath) protected voidFileClientHelper.handleLocal(Request request, Response response, String decodedPath) protected abstract voidLocalClientHelper.handleLocal(Request request, Response response, String decodedPath) Handles a local call.protected voidZipClientHelper.handleLocal(Request request, Response response, String decodedPath) Handles a call for a local entity.protected voidHandles a PUT call. -
Uses of Request in org.restlet.engine.log
Methods in org.restlet.engine.log with parameters of type RequestModifier and TypeMethodDescriptionprotected voidLogFilter.afterHandle(Request request, Response response) Allows filtering after processing by the next Restlet.protected intLogFilter.beforeHandle(Request request, Response response) Allows filtering before processing by the next Restlet. -
Uses of Request in org.restlet.engine.resource
Methods in org.restlet.engine.resource that return RequestModifier and TypeMethodDescriptionprotected RequestClientInvocationHandler.getRequest(Method javaMethod, Object[] args) Allows for child classes to modify the request. -
Uses of Request in org.restlet.engine.security
Methods in org.restlet.engine.security with parameters of type RequestModifier and TypeMethodDescriptionvoidAuthenticatorHelper.formatResponse(ChallengeWriter cw, ChallengeResponse challenge, Request request, Series<Header> httpHeaders) Formats a challenge response as raw credentials.static StringAuthenticatorUtils.formatResponse(ChallengeResponse challenge, Request request, Series<Header> httpHeaders) Formats a challenge response as an HTTP header value.voidHttpBasicHelper.formatResponse(ChallengeWriter cw, ChallengeResponse challenge, Request request, Series<Header> httpHeaders) voidAuthenticatorHelper.parseResponse(ChallengeResponse challenge, Request request, Series<Header> httpHeaders) Parses an authorization header into a challenge response.static ChallengeResponseAuthenticatorUtils.parseResponse(Request request, String header, Series<Header> httpHeaders) Parses an authorization header into a challenge response.voidHttpBasicHelper.parseResponse(ChallengeResponse challenge, Request request, Series<Header> httpHeaders) static voidAuthenticatorUtils.update(ChallengeResponse challengeResponse, Request request, Response response) Updates aChallengeResponseobject according to given request and response.AuthenticatorHelper.updateReference(Reference resourceRef, ChallengeResponse challengeResponse, Request request) Optionally updates the request with a challenge response before sending it.static ReferenceAuthenticatorUtils.updateReference(Reference resourceRef, ChallengeResponse challengeResponse, Request request) Optionally updates the request with a challenge response before sending it. -
Uses of Request in org.restlet.engine.util
Methods in org.restlet.engine.util with parameters of type RequestModifier and TypeMethodDescriptionprotected voidTemplateDispatcher.afterHandle(Request request, Response response) If the response entity comes back with no identifier, automatically set the request's resource reference's identifier.intTemplateDispatcher.beforeHandle(Request request, Response response) Handles the call after resolving any URI template on the request's target resource reference.intTransmits the call to the parent component except if the call is internal as denoted by theProtocol.RIAPprotocol and targets this child application.static StringReturns the request URI.static ReferenceReturns the request URI.Constructors in org.restlet.engine.util with parameters of type Request -
Uses of Request in org.restlet.resource
Methods in org.restlet.resource that return RequestModifier and TypeMethodDescriptionClientResource.createRequest()Creates a new request by cloning the one wrapped by this class.Resource.getRequest()Returns the handled request.ResourceException.getRequest()Returns the request associated to this exception.Methods in org.restlet.resource with parameters of type RequestModifier and TypeMethodDescriptionFinder.create(Class<? extends ServerResource> targetClass, Request request, Response response) Creates a new instance of a givenServerResourcesubclass.Creates a new instance of theServerResourcesubclass designated by the "targetClass" property.protected ResponseClientResource.createResponse(Request request) Creates a new response for the given request.voidBy default, it throws a new resource exception.voidBy default, it throws a new resource exception.Finds the targetServerResourceif available.protected voidClientResource.handle(Request request, Response response, List<Reference> references, int retryAttempt, Uniform next) Handle the call and follow redirection for safe methods.voidvoidHandles a call.ClientResource.handleOutbound(Request request) Handles the outbound call by invoking the next handler.voidInitialization method setting the environment of the current resource instance.protected voidClientResource.redirect(Request request, Response response, List<Reference> references, int retryAttempt, Uniform next) Effectively redirects a client call.protected voidClientResource.retry(Request request, Response response, List<Reference> references, int retryAttempt, Uniform next) Effectively retries a failed client call.voidResource.setRequest(Request request) Sets the handled request.Constructors in org.restlet.resource with parameters of type RequestModifierConstructorDescriptionClientResource(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, Throwable cause, Request request, Response response) Constructor.ResourceException(Status status, Request request, Response response) Constructor. -
Uses of Request in org.restlet.routing
Methods in org.restlet.routing with parameters of type RequestModifier and TypeMethodDescriptionprotected voidFilter.afterHandle(Request request, Response response) Allows filtering after processing by the next Restlet.protected intExtractor.beforeHandle(Request request, Response response) Allows filtering before its handling by the target Restlet.protected intFilter.beforeHandle(Request request, Response response) Allows filtering before processing by the next Restlet.protected intTemplateRoute.beforeHandle(Request request, Response response) Allows filtering before its handling by the target Restlet.protected intValidator.beforeHandle(Request request, Response response) Allows filtering before its handling by the target Restlet.protected intHandles the call by distributing it to the next Restlet.protected voidCreates a formatted string based on the given request and response.protected RouteReturns the matched route according to a custom algorithm.Returns the next Restlet if available.protected ReferenceRedirector.getTargetRef(Request request, Response response) Returns the target reference to redirect to by automatically resolving URI template variables found using theTemplateclass using the request and response as data models.final voidHandles a call by first invoking the beforeHandle() method for pre-filtering, then distributing the call to the next Restlet via the doHandle() method.voidHandles a call by redirecting using the selected redirection mode.voidHandles a call by invoking the next Restlet if it is available.protected voidRedirector.inboundServerRedirect(Reference targetRef, Request request, Response response) Redirects a given call to a target reference.protected voidRedirector.outboundServerRedirect(Reference targetRef, Request request, Response response) Redirects a given call to a target reference.intAttempts to parse a formatted reference.protected voidOptionally updates the request sent in theRedirector.MODE_SERVER_INBOUNDandRedirector.MODE_SERVER_OUTBOUNDmodes.voidRedirector.rewriteLocation(Request request, Response response) Rewrite the location of the response, and the Location of the entity, if any.abstract floatReturns the score for a given call (between 0 and 1.0).floatReturns the score for a given call (between 0 and 1.0).protected voidRedirector.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. -
Uses of Request in org.restlet.security
Methods in org.restlet.security with parameters of type RequestModifier and TypeMethodDescriptionprotected abstract booleanAuthenticator.authenticate(Request request, Response response) Attempts to authenticate the subject sending the request.protected booleanCertificateAuthenticator.authenticate(Request request, Response response) Authenticates the call using the X.509 client certificate.protected booleanChallengeAuthenticator.authenticate(Request request, Response response) Authenticates the call, relying on the verifier to check the credentials provided (in general an identifier + secret couple).protected intAuthenticator.authenticated(Request request, Response response) Invoked upon successful authentication.protected abstract booleanAttempts to authorize the request.booleanAuthorizes the request only if its method is one of the authorized methods.booleanAuthorizes the request only if its method is one of the authorized methods.booleanAuthorizes the request only if its subject is in one of the authorized roles and in none of the forbidden ones.protected intAuthorizer.authorized(Request request, Response response) Invoked upon successful authorization.protected intAuthenticator.beforeHandle(Request request, Response response) Handles the authentication by first invoking theAuthenticator.authenticate(Request, Response)method, only ifAuthenticator.isMultiAuthenticating()returns true and ifClientInfo.isAuthenticated()returns false.protected intAuthorizer.beforeHandle(Request request, Response response) protected UserSecretVerifier.createUser(String identifier, Request request, Response response) Called back to create a new user when valid credentials are provided.protected StringSecretVerifier.getIdentifier(Request request, Response response) Returns the user identifier.protected char[]Returns the secret provided by the user.protected intAuthenticator.unauthenticated(Request request, Response response) Invoked upon failed authentication.protected intAuthorizer.unauthorized(Request request, Response response) Invoked upon failed authorization.intVerifies that the proposed secret is correct for the specified request.intAttempts to verify the credentials provided by the client user sending the request. -
Uses of Request in org.restlet.service
Methods in org.restlet.service with parameters of type RequestModifier and TypeMethodDescriptionConnegService.getPreferredVariant(List<? extends Variant> variants, Request request, MetadataService metadataService) Returns the best variant representation for a given resource according the the client preferences.
A default language is provided in case the variants don't match the client preferences.booleanLogService.isLoggable(Request request) Indicates if the call should be logged during the processing chain.StatusService.toRepresentation(Status status, Request request, Response response) Returns a representation for the given status.Returns a status for a given exception or error. -
Uses of Request in org.restlet.util
Subclasses of Request in org.restlet.utilMethods in org.restlet.util that return RequestModifier and TypeMethodDescriptionWrapperResponse.getRequest()Returns the associated requestprotected RequestWrapperRequest.getWrappedRequest()Returns the wrapped request.Methods in org.restlet.util with parameters of type RequestModifier and TypeMethodDescriptionstatic Resolver<?>Resolver.createResolver(Request request, Response response) Creates a resolver that is based on a call (request, response couple).Returns the best route match for a given call.Returns the first route match for a given call.Returns the last route match for a given call.Returns a next route match in a round robin mode for a given call.Returns a random route match for a given call.voidvoidWrapperResponse.setRequest(Request request) Sets the associated request.Constructors in org.restlet.util with parameters of type Request