org.snf4j.core.proxy

Class HttpProxyHandler

java.lang.Object

org.snf4j.core.handler.AbstractHandler

org.snf4j.core.handler.AbstractStreamHandler

org.snf4j.core.proxy.AbstractProxyHandler

org.snf4j.core.proxy.HttpProxyHandler

All Implemented Interfaces:

IHandler, IStreamHandler, IStreamReader

public class HttpProxyHandler
extends AbstractProxyHandler

Handles client proxy connections via the HTTP tunneling protocol. For more details about the protocol refer to HTTP CONNECT tunneling

Author:

SNF4J.ORG

Constructor Summary

Constructors

Constructor and Description
HttpProxyHandler(URI uri) Constructs an HTTP tunnel connection handler with the default (10 seconds) connection timeout.
HttpProxyHandler(URI uri, ISessionConfig config) Constructs an HTTP tunnel connection handler with the default (10 seconds) connection timeout and configuration.
HttpProxyHandler(URI uri, ISessionConfig config, ISessionStructureFactory factory) Constructs an HTTP tunnel connection handler with the default (10 seconds) connection timeout, configuration and factory.
HttpProxyHandler(URI uri, String username, String password) Constructs an HTTP tunnel connection handler with the default (10 seconds) connection timeout and user's name/password for the 'Basic' HTTP authentication scheme.
HttpProxyHandler(URI uri, String username, String password, ISessionConfig config) Constructs an HTTP tunnel connection handler with the default (10 seconds) connection timeout, user's name/password for the 'Basic' HTTP authentication scheme and configuration.
HttpProxyHandler(URI uri, String username, String password, ISessionConfig config, ISessionStructureFactory factory) Constructs an HTTP tunnel connection handler with the default (10 seconds) connection timeout, user's name/password for the 'Basic' HTTP authentication scheme, configuration and factory.

Method Summary

Modifier and Type	Method and Description
HttpProxyHandler	allowBothTerminators(boolean allow) Configures the handling of line terminators in responses from a HTTP proxy server
void	appendHeader(String name, String value) Appends an HTTP header to the HTTP CONNECT method request being sent to an HTTP proxy server.
int	available(byte[] data, int off, int len) Determines how many bytes can be read from the input buffer after receiving new data from the remote end.
HttpProxyHandler	connectionTimeout(long connectionTimeout) Configures the proxy connection timeout.
void	event(SessionEvent event) Called to notify about a change of the associated session state.
protected int	getDefaultPort(URI uri) Returns the default port number associated with the scheme in the provided URI.
protected void	handleReady() Called to initiate the connection process via a proxy protocol
void	read(byte[] data) Called when new bytes were read from the input buffer.
void	read(ByteBuffer data) Called when new bytes were read from the input buffer.
void	read(Object msg) Called when a new message was read and decoded from the input buffer.

Methods inherited from class org.snf4j.core.proxy.AbstractProxyHandler

available, getFactory, timer

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

getSession, setSession

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

event, exception, getConfig, getName, incident, 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, timer

Constructor Detail

HttpProxyHandler

public HttpProxyHandler(URI uri)

Constructs an HTTP tunnel connection handler with the default (10 seconds) connection timeout.

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

Parameters:

uri - the URI identifying the remote host to which the HTTP tunnel should be established

Throws:

IllegalArgumentException - if the uri is null

HttpProxyHandler

public HttpProxyHandler(URI uri,
                        String username,
                        String password)

Constructs an HTTP tunnel connection handler with the default (10 seconds) connection timeout and user's name/password for the 'Basic' HTTP authentication scheme.

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

Parameters:

uri - the URI identifying the remote host to which the HTTP tunnel should be established

username - the user's name

password - the user's password

Throws:

IllegalArgumentException - if the uri, username or password is null

HttpProxyHandler

public HttpProxyHandler(URI uri,
                        ISessionConfig config)

Constructs an HTTP tunnel connection handler with the default (10 seconds) connection timeout and configuration.

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

Parameters:

uri - the URI identifying the remote host to which the HTTP tunnel should be established

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

Throws:

IllegalArgumentException - if the uri is null

HttpProxyHandler

public HttpProxyHandler(URI uri,
                        String username,
                        String password,
                        ISessionConfig config)

Constructs an HTTP tunnel connection handler with the default (10 seconds) connection timeout, user's name/password for the 'Basic' HTTP authentication scheme and configuration.

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

Parameters:

uri - the URI identifying the remote host to which the HTTP tunnel should be established

