org.restlet.ext.servlet.internal

Class ServletWarClientHelper

java.lang.Object

org.restlet.engine.Helper

org.restlet.engine.RestletHelper<T>

org.restlet.engine.connector.ConnectorHelper<Client>

org.restlet.engine.connector.ClientHelper

org.restlet.engine.local.LocalClientHelper

org.restlet.engine.local.EntityClientHelper

org.restlet.ext.servlet.internal.ServletWarClientHelper

Direct Known Subclasses:

XdbServletWarClientHelper

public class ServletWarClientHelper
extends EntityClientHelper

Client connector based on a Servlet context (JEE Web application context). Here is a sample resource URI:

 war:///path/to/my/resource/entry.txt
 

You can note that there is no authority which is denoted by the sequence of three "/" characters. This connector is designed to be used inside a context (e.g. inside a servlet based application) and subconsequently does not require the use of a authority. Such URI are "relative" to the root of the servlet context.
Here is a sample code excerpt that illustrates the way to use this connector: Response response = getContext().getClientDispatcher().get("war:///myDir/test.txt"); if (response.isEntityAvailable()) { //Do what you want to do. }

Author:

Jerome Louvel

Constructor Summary

Constructors

Constructor and Description
ServletWarClientHelper(Client client, javax.servlet.ServletContext servletContext) Constructor.

Method Summary

Modifier and Type	Method and Description
Entity	getEntity(String decodedPath) Returns a local entity for the given path.
javax.servlet.ServletContext	getServletContext() Returns the Servlet context.
void	handleLocal(Request request, Response response, String decodedPath) Handles a local call.

Methods inherited from class org.restlet.engine.local.EntityClientHelper

createReference, getReencodedVariantEntityName, handleEntityGet

Methods inherited from class org.restlet.engine.local.LocalClientHelper

getDefaultLanguage, getTimeToLive, handle

Methods inherited from class org.restlet.engine.connector.ConnectorHelper

getConnectorService, getContext, getProtocols, start, stop, update

Methods inherited from class org.restlet.engine.RestletHelper

getAttributes, getHelped, getHelpedParameters, getLogger, getMetadataService, setHelped

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServletWarClientHelper

public ServletWarClientHelper(Client client,
                              javax.servlet.ServletContext servletContext)

Constructor.

Parameters:

client - The client to help.

servletContext - The Servlet context.

Method Detail

getEntity

public Entity getEntity(String decodedPath)

Description copied from class: EntityClientHelper

Returns a local entity for the given path.

Specified by:

getEntity in class EntityClientHelper

Parameters:

decodedPath - The path of the entity.

Returns:

A local entity for the given path.

getServletContext

public javax.servlet.ServletContext getServletContext()

Returns the Servlet context.

Returns:

The Servlet context.

handleLocal

public void handleLocal(Request request,
                        Response response,
                        String decodedPath)

Description copied from class: LocalClientHelper

Handles a local call.

Overrides:

handleLocal in class EntityClientHelper

Parameters:

request - The request to handle.

response - The response to update.

decodedPath - The decoded local path.