net.grinder.tools.tcpproxy

Interface TCPProxyFilter

All Known Implementing Classes:

CompositeFilter, EchoFilter, HTTPRequestFilter, HTTPResponseFilter, NullFilter

public interface TCPProxyFilter

Interface that TCP Proxy filters must implement.

In addition, filters are registered with a PicoContainer. They can learn about a Logger, other filters, and custom components (see the TCPProxy -component option) through constructor injection. Filters can also implement the PicoContainer life cycle methods Startable and Disposable.

Well behaved filters should not swallow InterruptedExceptions. Ideally, they should convert InterruptedExceptions to UncheckedInterruptedExceptions; but alternatively they could reinstate the Thread's interrupted status.

The equality semantics of the ConnectionDetails passed to each method can be used to uniquely identify a connection.

Author:

Philip Aston, Bertrand Ave

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TCPProxyFilter.FilterException Exception type for filter problems.

Method Summary

Methods

Modifier and Type	Method and Description
void	connectionClosed(ConnectionDetails connectionDetails) A connection has been closed.
void	connectionOpened(ConnectionDetails connectionDetails) A new connection has been opened.
byte[]	handle(ConnectionDetails connectionDetails, byte[] buffer, int bytesRead) Handle a message fragment from the stream.

Method Detail

handle

byte[] handle(ConnectionDetails connectionDetails,
            byte[] buffer,
            int bytesRead)
              throws TCPProxyFilter.FilterException

Handle a message fragment from the stream.

Parameters:

connectionDetails - Describes the connection.

buffer - Contains the data.

bytesRead - How many bytes of data in buffer.

Returns:

Filters can optionally return a byte[] which will be transmitted to the server instead of buffer.

Throws:

TCPProxyFilter.FilterException - If an error occurs.

connectionOpened

void connectionOpened(ConnectionDetails connectionDetails)
                      throws TCPProxyFilter.FilterException

A new connection has been opened.

Parameters:

connectionDetails - Describes the connection.

Throws:

TCPProxyFilter.FilterException - If an error occurs.

connectionClosed

void connectionClosed(ConnectionDetails connectionDetails)
                      throws TCPProxyFilter.FilterException

A connection has been closed.

Parameters:

connectionDetails - Describes the connection.

Throws:

TCPProxyFilter.FilterException - If an error occurs.