AbstractSocksProxyHandler (SNF4J 1.10.0 API)

java.lang.Object
- org.snf4j.core.handler.AbstractHandler
- - org.snf4j.core.handler.AbstractStreamHandler
  - - org.snf4j.core.proxy.AbstractProxyHandler
    - - org.snf4j.core.proxy.AbstractSocksProxyHandler

All Implemented Interfaces:

IHandler, IStreamHandler, IStreamReader

Direct Known Subclasses:

Socks4ProxyHandler, Socks5ProxyHandler
```
public abstract class AbstractSocksProxyHandler
extends AbstractProxyHandler
```
Base implementation for handlers processing client connections via SOCKS proxy protocols.

Author:

SNF4J.ORG

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractSocksProxyHandler(InetSocketAddress address, ISessionConfig config, ISessionStructureFactory factory)` Constructs a SOCKS proxy connection handler with the specified destination address, the default (10 seconds) connection timeout, configuration and factory.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addReplyListener(ISocksReplyListener listener)` Adds a listener for replies sent from the SOCKS 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.
`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.
`void`	`event(SessionEvent event)` Called to notify about a change of the associated session state.
`InetSocketAddress`	`getAddress()` Returns the destination address.
`ISocksReply[]`	`getReplies()` Returns replies sent from the SOCKS server.
`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
connectionTimeout, 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
  - AbstractSocksProxyHandler
```
protected AbstractSocksProxyHandler(InetSocketAddress address,
                                    ISessionConfig config,
                                    ISessionStructureFactory factory)
```
    Constructs a SOCKS proxy connection handler with the specified destination address, 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:
    
    address - the destination address
    
    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 address is null
- Method Detail
  - getAddress
```
public InetSocketAddress getAddress()
```
    Returns the destination address.
    
    Returns:
    
    the destination address
  - getReplies
```
public ISocksReply[] getReplies()
```
    Returns replies sent from the SOCKS server.
    
    Returns:
    
    the replies sent from the SOCKS server
  - addReplyListener
```
public void addReplyListener(ISocksReplyListener listener)
```
    Adds a listener for replies sent from the SOCKS server
    
    Parameters:
    
    listener - a listener for replies
  - 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 AbstractProxyHandler
    
    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.
  - 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(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.
  - 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.
  - 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.
  - 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

Class AbstractSocksProxyHandler

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSocksProxyHandler

Method Detail

getAddress

getReplies

addReplyListener

available

available

read

read

handleReady

read

event