username - the user's name

password - the user's password

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

Throws:

IllegalArgumentException - if the uri, username or password is null

HttpProxyHandler

public HttpProxyHandler(URI uri,
                        ISessionConfig config,
                        ISessionStructureFactory factory)

Constructs an HTTP tunnel 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:

uri - the URI identifying the remote host to which the HTTP tunnel should be established

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

Throws:

IllegalArgumentException - if the uri is null

HttpProxyHandler

public HttpProxyHandler(URI uri,
                        String username,
                        String password,
                        ISessionConfig config,
                        ISessionStructureFactory factory)

Constructs an HTTP tunnel connection handler with the default (10 seconds) connection timeout, user's name/password for the 'Basic' HTTP authentication scheme, configuration and factory.

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

Parameters:

uri - the URI identifying the remote host to which the HTTP tunnel should be established

username - the user's name

password - the user's password

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

Throws:

IllegalArgumentException - if the uri, username or password is null

Method Detail

connectionTimeout

public HttpProxyHandler 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.

Overrides:

connectionTimeout in class AbstractProxyHandler

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

allowBothTerminators

public HttpProxyHandler allowBothTerminators(boolean allow)

Configures the handling of line terminators in responses from a HTTP proxy server

Parameters:

allow - true to allow both CRLF and LF line terminators in responses from a HTTP proxy server, or otherwise (default option) only CRLF will be allowed.

Returns:

this handler

available

public int available(byte[] data,
                     int off,
                     int len)

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 backed by an array. The type of the input buffer is specified by the implementation of the ISessionStructureFactory returned by the getFactory method.

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

This implementation always returns total number of bytes in the array (i.e. the len value).

Specified by:

available in interface IStreamReader

Overrides:

available in class AbstractStreamHandler

Parameters:

data - the array that backs the input buffer.

off - the offset of the array

len - the number of the bytes in the array

Returns:

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

read

public void read(byte[] data)

Description copied from class: AbstractHandler

Called when new bytes were read from the input buffer. This method is called when none of the conditions for calling other read methods are met.

The passed array can be safely stored or modified by this method as it will not be used by the caller.

By default it simply passes the data value to the IHandler.read(Object) method.

Specified by:

read in interface IHandler

Specified by:

read in interface IStreamReader

Overrides:

read in class AbstractHandler

Parameters:

data - bytes that was read from the input buffer.

read

public void read(ByteBuffer data)

Description copied from class: AbstractHandler

Called when new bytes were read from the input buffer. This method is called when the associated session is configured with a codec pipeline in which the last decoder produces ByteBuffer objects or when the associated session is configured to optimize data copying and uses an allocator supporting the releasing of no longer used buffers

The passed byte buffer can be safely stored or modified by this method as it will not be used by the caller. However, if the associated session is configured to optimize data copying and uses an allocator supporting the releasing of no longer used buffers it may be required to release it in this method unless the original buffer has been already released by one of the associated decoders.

By default it simply passes the data value to the IHandler.read(Object) method.

Specified by:

read in interface IHandler

Specified by:

read in interface IStreamReader

Overrides:

read in class AbstractHandler

Parameters:

data - bytes that was read from the input buffer.

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 AbstractProxyHandler

Parameters:

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

See Also:

SessionEvent

appendHeader

public void appendHeader(String name,
                         String value)

Appends an HTTP header to the HTTP CONNECT method request being sent to an HTTP proxy server.

There is no need to append the Host header as it is appended by default.

Parameters:

name - the name of the HTTP header

value - the value of the HTTP header

getDefaultPort

protected int getDefaultPort(URI uri)
                      throws Exception

Returns the default port number associated with the scheme in the provided URI.

By default it calls uri.toURL().getDefaultPort()

Parameters:

uri - the provided URI

Returns:

the default port number, or -1 if the default port number is not defined for the scheme in the provided URI

Throws:

Exception - if the provided URI was malformed

handleReady

protected void handleReady()
                    throws Exception

Description copied from class: AbstractProxyHandler

Called to initiate the connection process via a proxy protocol

Specified by:

handleReady in class AbstractProxyHandler

Throws:

Exception - if a failure occurred

read

public void read(Object msg)

Description copied from interface: IHandler

Called when a new message was read and decoded from the input buffer. This method is called when the associated session is configured with a codec pipeline in which the last decoder produces outbound object(s) of type different than the byte[] and ByteBuffer.

Parameters:

msg - the message that was read and decoded from the input buffer.