net.grinder.tools.tcpproxy

Class AbstractTCPProxyEngine

java.lang.Object

net.grinder.tools.tcpproxy.AbstractTCPProxyEngine

All Implemented Interfaces:

Runnable, TCPProxyEngine

Direct Known Subclasses:

HTTPProxyTCPProxyEngine, PortForwarderTCPProxyEngine

public abstract class AbstractTCPProxyEngine
extends Object
implements TCPProxyEngine

Base class for TCPProxyEngine implementations.

Author:

Phil Dawes, Philip Aston, Bertrand Ave

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractTCPProxyEngine.FilteredStreamThread Runnable which actively reads an input stream and writes to an output stream, passing the data through a filter.
protected class	AbstractTCPProxyEngine.OutputStreamFilterTee Filter like class that delegates to a user filter and tees the result to an output stream.
protected class	AbstractTCPProxyEngine.StreamThread Wrapper for handling stream threads.

Constructor Summary

Constructors

Constructor and Description
AbstractTCPProxyEngine(TCPProxySocketFactory socketFactory, TCPProxyFilter requestFilter, TCPProxyFilter responseFilter, PrintWriter output, org.slf4j.Logger logger, EndPoint localEndPoint, boolean useColour, int timeout) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected Socket	accept() Accept a connection using our server socket.
protected EndPoint	getListenEndPoint() Return the EndPoint we are listening on.
protected org.slf4j.Logger	getLogger() Accessor for the logger.
protected TerminalColour	getRequestColour() Allow subclasses to access colour terminal control code for request streams.
protected TCPProxyFilter	getRequestFilter() Allow subclasses to access request filter.
protected TerminalColour	getResponseColour() Allow subclasses to access request terminal control code for response streams.
protected TCPProxyFilter	getResponseFilter() Allow subclasses to access response filter.
protected TCPProxySocketFactory	getSocketFactory() Allow subclasses to access socket factory.
boolean	isStopped() Check whether this engine is stopped.
protected void	launchThreadPair(Socket localSocket, Socket remoteSocket, EndPoint sourceEndPoint, EndPoint targetEndPoint, boolean isSecure) Launch a pair of threads to handle bi-directional stream communication.
protected String	logIOException(IOException e) Log IOExceptions.
abstract void	run() Main event loop.
void	stop() Stop the engine and flush filter buffer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractTCPProxyEngine

public AbstractTCPProxyEngine(TCPProxySocketFactory socketFactory,
                      TCPProxyFilter requestFilter,
                      TCPProxyFilter responseFilter,
                      PrintWriter output,
                      org.slf4j.Logger logger,
                      EndPoint localEndPoint,
                      boolean useColour,
                      int timeout)
                       throws IOException

Constructor.

Parameters:

socketFactory - Socket factory for creating our server and client sockets.

requestFilter - Request filter.

responseFilter - Response filter.

output - Where to direct the output.

logger - Logger.

localEndPoint - Local host and port to listen on. If the EndPoint's port is 0, an arbitrary port will be assigned.

useColour - Whether to use colour.

timeout - Timeout for server socket in milliseconds.

Throws:

IOException - If an I/O error occurs.

Method Detail

stop

public void stop()

Stop the engine and flush filter buffer.

Specified by:

stop in interface TCPProxyEngine

isStopped

public boolean isStopped()

Check whether this engine is stopped.

Returns:

true => the engine is stopped.

run

public abstract void run()

Main event loop.

We do not implement InterruptibleRunnable as we are not designed to be interrupted. If we are, code will throw an UncheckedInterruptedException - effectively an assertion.

Specified by:

run in interface Runnable

accept

protected Socket accept()
                 throws net.grinder.tools.tcpproxy.AbstractTCPProxyEngine.NoActivityTimeOutException,
                        IOException

Accept a connection using our server socket. Blocks until a connection is accepted.

Returns:

The client socket.

Throws:

IOException - If an I/O error occurred.

NoActivityTimeOutException - If the accept timed out, and we have no active threads handling connections.

net.grinder.tools.tcpproxy.AbstractTCPProxyEngine.NoActivityTimeOutException

getListenEndPoint

protected EndPoint getListenEndPoint()

Return the EndPoint we are listening on.

Returns:

The EndPoint.

getSocketFactory

protected final TCPProxySocketFactory getSocketFactory()

Allow subclasses to access socket factory.

Returns:

The socket factory.

getRequestFilter

protected final TCPProxyFilter getRequestFilter()

Allow subclasses to access request filter.

Returns:

The filter.

getResponseFilter

protected final TCPProxyFilter getResponseFilter()

Allow subclasses to access response filter.

Returns:

The filter.

getRequestColour

protected final TerminalColour getRequestColour()

Allow subclasses to access colour terminal control code for request streams.

Returns:

The filter.

getResponseColour

protected final TerminalColour getResponseColour()

Allow subclasses to access request terminal control code for response streams.

Returns:

The filter.

launchThreadPair

protected final void launchThreadPair(Socket localSocket,
                    Socket remoteSocket,
                    EndPoint sourceEndPoint,
                    EndPoint targetEndPoint,
                    boolean isSecure)
                               throws IOException

Launch a pair of threads to handle bi-directional stream communication.

Parameters:

localSocket - Local socket.

remoteSocket - Remote socket.

sourceEndPoint - The local EndPoint to be used in the logging and filter output. This may differ from the localSocket binding.

targetEndPoint - The remote EndPoint to be used in the logging and filter output. This may differ from the remoteSocket binding. *

isSecure - Whether the connection is secure.

Throws:

IOException - If an I/O error occurs.

logIOException

protected final String logIOException(IOException e)

Log IOExceptions.

Parameters:

e - The exception.

Returns:

A description of the exception.

getLogger

protected final org.slf4j.Logger getLogger()

Accessor for the logger.

Returns:

The Logger.