Previous Topic: BaseProxyFilter Abstract Implementation

Next Topic: Implement a Filter

ProxyFilterException Class

The ProxyFilterException class defines a general exception that a filter can throw when it encounters difficulty.

Constructor Signature

Description

ProxyFilterException()

Constructs a new ProxyFilterException.

ProxyFilterException(java.lang.String message)

Constructs a new ProxyFilterException with the specified message.

Parameters:

message - Message of exception

ProxyFilterException(java.lang.String message, java.lang.Throwable rootCause)

Constructs a new ProxyFilterException with the specified message and root cause.

Parameters:

message - Message of exception

rootCause - Exception that caused this exception to be raised

ProxyFilterException(java.lang.Throwable rootCause)

Constructs a new ProxyFilterException with the specified message and root cause.

Parameters:

rootCause - Exception that caused this exception to be raised

ProxyRequest Interface

Defines the interface that provides access to HTTP request information to be sent by the proxy. The interface consists of the following methods:

Return Value

Method

java.lang.String

getHeader(java.lang.String name)

Returns the value of the specified header as a String. If the header does not exist, this method returns null. The header name is not case sensitive.

Parameters:

name - a String specifying the header name

java.util.Enumeration

getHeaderNames()

Returns an Enumeration of all the header names. If no headers exist, this method returns an empty Enumeration.

javax.servlet.http.HttpServletRequest

getOriginalRequest()

Returns the original HttpServletRequest made to the proxy.

java.lang.String

getSessionKey()

Returns the value of the session key as a String. If the key is not available, this method returns null. The key may be used to rewrite URL's in the content when using cookieless schemes.

Note: The SessionScheme is responsible for creating the key and storing it in an attribute named SessionScheme.DEFAULT_SESSION_KEY_NAME

java.lang.String

getTargetQueryString()

Returns the query string the proxy will use with the target URL. The query string may be from the original request or a new one defined through the proxy rules. This method returns null if the URL does not have a query string.

java.lang.String

getTargetURL()

Returns the URL the proxy will use to make the request as defined by the proxy rules. The URL does not include query string parameters.

boolean

isInbound()

Returns a boolean value indicating the state of the request processing. If the request has not been forwarded to the target server true is returned. If the request was sent and the response received false is returned.

boolean

isOutbound()

Returns a boolean value indicating the state of the request processing. If the request has not been forwarded to the target server false is returned. If the request was sent and the response received true is returned.

java.lang.String

removeHeader(java.lang.String name)

Removes and returns the value of the specified header as a String. If the header does not exist, this method returns null. The header name is not case sensitive.

Parameters:

name - a String specifying the header name

void

setHeader(java.lang.String name, java.lang.String value)

Sets a header with the specified name and value. If a header with the same name exists it will be overwritten.

Parameters:

name - a String specifying the header name

value - a String specifying the header value

byte[]

getContent()

Returns a byte array of the content of the Request POST data. This is the content which is sent to the backend server.

void

setContent(byte[] content)

Sets the content of the POST data to the proxy request.

This overwrites the content to be sent to the backend server.

Parameters:

content - the byte array containing the request POST data