| 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.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,
      java.util.List<Protocol> protocols,
      int port,
      Restlet next)
Constructor. 
 | 
Server(Context context,
      java.util.List<Protocol> protocols,
      java.lang.String address,
      int port,
      Restlet next)
Constructor. 
 | 
Server(Context context,
      java.util.List<Protocol> protocols,
      java.lang.String address,
      int port,
      Restlet next,
      java.lang.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,
      java.lang.String address,
      int port,
      Restlet next)
Constructor. 
 | 
Server(java.util.List<Protocol> protocols,
      int port,
      Restlet next)
Constructor. 
 | 
Server(java.util.List<Protocol> protocols,
      java.lang.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,
      java.lang.String address,
      int port,
      Restlet next)
Constructor. 
 | 
Server(Protocol protocol,
      java.lang.String address,
      Restlet next)
Constructor using the protocol's default port. 
 | 
| 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 | 
Router.attach(Restlet target)
Attaches a target Restlet to this router with an empty URI pattern. 
 | 
TemplateRoute | 
VirtualHost.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 | 
Router.attach(java.lang.String pathTemplate,
      Restlet target)
Attaches a target Restlet to this router based on a given URI pattern. 
 | 
TemplateRoute | 
VirtualHost.attach(java.lang.String uriPattern,
      Restlet target)
Attaches a target Restlet to this router based on a given URI pattern. 
 | 
TemplateRoute | 
Router.attach(java.lang.String pathTemplate,
      Restlet target,
      int matchingMode)
Attaches a target Restlet to this router based on a given URI pattern. 
 | 
TemplateRoute | 
Router.attachDefault(Restlet defaultTarget)
Attaches a Restlet to this router as the default target to invoke when no
 route matches. 
 | 
TemplateRoute | 
VirtualHost.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(java.lang.String uriPattern,
           Restlet target)
Creates a new route for the given URI pattern and target. 
 | 
protected TemplateRoute | 
Router.createRoute(java.lang.String uriPattern,
           Restlet target,
           int matchingMode)
Creates a new route for the given URI pattern, target and matching mode. 
 | 
protected TemplateRoute | 
VirtualHost.createRoute(java.lang.String uriPattern,
           Restlet target,
           int matchingMode)  | 
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,
             java.lang.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-2024 Restlet.