## Uses of Class
org.restlet.Restlet

Packages that use Restlet
Package | Description
--- | ---
org.restlet | Core classes of the 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.log | Supports the log service.
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.

### Uses of Restlet in org.restlet

Subclasses of Restlet in org.restlet
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` Restlet managing a set of Connectors, VirtualHosts, Services and Applications.
`class` | `Connector` Restlet enabling communication between Components.
`class` | `Server` Connector acting as a generic server.

Methods in org.restlet that return Restlet
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` | Application.`createRoot()` Deprecated. Override the `Application.createInboundRoot()` method instead.
`Restlet` | Application.`getInboundRoot()` Returns the inbound root Restlet.
`Restlet` | Server.`getNext()` Returns the next Restlet.
`Restlet` | Application.`getOutboundRoot()` Returns the outbound root Restlet.
`Restlet` | Application.`getRoot()` Deprecated. Use the `Application.getInboundRoot()` method instead.
`Restlet` | Server.`getTarget()` Deprecated. Use the `Server.getNext()` method instead.

Methods in org.restlet with parameters of type Restlet
Modifier and Type | Method and Description
--- | ---
`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` | Application.`setRoot(Restlet inboundRoot)` Deprecated. Use the `Application.setInboundRoot(Restlet)` method instead.
`void` | Server.`setTarget(Restlet next)` Deprecated. Use the `Server.setNext(Restlet)` method instead.

Constructors in org.restlet with parameters of type Restlet
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.

### Uses of Restlet in org.restlet.engine

Classes in org.restlet.engine with type parameters of type Restlet
Modifier and Type | Class and Description
--- | ---
`class` | `ChainHelper<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.

Subclasses of Restlet in org.restlet.engine
Modifier and Type | Class and Description
--- | ---
`class` | `TemplateDispatcher` Base call dispatcher capable of resolving target resource URI templates.

Methods in org.restlet.engine that return Restlet
Modifier and Type | Method and Description
--- | ---
`protected Restlet` | ChainHelper.`getFirst()` Returns the first Restlet.

Methods in org.restlet.engine with parameters of type Restlet
Modifier and Type | Method and Description
--- | ---
`protected void` | ChainHelper.`setFirst(Restlet first)` Sets the first Restlet.
`protected void` | ChainHelper.`setNext(Restlet next)` Sets the next Restlet after the chain.

### Uses of Restlet in org.restlet.engine.application

Subclasses of Restlet in org.restlet.engine.application
Modifier and Type | Class and Description
--- | ---
`class` | `Decoder` Filter decompressing 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.

### Uses of Restlet in org.restlet.engine.component

Subclasses of Restlet in org.restlet.engine.component
Modifier and Type | Class and Description
--- | ---
`class` | `ChildClientDispatcher` Client dispatcher for a component child.
`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.

Methods in org.restlet.engine.component that return Restlet
Modifier and Type | Method and Description
--- | ---
`Restlet` | ChildContext.`getChild()` Returns the child.
`Restlet` | ClientRouter.`getNext(Request request, Response response)`

Methods in org.restlet.engine.component with parameters of type Restlet
Modifier and Type | Method and Description
--- | ---
`Route` | InternalRouter.`attach(Restlet target)`
`Route` | InternalRouter.`attach(java.lang.String uriPattern, Restlet target)`
`Route` | InternalRouter.`attachDefault(Restlet defaultTarget)`
`protected Route` | InternalRouter.`createRoute(java.lang.String uriPattern, Restlet target, int matchingMode)`
`static void` | ChildContext.`fireContextChanged(Restlet restlet, Context context)` Indicates that a Restlet's context has changed.
`void` | ChildContext.`setChild(Restlet child)` Sets the child.

### Uses of Restlet in org.restlet.engine.log

Subclasses of Restlet in org.restlet.engine.log
Modifier and Type | Class and Description
--- | ---
`class` | `LogFilter` Filter logging all calls after their handling by the target Restlet.

