org.esigate.impl

Class DriverRequest

java.lang.Object

org.esigate.impl.DriverRequest

public class DriverRequest
extends Object

A request to be executed by a given Driver instance.

Author:

Francois-Xavier Bonnet

Constructor Summary

Constructors

Constructor and Description
DriverRequest(IncomingRequest request, Driver driver, String relUrl)

Method Summary

Modifier and Type	Method and Description
URL	getBaseUrl() Returns the base url selected to send this request.
String	getCharacterEncoding() Returns the charset used to encode and decode the request parameters.
ContainerRequestContext	getContext() Returns the context specifit to the container (servlet container for instance).
Driver	getDriver() Returns the driver instance that handles this request.
IncomingRequest	getOriginalRequest() Returns the original request received from the client.
UserContext	getUserContext() Returns the user context associated with this request.
String	getVisibleBaseUrl() Returns the base url as seen by the client.
boolean	isExternal() Returns true if the target url is not one the provider application.
void	setCharacterEncoding(String characterEncoding) Sets the charset to use to encode and decode the parameters for this request.

Methods inherited from class java.lang.Object

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

Constructor Detail

DriverRequest

public DriverRequest(IncomingRequest request,
                     Driver driver,
                     String relUrl)
              throws HttpErrorPage

Parameters:

request -

driver -

relUrl -

Throws:

HttpErrorPage

Method Detail

getDriver

public Driver getDriver()

Returns the driver instance that handles this request.

Returns:

the driver instance

getUserContext

public UserContext getUserContext()

Returns the user context associated with this request.

Returns:

the user context

getBaseUrl

public URL getBaseUrl()

Returns the base url selected to send this request.

Returns:

the base url

getCharacterEncoding

public String getCharacterEncoding()

Returns the charset used to encode and decode the request parameters.

Returns:

the charset

setCharacterEncoding

public void setCharacterEncoding(String characterEncoding)

Sets the charset to use to encode and decode the parameters for this request.

Parameters:

characterEncoding - the charset name

getContext

public ContainerRequestContext getContext()

Returns the context specifit to the container (servlet container for instance).

Returns:

the context

getOriginalRequest

public IncomingRequest getOriginalRequest()

Returns the original request received from the client.

Returns:

the original request

isExternal

public boolean isExternal()

Returns true if the target url is not one the provider application.

Returns:

true if the url is on the provider

getVisibleBaseUrl

public String getVisibleBaseUrl()

Returns the base url as seen by the client.

Returns:

the visible base url