Administration Guide › SPS APIs › Filter API Overview › ProxyFilter Interface

Previous Topic: Filter API Class File

Next Topic: BaseProxyFilter Abstract Implementation

ProxyFilter Interface

The ProxyFilter interface defines the interface implemented by a proxy filter. However, it is recommended that you extend the BaseProxyFilter Abstract Implementation, rather than implementing the ProxyFilter interface.

The ProxyFilter interface consists of the following methods:

Return Value

Method

void

doFilter(ProxyRequest prequest, ProxyResponse presponse)

Performs the filtering.

Parameters:

request - the proxy request data

response - the proxy response data

Throws:

ProxyFilterException - thrown if failure processing filtering.

ProxyFilterConfig

getFilterConfig()

Returns this filter's ProxyFilterConfig object. (ProxyFilterConfig object that initialized this filter).

void

init(ProxyFilterConfig config)

Called when the filter is created to perform any required initialization.

Parameters:

config - a ProxyFilterConfig object containing the filters's configuration and initialization parameters

Throws:

ProxyFilterException - thrown if failure initializing this filter.