org.apache.portals.applications.webcontent2.proxy

Class ProxyContext

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

org.apache.commons.chain.impl.ContextBase

org.apache.portals.applications.webcontent2.proxy.ProxyContext

All Implemented Interfaces:

Serializable, Cloneable, Map, org.apache.commons.chain.Context

public class ProxyContext
extends org.apache.commons.chain.impl.ContextBase

Base Context implementation to be used in a reverse proxy service execution.

See Also:

org.apache.commons.chain.Context}, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ProxyContext(RequestContext requestContext) Constructs a ProxyContext for the given RequestContext.
ProxyContext(RequestContext requestContext, Map map) Constructs a ProxyContext for the given RequestContext with putting all entries into the ProxyContext from the initial map.

Method Summary

Methods

Modifier and Type	Method and Description
void	addException(Exception e) Adds an exception caught during the current reverse proxy processing.
ContentRewriter	getContentRewriter() Returns the ContentRewriter instance used in the current reverse proxy processing context.
org.apache.http.client.CookieStore	getCookieStore() Returns the CookieStore instance used in this reverse proxy processing context.
static ProxyContext	getCurrentProxyContext() Returns the current ProxyContext instance in the static thread local variable.
List<Exception>	getExceptions() Returns a list of exception(s) caught during the current reverse proxy processing.
org.apache.http.client.HttpClient	getHttpClient() Returns the internal HttpClient instance used in this reverse proxy processing context.
org.apache.http.client.methods.HttpRequestBase	getHttpRequest() Returns the HttpRequestBase instance used in the current reverse proxy processing context.
org.apache.http.HttpResponse	getHttpResponse() Returns the HttpResponse instance used in the current reverse proxy processing context.
String	getLocalPath() Returns the local path info in this reverse proxy processing context.
ProxyMappingRegistry	getProxyMappingRegistry() Returns the reverse proxy mapping registry in this reverse proxy processing context.
URI	getRemoteURI() Returns the remote target URI in this reverse proxy processing context.
RequestContext	getRequestContext() Returns the RequestContext instance in this reverse proxy processing context.
ProxyMapping	getResolvedMapping() Returns the resolved reverse proxy mapping in this reverse proxy processing context.
boolean	hasException() Returns true if there's any exception caught during the current reverse proxy processing.
static void	removeCurrentProxyContext() Removes the current ProxyContext instance from the static thread local variable.
void	setContentRewriter(ContentRewriter contentRewriter) Sets the ContentRewriter instance to be used in the current reverse proxy processing context.
void	setCookieStore(org.apache.http.client.CookieStore cookieStore) Sets the CookieStore instance to be used in this reverse proxy processing context.
static void	setCurrentProxyContext(ProxyContext proxyContext) Sets the current ProxyContext instance in the static thread local variable.
void	setHttpClient(org.apache.http.client.HttpClient httpClient) Sets the internal HttpClient instance to be used in this reverse proxy processing context.
void	setHttpRequest(org.apache.http.client.methods.HttpRequestBase httpRequest) Sets the HttpRequestBase instance to be used in the current reverse proxy processing context.
void	setHttpResponse(org.apache.http.HttpResponse httpResponse) Sets the HttpResponse instance to be used in the current reverse proxy processing context.
void	setLocalPath(String localPath) Sets the local path info in this reverse proxy processing context.
void	setProxyMappingRegistry(ProxyMappingRegistry proxyMappingRegistry) Sets the reverse proxy mapping registry in this reverse proxy processing context.
void	setRemoteURI(URI remoteURI) Sets the remote target URI in this reverse proxy processing context.
void	setResolvedMapping(ProxyMapping resolvedMapping) Sets the resolved reverse proxy mapping in this reverse proxy processing context.

Methods inherited from class org.apache.commons.chain.impl.ContextBase

clear, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, values

Methods inherited from class java.util.HashMap

clone, containsKey, size

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

containsKey, equals, hashCode, size

Constructor Detail

ProxyContext

public ProxyContext(RequestContext requestContext)

Constructs a ProxyContext for the given RequestContext.

Parameters:

requestContext -

ProxyContext

public ProxyContext(RequestContext requestContext,
            Map map)

Constructs a ProxyContext for the given RequestContext with putting all entries into the ProxyContext from the initial map.

