Previous Topic: ProxyFilterConfig Interface

Next Topic: ProxyFilterException Class


ProxyResponse Interface

Defines the interface that provides access to HTTP response information to be returned to the proxy client. The interface consists of the following methods:

Return Value

Method

void

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

Adds a header with the specified name and value. This method allows response headers to have multiple values.

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 response to the proxy request. This is the content to be returned to the proxy client.

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.

int

getStatusCode()

Returns the HTTP response status code of the response to the proxy request.

java.lang.String

removeHeader(java.lang.String name)

Removes the specified header. Returns the value of the removed 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

setContent(byte[] content)

Sets the content of the response to the proxy request. This overwrites the content to be returned to the proxy client.

Parameters:

content - the byte array containing the content

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