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.local	Supports local connectors and resources.
org.restlet.engine.log	Supports the log service.
org.restlet.engine.util	General utilities.
org.restlet.ext.atom	Support for the Atom syndication and the AtomPub (Atom Publication Protocol) standards in their 1.0 version.
org.restlet.ext.crypto	Support for cryptography including Amazon S3 and Windows Azure client authentication.
org.restlet.ext.guice	Integration with Google Guice @minor-version@.
org.restlet.ext.jaxrs	Support for JAX-RS API.
org.restlet.ext.jaxrs.internal.util
org.restlet.ext.json	Support for JSON representations.
org.restlet.ext.velocity	Integration with Apache Velocity @minor-version@.
org.restlet.ext.wadl	Support the WADL specification.
org.restlet.ext.xml	Support for XML and XSLT representations.
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	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.

Fields in org.restlet declared as Restlet

Modifier and Type	Field	Description
private Restlet	Context.clientDispatcher	The client dispatcher.
private Restlet	Application.inboundRoot	The inbound root Restlet.
private Restlet	Server.next	The next Restlet.
private Restlet	Application.outboundRoot	The outbound root Restlet.
private Restlet	Context.serverDispatcher	The server dispatcher.

Methods in org.restlet that return Restlet

Modifier and Type	Method	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.

Methods in org.restlet with parameters of type Restlet

Modifier and Type	Method	Description
private static void	Restlet.fireContextChanged(Restlet restlet, Context context)	Indicates that a Restlet's context has changed.
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.

Constructors in org.restlet with parameters of type Restlet

Constructor	Description
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(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, java.lang.String address, int port, Restlet next)	Constructor.
Server(Context context, Protocol protocol, Restlet next)	Constructor using the protocol's default port.
Server(Protocol protocol, int port, Restlet next)	Constructor.
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.
Server(Protocol protocol, 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	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.

Fields in org.restlet.engine declared as Restlet

Modifier and Type	Field	Description
private T	RestletHelper.helped	The helped Restlet.
private Restlet	CompositeHelper.inboundNext	The next Restlet after the inbound chain.
private Restlet	CompositeHelper.outboundNext	The next Restlet after the outbound chain.

Methods in org.restlet.engine that return Restlet

Modifier and Type	Method	Description
protected Restlet	CompositeHelper.getInboundNext()	Returns the next Restlet in the inbound chain.
Restlet	CompositeHelper.getOutboundNext()	Returns the next Restlet in the outbound chain.

Methods in org.restlet.engine with parameters of type Restlet

Modifier and Type	Method	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.

Uses of Restlet in org.restlet.engine.application

Subclasses of Restlet in org.restlet.engine.application

Modifier and Type	Class	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.

Constructors in org.restlet.engine.application with parameters of type Restlet

Constructor	Description
CorsFilter(Context context, Restlet next)	Constructor.

Uses of Restlet in org.restlet.engine.component

Subclasses of Restlet in org.restlet.engine.component

Modifier and Type	Class	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.

Methods in org.restlet.engine.component that return Restlet

Modifier and Type	Method	Description
Restlet	ClientRouter.getNext(Request request, Response response)

Methods in org.restlet.engine.component with parameters of type Restlet

Modifier and Type	Method	Description
TemplateRoute	InternalRouter.attach(java.lang.String uriPattern, Restlet target)
TemplateRoute	InternalRouter.attach(Restlet target)
TemplateRoute	InternalRouter.attachDefault(Restlet defaultTarget)
protected TemplateRoute	InternalRouter.createRoute(java.lang.String uriPattern, Restlet target, int matchingMode)
private void	ComponentXmlParser.parseRestlet(Restlet restlet, org.w3c.dom.Node restletNode)	Deprecated. Parse the attributes of a DOM node and update the given restlet.

Uses of Restlet in org.restlet.engine.local

Fields in org.restlet.engine.local declared as Restlet

Modifier and Type	Field	Description
private Restlet	DirectoryServerResource.directoryClientDispatcher	The parent directory client dispatcher.

Methods in org.restlet.engine.local that return Restlet

Modifier and Type	Method	Description
protected Restlet	DirectoryServerResource.getClientDispatcher()	Returns a client dispatcher.

Uses of Restlet in org.restlet.engine.log

Subclasses of Restlet in org.restlet.engine.log

Modifier and Type	Class	Description
class	LogFilter	Filter logging all calls after their handling by the target Restlet.

Uses of Restlet in org.restlet.engine.util

Subclasses of Restlet in org.restlet.engine.util

Modifier and Type	Class	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.

Fields in org.restlet.engine.util declared as Restlet

Modifier and Type	Field	Description
private Restlet	ChildContext.child	The child delegate, typically an application.

Methods in org.restlet.engine.util that return Restlet

Modifier and Type	Method	Description
Restlet	ChildContext.getChild()	Returns the child.

Methods in org.restlet.engine.util with parameters of type Restlet

Modifier and Type	Method	Description
void	ChildContext.setChild(Restlet child)	Sets the child.

Uses of Restlet in org.restlet.ext.atom

Fields in org.restlet.ext.atom declared as Restlet

Modifier and Type	Field	Description
private Restlet	Service.clientDispatcher	The client HTTP dispatcher.

Methods in org.restlet.ext.atom that return Restlet

Modifier and Type	Method	Description
Restlet	Service.getClientDispatcher()	Returns the client HTTP dispatcher.

Constructors in org.restlet.ext.atom with parameters of type Restlet

Constructor	Description
Service(Restlet clientDispatcher, java.lang.String serviceUri, Representation xmlService)	Constructor.

Uses of Restlet in org.restlet.ext.crypto

Subclasses of Restlet in org.restlet.ext.crypto

Modifier and Type	Class	Description
class	AwsAuthenticator	Authenticator supporting the ChallengeScheme.HTTP_AWS_S3 scheme.
class	CookieAuthenticator	Challenge authenticator based on browser cookies.
class	DigestAuthenticator	Authenticator supporting the digest challenge authentication schemes.

Uses of Restlet in org.restlet.ext.guice

Subclasses of Restlet in org.restlet.ext.guice

Modifier and Type	Class	Description
class	ResourceInjectingApplication	Application with support for creating Router instances that arrange for member injection of resource instances.
(package private) class	RestletGuice.Module.KeyFinder
(package private) class	RestletGuice.Module.ServerResourceKeyFinder

Uses of Restlet in org.restlet.ext.jaxrs

Subclasses of Restlet in org.restlet.ext.jaxrs

Modifier and Type	Class	Description
class	JaxRsApplication	Deprecated. Will be removed in next minor release.
class	JaxRsRestlet	Deprecated. Will be removed in next minor release.

Methods in org.restlet.ext.jaxrs that return Restlet

Modifier and Type	Method	Description
Restlet	JaxRsApplication.createInboundRoot()	Deprecated.
Restlet	JaxRsRestlet.getNoResMethodHandler()	Deprecated. Returns the Restlet that is called, if no resource method class could be found.
Restlet	JaxRsRestlet.getNoResourceClHandler()	Deprecated. Returns the Restlet that is called, if no resource class could be found.
Restlet	JaxRsRestlet.getNoRootResClHandler()	Deprecated. Returns the Restlet that is called, if no root resource class could be found.

Methods in org.restlet.ext.jaxrs with parameters of type Restlet

Modifier and Type	Method	Description
void	JaxRsRestlet.attachDefault(Restlet notMatchedRestlet)	Deprecated. Sets the Restlet that is called, if no (root) resource class or method could be found.
void	JaxRsRestlet.setNoResMethodHandler(Restlet noResMethodHandler)	Deprecated. Sets the Restlet that will handle the Requests, if no resource method could be found.
void	JaxRsRestlet.setNoResourceClHandler(Restlet noResourceClHandler)	Deprecated. Sets the Restlet that will handle the Requests, if no resource class could be found.
void	JaxRsRestlet.setNoRootResClHandler(Restlet noRootResClHandler)	Deprecated. Sets the Restlet that is called, if no root resource class could be found.

Uses of Restlet in org.restlet.ext.jaxrs.internal.util

Fields in org.restlet.ext.jaxrs.internal.util declared as Restlet

Modifier and Type	Field	Description
private Restlet	ExceptionHandler.noResMethodHandler	Deprecated.
private Restlet	ExceptionHandler.noResourceClHandler	Deprecated.
private Restlet	ExceptionHandler.noRootResClHandler	Deprecated.

Methods in org.restlet.ext.jaxrs.internal.util that return Restlet

Modifier and Type	Method	Description
Restlet	ExceptionHandler.getNoResMethodHandler()	Deprecated. Returns the Restlet that is called, if no resource method class could be found.
Restlet	ExceptionHandler.getNoResourceClHandler()	Deprecated. Returns the Restlet that is called, if no resource class could be found.
Restlet	ExceptionHandler.getNoRootResClHandler()	Deprecated. Returns the Restlet that is called, if no root resource class could be found.

Methods in org.restlet.ext.jaxrs.internal.util with parameters of type Restlet

Modifier and Type	Method	Description
void	ExceptionHandler.setNoResMethodHandler(Restlet noResMethodHandler)	Deprecated. Sets the Restlet that will handle the Requests, if no resource method could be found.
void	ExceptionHandler.setNoResourceClHandler(Restlet noResourceClHandler)	Deprecated. Sets the Restlet that will handle the Requests, if no resource class could be found.
void	ExceptionHandler.setNoRootResClHandler(Restlet noRootResClHandler)	Deprecated. Sets the Restlet that is called, if no root resource class could be found.

Uses of Restlet in org.restlet.ext.json

Subclasses of Restlet in org.restlet.ext.json

Modifier and Type	Class	Description
class	JsonpFilter	Filter that converts response entity of the JSON media type into a JSONP callback document.

Uses of Restlet in org.restlet.ext.velocity

Subclasses of Restlet in org.restlet.ext.velocity

Modifier and Type	Class	Description
class	TemplateFilter	Filter response's entity and wrap it with a Velocity's template representation.

Constructors in org.restlet.ext.velocity with parameters of type Restlet

Constructor	Description
TemplateFilter(Context context, Restlet next)	Constructor.
TemplateFilter(Context context, Restlet next, java.util.Map<java.lang.String,java.lang.Object> dataModel)	Constructor.
TemplateFilter(Context context, Restlet next, Resolver<java.lang.Object> dataModel)	Constructor.

Uses of Restlet in org.restlet.ext.wadl

Subclasses of Restlet in org.restlet.ext.wadl

Modifier and Type	Class	Description
class	WadlApplication	Deprecated. Will be removed in next major release.
class	WadlComponent	Deprecated. Will be removed in next major release.
class	WadlWrapper	Deprecated. Will be removed in next major release.

Methods in org.restlet.ext.wadl with parameters of type Restlet

Modifier and Type	Method	Description
private Router	WadlApplication.getNextRouter(Restlet current)	Deprecated. Returns the next router available.
private ResourceInfo	WadlApplication.getResourceInfo(ApplicationInfo applicationInfo, Restlet restlet, java.lang.String path, Request request, Response response)	Deprecated. Completes the data available about a given Restlet instance.

Constructors in org.restlet.ext.wadl with parameters of type Restlet

Constructor	Description
WadlWrapper(Restlet wrappedRestlet)	Deprecated. Constructor.

Uses of Restlet in org.restlet.ext.xml

Subclasses of Restlet in org.restlet.ext.xml

Modifier and Type	Class	Description
class	Transformer	Filter that can transform XML representations by applying an XSLT transform sheet.

Uses of Restlet in org.restlet.resource

Subclasses of Restlet in org.restlet.resource

Modifier and Type	Class	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	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.

Fields in org.restlet.routing declared as Restlet

Modifier and Type	Field	Description
private Restlet	Filter.next	The next Restlet.

Methods in org.restlet.routing that return Restlet

Modifier and Type	Method	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	Description
TemplateRoute	Router.attach(java.lang.String pathTemplate, 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.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(java.lang.String uriPattern, Restlet target)	Attaches a target Restlet to this router based on a given URI pattern.
TemplateRoute	VirtualHost.attach(Restlet target)	Attaches a target Restlet to this router with an empty 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)	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	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.

Uses of Restlet in org.restlet.security

Subclasses of Restlet in org.restlet.security

Modifier and Type	Class	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.

Uses of Restlet in org.restlet.util

Subclasses of Restlet in org.restlet.util

Modifier and Type	Class	Description
class	WrapperRestlet	Restlet wrapper.

Fields in org.restlet.util declared as Restlet

Modifier and Type	Field	Description
private Restlet	ServerList.next	The next Restlet of added servers.
private Restlet	WrapperRestlet.wrappedRestlet	The wrapped Restlet instance.

Methods in org.restlet.util that return Restlet

Modifier and Type	Method	Description
Restlet	ServerList.getNext()	Returns the next Restlet.

Methods in org.restlet.util with parameters of type Restlet

Modifier and Type	Method	Description
void	RouteList.removeAll(Restlet target)	Removes all routes routing to a given target.
void	ServerList.setNext(Restlet next)	Sets the next Restlet.

Constructors in org.restlet.util with parameters of type Restlet

Constructor	Description
ServerList(Context context, Restlet next)	Constructor.
WrapperRestlet(Restlet wrappedRestlet)	Constructor.