SOCKSServer (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.i2ptunnel.socks.SOCKSServer

Direct Known Subclasses:
SOCKS4aServer, SOCKS5Server
```
abstract class SOCKSServer
extends Object
```
Abstract base class used by all SOCKS servers.

Field Summary

Fields
Modifier and Type	Field and Description
`protected I2PAppContext`	`_context`
`protected Log`	`_log`
`protected int`	`addressType` SOCKS address type (e.g.
`protected Socket`	`clientSock`
`protected String`	`connHostName` Hostname requested by the SOCKS client.
`protected int`	`connPort` Port requested by the SOCKS client.
`protected Properties`	`props`

Constructor Summary
Constructors
Modifier Constructor and Description
protected SOCKSServer(I2PAppContext ctx, Socket clientSock, Properties props)

Constructors
Modifier	Constructor and Description
`protected`	`SOCKSServer(I2PAppContext ctx, Socket clientSock, Properties props)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`confirmConnection()` Confirm to the client that the connection has succeeded
`abstract Socket`	`getClientSocket()` Get a socket that can be used to send/receive 8-bit clean data to/from the client.
`abstract I2PSocket`	`getDestinationI2PSocket(I2PSOCKSTunnel t)` Get an I2PSocket that can be used to send/receive 8-bit clean data to/from the destination of the SOCKS connection.
`protected String`	`getMappedDomainNameForIP(String ip)` IP to domain name mapping support.
`protected Outproxy`	`getOutproxyPlugin()`
`void`	`httpsConnect(I2PSocket destSock, OutputStream pout, String connHostName, int connPort, String configUser, String configPW)` Act as a https client to connect to a CONNECT outproxy.
`protected I2PSocket`	`outproxyConnect(I2PSOCKSTunnel tun, String proxy)` Act as a SOCKS 5 client to connect to an outproxy Caller must send success or error to local socks client.
`protected abstract void`	`setupServer()` Perform server initialization (expecially regarding protected variables).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _context
```
protected final I2PAppContext _context
```
  - _log
```
protected final Log _log
```
  - addressType
```
protected int addressType
```
    SOCKS address type (e.g. DOMAINNAME, IPv4, IPv6).
  - clientSock
```
protected final Socket clientSock
```
  - connHostName
```
protected String connHostName
```
    Hostname requested by the SOCKS client.
  - connPort
```
protected int connPort
```
    Port requested by the SOCKS client.
  - props
```
protected final Properties props
```
- Constructor Detail
  - SOCKSServer
```
protected SOCKSServer(I2PAppContext ctx,
                      Socket clientSock,
                      Properties props)
```
- Method Detail
  - confirmConnection
```
protected abstract void confirmConnection()
                                   throws SOCKSException
```
    Confirm to the client that the connection has succeeded
    Throws:
    SOCKSException
  - getClientSocket
```
public abstract Socket getClientSocket()
                                throws SOCKSException
```
    Get a socket that can be used to send/receive 8-bit clean data to/from the client.
    Returns:
    a Socket connected with the client
    Throws:
    SOCKSException
  - getDestinationI2PSocket
```
public abstract I2PSocket getDestinationI2PSocket(I2PSOCKSTunnel t)
                                           throws SOCKSException
```
    Get an I2PSocket that can be used to send/receive 8-bit clean data to/from the destination of the SOCKS connection.
    Returns:
    an I2PSocket connected with the destination
    Throws:
    SOCKSException
  - getMappedDomainNameForIP
```
protected String getMappedDomainNameForIP(String ip)
```
    IP to domain name mapping support. This matches the given IP string against a user-set list of mappings. This enables applications which do not properly support the SOCKS5 DOMAINNAME feature to be used with I2P.
    Parameters:
    ip - The IP address to check.
    Returns:
    The domain name if a mapping is found, or null otherwise.
  - getOutproxyPlugin
```
protected Outproxy getOutproxyPlugin()
```
    Returns:
    null if disabled or not installed
  - httpsConnect
```
public void httpsConnect(I2PSocket destSock,
                         OutputStream pout,
                         String connHostName,
                         int connPort,
                         String configUser,
                         String configPW)
                  throws IOException
```
    Act as a https client to connect to a CONNECT outproxy. Caller must send success or error to local socks client. Caller must close destSock and pout.
    Parameters:
    destSock - socket to the proxy
    pout - output stream to the proxy
    connHostName - hostname or IP for the proxy to connect to
    connPort - port for the proxy to connect to
    configUser - username unsupported
    configPW - password unsupported
    Throws:
    IOException
  - outproxyConnect
```
protected I2PSocket outproxyConnect(I2PSOCKSTunnel tun,
                                    String proxy)
                             throws IOException,
                                    I2PException
```
    Act as a SOCKS 5 client to connect to an outproxy Caller must send success or error to local socks client.
    Returns:
    open socket or throws error
    Throws:
    IOException
    I2PException
  - setupServer
```
protected abstract void setupServer()
                             throws SOCKSException
```
    Perform server initialization (expecially regarding protected variables).
    Throws:
    SOCKSException

Class SOCKSServer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_context

_log

addressType

clientSock

connHostName

connPort

props

Constructor Detail

SOCKSServer

Method Detail

confirmConnection

getClientSocket

getDestinationI2PSocket

getMappedDomainNameForIP

getOutproxyPlugin

httpsConnect

outproxyConnect

setupServer