| Package | Description |
|---|---|
| org.restlet |
Core classes of the Restlet API.
|
| org.restlet.engine |
Implementation of Restlet API.
|
| org.restlet.engine.application |
Supports Restlet applications.
|
| org.restlet.engine.component |
Supports Restlet components.
|
| org.restlet.engine.local |
Supports local connectors and resources.
|
| org.restlet.engine.log |
Supports the log service.
|
| org.restlet.engine.util |
General utilities.
|
| 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.util |
Various utility classes.
|
| Modifier and Type | Class and Description |
|---|---|
class |
Application
Restlet managing a coherent set of resources and services.
|
class |
Client
Connector acting as a generic client.
|
class |
Component
|
class |
Connector
Restlet enabling communication between Components.
|
class |
Server
Connector acting as a generic server.
|
| Modifier and Type | Method and Description |
|---|---|
Restlet |
Application.createInboundRoot()
Creates a inbound root Restlet that will receive all incoming calls.
|
Restlet |
Application.createOutboundRoot()
Creates a outbound root Restlet that will receive all outgoing calls from
ClientResource.
|
Restlet |
Context.getClientDispatcher()
Returns a request dispatcher to available client connectors.
|
Restlet |
Application.getInboundRoot()
Returns the inbound root Restlet.
|
Restlet |
Server.getNext()
Returns the next Restlet.
|
Restlet |
Application.getOutboundRoot()
Returns the outbound root Restlet.
|
Restlet |
Context.getServerDispatcher()
Returns a request dispatcher to component's virtual hosts.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Context.setClientDispatcher(Restlet clientDispatcher)
Sets the client dispatcher.
|
void |
Application.setInboundRoot(Restlet inboundRoot)
Sets the inbound root Restlet.
|
void |
Server.setNext(Restlet next)
Sets the next Restlet.
|
void |
Application.setOutboundRoot(Restlet outboundRoot)
Sets the outbound root Restlet.
|
void |
Context.setServerDispatcher(Restlet serverDispatcher)
Sets the server dispatcher.
|
| Constructor and Description |
|---|
Server(Context context,
List<Protocol> protocols,
int port,
Restlet next)
Constructor.
|
Server(Context context,
List<Protocol> protocols,
String address,
int port,
Restlet next)
Constructor.
|
Server(Context context,
List<Protocol> protocols,
String address,
int port,
Restlet next,
String helperClass)
Constructor.
|
Server(Context context,
Protocol protocol,
int port,
Restlet next)
Constructor.
|
Server(Context context,
Protocol protocol,
Restlet next)
Constructor using the protocol's default port.
|
Server(Context context,
Protocol protocol,
String address,
int port,
Restlet next)
Constructor.
|
Server(List<Protocol> protocols,
int port,
Restlet next)
Constructor.
|
Server(List<Protocol> protocols,
String address,
int port,
Restlet next)
Constructor.
|
Server(Protocol protocol,
int port,
Restlet next)
Constructor.
|
Server(Protocol protocol,
Restlet next)
Constructor using the protocol's default port.
|
Server(Protocol protocol,
String address,
int port,
Restlet next)
Constructor.
|
Server(Protocol protocol,
String address,
Restlet next)
Constructor using the protocol's default port.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CompositeHelper<T extends Restlet>
Chain helper serving as base class for Application and Component helpers.
|
class |
RestletHelper<T extends Restlet>
Delegate used by API classes to get support from the implementation classes.
|
| Modifier and Type | Method and Description |
|---|---|
protected Restlet |
CompositeHelper.getInboundNext()
Returns the next Restlet in the inbound chain.
|
Restlet |
CompositeHelper.getOutboundNext()
Returns the next Restlet in the outbound chain.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
CompositeHelper.setInboundNext(Restlet next)
Sets the next Restlet after the inbound chain.
|
protected void |
CompositeHelper.setOutboundNext(Restlet next)
Sets the next Restlet after the outbound chain.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CorsFilter
Filter that helps support CORS requests.
|
class |
Decoder
Filter uncompressing entities.
|
class |
Encoder
Filter compressing entities.
|
class |
RangeFilter
Filter that is in charge to check the responses to requests for partial
content.
|
class |
StatusFilter
Filter associating a response entity based on the status.
|
class |
TunnelFilter
Filter tunneling browser calls into full REST calls.
|
| Constructor and Description |
|---|
CorsFilter(Context context,
Restlet next)
Constructor.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ClientRoute
Router scorer based on a target client connector.
|
class |
ClientRouter
Router that collects calls from all applications and dispatches them to the
appropriate client connectors.
|
class |
ComponentClientDispatcher
Component client dispatcher.
|
class |
ComponentServerDispatcher
Component server dispatcher.
|
class |
HostRoute
Route based on a target VirtualHost.
|
class |
InternalRouter
Provides the behavior of the internal router of a Component.
|
class |
ServerRouter
Router that collects calls from all server connectors and dispatches them to
the appropriate host routers.
|
| Modifier and Type | Method and Description |
|---|---|
Restlet |
ClientRouter.getNext(Request request,
Response response) |
| Modifier and Type | Method and Description |
|---|---|
TemplateRoute |
InternalRouter.attach(Restlet target) |
TemplateRoute |
InternalRouter.attach(String uriPattern,
Restlet target) |
TemplateRoute |
InternalRouter.attachDefault(Restlet defaultTarget) |
protected TemplateRoute |
InternalRouter.createRoute(String uriPattern,
Restlet target,
int matchingMode) |
| Modifier and Type | Method and Description |
|---|---|
protected Restlet |
DirectoryServerResource.getClientDispatcher()
Returns a client dispatcher.
|
| Modifier and Type | Class and Description |
|---|---|
class |
LogFilter
Filter logging all calls after their handling by the target Restlet.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ChildClientDispatcher
Client dispatcher for a component child.
|
class |
TemplateDispatcher
Filter that resolves URI templates in the target resource URI reference using
the request attributes.
|
| Modifier and Type | Method and Description |
|---|---|
Restlet |
ChildContext.getChild()
Returns the child.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ChildContext.setChild(Restlet child)
Sets the child.
|
| Modifier and Type | Class and Description |
|---|---|
class |
Directory
Finder mapping a directory of local resources.
|
class |
Finder
Restlet that can find the target server resource that will effectively handle
incoming calls.
|
| Modifier and Type | Class and Description |
|---|---|
class |
Extractor
Filter extracting attributes from a call.
|
class |
Filter
Restlet filtering calls before passing them to an attached Restlet.
|
class |
Redirector
Rewrites URIs then redirects the call or the client to a new destination.
|
class |
Route
Filter scoring the affinity of calls with the attached Restlet.
|
class |
Router
Restlet routing calls to one of the attached routes.
|
class |
TemplateRoute
Filter scoring the affinity of calls with the attached Restlet.
|
class |
Validator
Filter validating attributes from a call.
|
class |
VirtualHost
Router of calls from Server connectors to Restlets.
|
| Modifier and Type | Method and Description |
|---|---|
Restlet |
Filter.getNext()
Returns the next Restlet.
|
Restlet |
Router.getNext(Request request,
Response response)
Returns the next Restlet if available.
|
| Modifier and Type | Method and Description |
|---|---|
TemplateRoute |
VirtualHost.attach(Restlet target)
Attaches a target Restlet to this router with an empty URI pattern.
|
TemplateRoute |
Router.attach(Restlet target)
Attaches a target Restlet to this router with an empty URI pattern.
|
TemplateRoute |
Router.attach(Restlet target,
int matchingMode)
Attaches a target Restlet to this router with an empty URI pattern.
|
TemplateRoute |
VirtualHost.attach(String uriPattern,
Restlet target)
Attaches a target Restlet to this router based on a given URI pattern.
|
TemplateRoute |
Router.attach(String pathTemplate,
Restlet target)
Attaches a target Restlet to this router based on a given URI pattern.
|
TemplateRoute |
Router.attach(String pathTemplate,
Restlet target,
int matchingMode)
Attaches a target Restlet to this router based on a given URI pattern.
|
TemplateRoute |
VirtualHost.attachDefault(Restlet defaultTarget)
Attaches a Restlet to this router as the default target to invoke when no
route matches.
|
TemplateRoute |
Router.attachDefault(Restlet defaultTarget)
Attaches a Restlet to this router as the default target to invoke when no
route matches.
|
protected void |
VirtualHost.checkContext(Restlet target)
Checks the context and sets it if necessary.
|
protected TemplateRoute |
Router.createRoute(String uriPattern,
Restlet target)
Creates a new route for the given URI pattern and target.
|
protected TemplateRoute |
VirtualHost.createRoute(String uriPattern,
Restlet target,
int matchingMode) |
protected TemplateRoute |
Router.createRoute(String uriPattern,
Restlet target,
int matchingMode)
Creates a new route for the given URI pattern, target and matching mode.
|
void |
Router.detach(Restlet target)
Detaches the target from this router.
|
protected void |
Router.doHandle(Restlet next,
Request request,
Response response)
|
protected int |
Router.getMatchingMode(Restlet target)
Returns the matching mode for the target Restlet.
|
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.
|
void |
Filter.setNext(Restlet next)
Sets the next Restlet.
|
| Constructor and Description |
|---|
Extractor(Context context,
Restlet next)
Constructor.
|
Filter(Context context,
Restlet next)
Constructor.
|
Route(Restlet next)
Constructor behaving as a simple extractor filter.
|
Route(Router router,
Restlet next)
Constructor.
|
TemplateRoute(Restlet next)
Constructor behaving as a simple extractor filter.
|
TemplateRoute(Router router,
String uriTemplate,
Restlet next)
Constructor.
|
TemplateRoute(Router router,
Template template,
Restlet next)
Constructor.
|
Validator(Context context,
Restlet next)
Constructor.
|
| Modifier and Type | Class and Description |
|---|---|
class |
Authenticator
Filter authenticating the client sending the inbound request.
|
class |
Authorizer
Filter authorizing inbound request.
|
class |
CertificateAuthenticator
Authenticator based on the SSL client certificate.
|
class |
ChallengeAuthenticator
Authenticator based on a challenge scheme.
|
class |
ConfidentialAuthorizer
Authorizer allowing only confidential calls.
|
class |
MethodAuthorizer
Authorizer based on authorized methods.
|
class |
RoleAuthorizer
Authorizer based on authorized and forbidden roles.
|
| Modifier and Type | Class and Description |
|---|---|
class |
WrapperRestlet
Restlet wrapper.
|
| Modifier and Type | Method and Description |
|---|---|
Restlet |
ServerList.getNext()
Returns the next Restlet.
|
| Modifier and Type | Method and Description |
|---|---|
void |
RouteList.removeAll(Restlet target)
Removes all routes routing to a given target.
|
void |
ServerList.setNext(Restlet next)
Sets the next Restlet.
|
| Constructor and Description |
|---|
ServerList(Context context,
Restlet next)
Constructor.
|
WrapperRestlet(Restlet wrappedRestlet)
Constructor.
|
Copyright © 2005–2025. All rights reserved.