Parameters:

requestContext -

map -

Method Detail

getCurrentProxyContext

public static ProxyContext getCurrentProxyContext()

Returns the current ProxyContext instance in the static thread local variable. In some cases, a component, during the reverse proxy processing, might not have an access to the ProxyContext instance. In that case, that kind of component might want to invoke this method to retrieve the current ProxyContext instance.

Returns:

setCurrentProxyContext

public static void setCurrentProxyContext(ProxyContext proxyContext)

Sets the current ProxyContext instance in the static thread local variable.

Parameters:

proxyContext -

removeCurrentProxyContext

public static void removeCurrentProxyContext()

Removes the current ProxyContext instance from the static thread local variable.

getRequestContext

public RequestContext getRequestContext()

Returns the RequestContext instance in this reverse proxy processing context.

Returns:

getProxyMappingRegistry

public ProxyMappingRegistry getProxyMappingRegistry()

Returns the reverse proxy mapping registry in this reverse proxy processing context.

Returns:

setProxyMappingRegistry

public void setProxyMappingRegistry(ProxyMappingRegistry proxyMappingRegistry)

Sets the reverse proxy mapping registry in this reverse proxy processing context.

Parameters:

proxyMappingRegistry -

getResolvedMapping

public ProxyMapping getResolvedMapping()

Returns the resolved reverse proxy mapping in this reverse proxy processing context.

Returns:

setResolvedMapping

public void setResolvedMapping(ProxyMapping resolvedMapping)

Sets the resolved reverse proxy mapping in this reverse proxy processing context.

Parameters:

resolvedMapping -

getLocalPath

public String getLocalPath()

Returns the local path info in this reverse proxy processing context.

Returns:

setLocalPath

public void setLocalPath(String localPath)

Sets the local path info in this reverse proxy processing context.

Parameters:

localPath -

getRemoteURI

public URI getRemoteURI()

Returns the remote target URI in this reverse proxy processing context.

Returns:

setRemoteURI

public void setRemoteURI(URI remoteURI)

Sets the remote target URI in this reverse proxy processing context.

Parameters:

remoteURI -

getHttpClient

public org.apache.http.client.HttpClient getHttpClient()

Returns the internal HttpClient instance used in this reverse proxy processing context.

Returns:

setHttpClient

public void setHttpClient(org.apache.http.client.HttpClient httpClient)

Sets the internal HttpClient instance to be used in this reverse proxy processing context.

Parameters:

httpClient -

getCookieStore

public org.apache.http.client.CookieStore getCookieStore()

Returns the CookieStore instance used in this reverse proxy processing context.

Returns:

setCookieStore

public void setCookieStore(org.apache.http.client.CookieStore cookieStore)

Sets the CookieStore instance to be used in this reverse proxy processing context.

Parameters:

cookieStore -

getHttpRequest

public org.apache.http.client.methods.HttpRequestBase getHttpRequest()

Returns the HttpRequestBase instance used in the current reverse proxy processing context.

Returns:

setHttpRequest

public void setHttpRequest(org.apache.http.client.methods.HttpRequestBase httpRequest)

Sets the HttpRequestBase instance to be used in the current reverse proxy processing context.

Parameters:

httpRequest -

getHttpResponse

public org.apache.http.HttpResponse getHttpResponse()

Returns the HttpResponse instance used in the current reverse proxy processing context.

Returns:

setHttpResponse

public void setHttpResponse(org.apache.http.HttpResponse httpResponse)

Sets the HttpResponse instance to be used in the current reverse proxy processing context.

Parameters:

httpResponse -

getContentRewriter

public ContentRewriter getContentRewriter()

Returns the ContentRewriter instance used in the current reverse proxy processing context.

Returns:

setContentRewriter

public void setContentRewriter(ContentRewriter contentRewriter)

Sets the ContentRewriter instance to be used in the current reverse proxy processing context.

Parameters:

contentRewriter -

hasException

public boolean hasException()

Returns true if there's any exception caught during the current reverse proxy processing. Otherwise returns false.

Returns:

addException

public void addException(Exception e)

Adds an exception caught during the current reverse proxy processing.

Parameters:

e -

getExceptions

public List<Exception> getExceptions()

Returns a list of exception(s) caught during the current reverse proxy processing.

Returns: