org.snf4j.core.proxy

Class AbstractProxyHandler

java.lang.Object

org.snf4j.core.handler.AbstractHandler

org.snf4j.core.handler.AbstractStreamHandler

org.snf4j.core.proxy.AbstractProxyHandler

All Implemented Interfaces:

IHandler, IStreamHandler, IStreamReader

Direct Known Subclasses:

AbstractSocksProxyHandler, HttpProxyHandler

public abstract class AbstractProxyHandler
extends AbstractStreamHandler

Base implementation for handlers processing client connections via proxy protocols.

Author:

SNF4J.ORG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractProxyHandler(ISessionConfig config, ISessionStructureFactory factory) Constructs a proxy connection handler with the default (10 seconds) connection timeout, configuration and factory.

Method Summary

Modifier and Type	Method and Description
int	available(ByteBuffer data, boolean flipped) Determines how many bytes can be read from the input buffer after receiving new data from the remote end.
AbstractProxyHandler	connectionTimeout(long connectionTimeout) Configures the proxy connection timeout.
void	event(SessionEvent event) Called to notify about a change of the associated session state.
ISessionStructureFactory	getFactory() Returns the factory object that will be used to configure the internal structure of the associated session.
protected abstract void	handleReady() Called to initiate the connection process via a proxy protocol
void	timer(Object event) Called to notify about an expiration of the timer identified by the specified event object.

Methods inherited from class org.snf4j.core.handler.AbstractStreamHandler

available, getSession, setSession

Methods inherited from class org.snf4j.core.handler.AbstractHandler

event, exception, getConfig, getName, incident, read, read, timer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.snf4j.core.handler.IHandler

event, exception, getConfig, getName, incident, read, read, read, timer

Methods inherited from interface org.snf4j.core.IStreamReader

read, read

Constructor Detail

AbstractProxyHandler

protected AbstractProxyHandler(ISessionConfig config,
                               ISessionStructureFactory factory)

Constructs a proxy connection handler with the default (10 seconds) connection timeout, configuration and factory.

NOTE: The connection timeout will have no effect if the associated session does not support a session timer.

Parameters:

config - the session configuration object, or null to use the default configuration

factory - the factory that will be used to configure the internal structure of the associated session, or null to use the default factory

Method Detail

connectionTimeout

public AbstractProxyHandler connectionTimeout(long connectionTimeout)

Configures the proxy connection timeout.

NOTE: The connection timeout will have no effect if the associated session does not support a session timer.

Parameters:

connectionTimeout - the proxy connection timeout in milliseconds, or 0 to wait an infinite amount of time for establishing the HTTP tunnel

Returns:

this handler

Throws:

IllegalArgumentException - if the connection timeout is negative

available

public int available(ByteBuffer data,
                     boolean flipped)

Description copied from class: AbstractStreamHandler

Determines how many bytes can be read from the input buffer after receiving new data from the remote end. The specified number of bytes will be then passed as a byte array to the read method.

This method is called only if the input buffer is not backed by an array. The type of the input buffer is specified by the implementation of the ISessionStructureFactory returned by the getFactory method.

The inner state of the passed buffer cannot be changed by this method.

This implementation always returns total number of bytes in the buffer.

Specified by:

available in interface IStreamReader

Overrides:

available in class AbstractStreamHandler

Parameters:

data - the input buffer.

flipped - specifies the current mode of the buffer

Returns:

the number of bytes to read or 0 if the buffer has not enough data yet and the reading should skipped now.

handleReady

protected abstract void handleReady()
                             throws Exception

Called to initiate the connection process via a proxy protocol

Throws:

Exception - if a failure occurred

event

public void event(SessionEvent event)

Description copied from interface: IHandler

Called to notify about a change of the associated session state.

Specified by:

event in interface IHandler

Overrides:

event in class AbstractHandler

Parameters:

event - an event related with the change of the session state

See Also:

SessionEvent

timer

public void timer(Object event)

Description copied from interface: IHandler

Called to notify about an expiration of the timer identified by the specified event object.

Specified by:

timer in interface IHandler

Overrides:

timer in class AbstractHandler

Parameters:

event - the event object that identifies the timer

getFactory

public ISessionStructureFactory getFactory()

Description copied from interface: IHandler

Returns the factory object that will be used to configure the internal structure of the associated session.

Specified by:

getFactory in interface IHandler

Overrides:

getFactory in class AbstractHandler

Returns:

the factory object

See Also:

ISessionStructureFactory