### Uses of Restlet in org.restlet.resource

Subclasses of Restlet in org.restlet.resource
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.

### Uses of Restlet in org.restlet.routing

Subclasses of Restlet in org.restlet.routing
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` Deprecated. Use `TemplateRoute` instead.
`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.

Methods in org.restlet.routing that return Restlet
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.

Methods in org.restlet.routing with parameters of type Restlet
Modifier and Type | Method and Description
--- | ---
`Route` | Router.`attach(Restlet target)` Attaches a target Restlet to this router with an empty URI pattern.
`Route` | VirtualHost.`attach(Restlet target)` Attaches a target Restlet to this router with an empty URI pattern.
`Route` | Router.`attach(Restlet target, int matchingMode)` Attaches a target Restlet to this router with an empty URI pattern.
`Route` | Router.`attach(java.lang.String pathTemplate, Restlet target)` Attaches a target Restlet to this router based on a given URI pattern.
`Route` | VirtualHost.`attach(java.lang.String uriPattern, Restlet target)` Attaches a target Restlet to this router based on a given URI pattern.
`Route` | Router.`attach(java.lang.String pathTemplate, Restlet target, int matchingMode)` Attaches a target Restlet to this router based on a given URI pattern.
`Route` | Router.`attachDefault(Restlet defaultTarget)` Attaches a Restlet to this router as the default target to invoke when no route matches.
`Route` | VirtualHost.`attachDefault(Restlet defaultTarget)` Attaches a Restlet to this router as the default target to invoke when no route matches.
`protected Route` | Router.`createRoute(java.lang.String uriPattern, Restlet target)` Creates a new route for the given URI pattern and target.
`protected Route` | Router.`createRoute(java.lang.String uriPattern, Restlet target, int matchingMode)` Creates a new route for the given URI pattern, target and matching mode.
`protected Route` | 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)` Effectively handles the call using the selected next `Restlet`, typically the selected `Route`.
`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.

Constructors in org.restlet.routing with parameters of type Restlet
Constructor and Description
`Extractor(Context context, Restlet next)` Constructor.
`Filter(Context context, Restlet next)` Constructor.
`Route(Restlet next)` Deprecated. Constructor behaving as a simple extractor filter.
`Route(Router router, java.lang.String uriTemplate, Restlet next)` Deprecated. Constructor.
`Route(Router router, Template template, Restlet next)` Deprecated. 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.

### Uses of Restlet in org.restlet.security

Subclasses of Restlet in org.restlet.security
Modifier and Type | Class and Description
--- | ---
`class` | `Authenticator` Filter authenticating the client sending the request.
`class` | `Authorizer` Filter authorizing requests.
`class` | `ChallengeAuthenticator` Authenticator based on a challenge scheme.
`class` | `Guard` Deprecated. Use the `ChallengeAuthenticator` class instead.
`class` | `MethodAuthorizer` Authorizer based on authorized methods.
`class` | `RoleAuthorizer` Authorizer based on authorized and forbidden roles.

### Uses of Restlet in org.restlet.util

Subclasses of Restlet in org.restlet.util
Modifier and Type | Class and Description
--- | ---
`class` | `WrapperRestlet` Restlet wrapper.

Methods in org.restlet.util that return Restlet
Modifier and Type | Method and Description
--- | ---
`Restlet` | ServerList.`getNext()` Returns the next Restlet.
`Restlet` | ServerList.`getTarget()` Deprecated. Use the `ServerList.getNext()` method instead.

Methods in org.restlet.util with parameters of type 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.
`void` | ServerList.`setTarget(Restlet next)` Deprecated. Use the `ServerList.setNext(Restlet)` method instead.

Constructors in org.restlet.util with parameters of type Restlet
Constructor and Description
`ServerList(Context context, Restlet next)` Constructor.
`WrapperRestlet(Restlet wrappedRestlet)` Constructor.