I2PTunnelHTTPClient (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.util.EventDispatcherImpl
- - net.i2p.i2ptunnel.I2PTunnelTask
  - - net.i2p.i2ptunnel.I2PTunnelClientBase
    - - net.i2p.i2ptunnel.I2PTunnelHTTPClientBase
      - net.i2p.i2ptunnel.I2PTunnelHTTPClient

All Implemented Interfaces:
Runnable, EventDispatcher
Direct Known Subclasses:
I2PTunnelHTTPBidirProxy
```
public class I2PTunnelHTTPClient
extends I2PTunnelHTTPClientBase
implements Runnable
```
HTTP proxy that tunnels requests through I2P.
Handles various request formats and forwards through I2P:
```
   $method http://$site[$port]/$path $protocolVersion
   $method $path $protocolVersion\nHost: $site
   $method http://i2p/$b64key/$path $protocolVersion
   $method /$site/$path $protocolVersion
   (deprecated) $method /eepproxy/$site/$path $protocolVersion
 
```
CONNECT (HTTPS) supported since 0.9.11. Note: http://i2p/$b64key/... and /eepproxy/$site/... not recommended for browsers due to broken relative links and cookies. http://$b64key/... and http://$b64key.i2p/... unsupported (illegal characters). Rewrite as http://i2p/$b64key/...
Directs I2P-resolved sites to destinations, others to outproxy (typically "squid.i2p"). Supports HTTP and HTTPS only. GET and POST tested; other methods should work.

Nested Class Summary
- Nested classes/interfaces inherited from class net.i2p.i2ptunnel.I2PTunnelHTTPClientBase
  I2PTunnelHTTPClientBase.AuthResult, I2PTunnelHTTPClientBase.OnProxySuccess, I2PTunnelHTTPClientBase.OnTimeout

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AUTH_REALM` HTTP authentication realm for HTTP proxy.
`(package private) static int`	`BROWSER_KEEPALIVE_TIMEOUT` how long to wait for another request on the same socket
`static String`	`DEFAULT_JUMP_SERVERS` Default jump server URLs.
`static String`	`LOCAL_SERVER` Local HTTP proxy server hostname.
`static String`	`OPT_KEEPALIVE_BROWSER` Config key to enable browser-side keepalive.
`static String`	`OPT_KEEPALIVE_I2P` Config key to enable I2P-side keepalive.
`static String`	`PROP_ACCEPT`
`static String`	`PROP_DISABLE_HELPER` Config key to disable address helper.
`static String`	`PROP_INTERNAL_SSL`
`static String`	`PROP_JUMP_SERVERS` Config key for jump server list.
`static String`	`PROP_REFERER` all default to false
`static String`	`PROP_SSL_SET`
`static String`	`PROP_USER_AGENT` Config key to enable sending User-Agent header.
`static String`	`PROP_VIA` Config key to enable sending Via header.

Fields inherited from class net.i2p.i2ptunnel.I2PTunnelClientBase
_clientId, _context, _executor, _log, _ownDest, DEFAULT_CONNECT_TIMEOUT, dest, l, listenerReady, mySockets, PROP_USE_SSL, sockLock, sockMgr, ss

Fields inherited from class net.i2p.i2ptunnel.I2PTunnelTask
open, tunnel

Constructor Summary

Constructors
Constructor and Description
`I2PTunnelHTTPClient(int localPort, Logging l, boolean ownDest, String wwwProxy, EventDispatcher notifyThis, I2PTunnel tunnel)` As of 0.9.20 this is fast, and does NOT connect the manager to the router, or open the local socket.
`I2PTunnelHTTPClient(int localPort, Logging l, I2PSocketManager sockMgr, I2PTunnel tunnel, EventDispatcher notifyThis, long clientId)` This constructor always starts the tunnel (ignoring the i2cp.delayOpen option).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`clientConnectionRun(Socket s)` Note: This does not handle RFC 2616 header line splitting, which is obsoleted in RFC 7230.
`boolean`	`close(boolean forced)` Overridden to close internal socket too.
`protected I2PSocketOptions`	`getDefaultOptions()` Create the default options (using the default timeout, etc).
`protected I2PSocketOptions`	`getDefaultOptions(Properties overrides)` Create the default options (using the default timeout, etc).
`protected String`	`getRealm()` Get the authentication realm string.
`void`	`startRunning()` Actually start working on incoming connections.

Methods inherited from class net.i2p.i2ptunnel.I2PTunnelHTTPClientBase
_t, _t, _t, authorize, decodeIDNHost, getAuthError, getErrorPage, getErrorPage, getPrefix, handleClientException, handleI2PSocketException, isDigestAuthRequired, noteProxyResult, optionsUpdated, selectProxy, selectSSLProxy, writeErrorMessage, writeErrorMessage, writeErrorMessage, writeErrorMessage, writeFooter, writeFooter

Methods inherited from class net.i2p.i2ptunnel.I2PTunnelClientBase
buildSocketManager, buildSocketManager, buildSocketManager, buildSocketManager, closeSocket, createI2PSocket, createI2PSocket, createI2PSocket, destroy, getListenHost, getLocalPort, getSocketManager, getSocketManager, getSocketManager, killSharedClient, manageConnection, run, verifySocketManager

Methods inherited from class net.i2p.i2ptunnel.I2PTunnelTask
connected, disconnected, errorOccurred, getBooleanOption, getId, getTunnel, isOpen, reportAbuse, routerDisconnected, setId, setName, setTunnel, toString

Methods inherited from class net.i2p.util.EventDispatcherImpl
attachEventDispatcher, detachEventDispatcher, getEventDispatcher, getEvents, getEventValue, ignoreEvents, notifyEvent, unIgnoreEvents, waitEventValue

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

Methods inherited from interface java.lang.Runnable
run

- Field Detail
  - AUTH_REALM
```
public static final String AUTH_REALM
```
    HTTP authentication realm for HTTP proxy.
    See Also:
    Constant Field Values
  - BROWSER_KEEPALIVE_TIMEOUT
```
static final int BROWSER_KEEPALIVE_TIMEOUT
```
    how long to wait for another request on the same socket
    See Also:
    Constant Field Values
  - DEFAULT_JUMP_SERVERS
```
public static final String DEFAULT_JUMP_SERVERS
```
    Default jump server URLs.
    See Also:
    Constant Field Values
  - LOCAL_SERVER
```
public static final String LOCAL_SERVER
```
    Local HTTP proxy server hostname.
    See Also:
    Constant Field Values
  - OPT_KEEPALIVE_BROWSER
```
public static final String OPT_KEEPALIVE_BROWSER
```
    Config key to enable browser-side keepalive.
    See Also:
    Constant Field Values
  - OPT_KEEPALIVE_I2P
```
public static final String OPT_KEEPALIVE_I2P
```
    Config key to enable I2P-side keepalive.
    See Also:
    Constant Field Values
  - PROP_ACCEPT
```
public static final String PROP_ACCEPT
```
    See Also:
    Constant Field Values
  - PROP_DISABLE_HELPER
```
public static final String PROP_DISABLE_HELPER
```
    Config key to disable address helper.
    See Also:
    Constant Field Values
  - PROP_INTERNAL_SSL
```
public static final String PROP_INTERNAL_SSL
```
    See Also:
    Constant Field Values
  - PROP_JUMP_SERVERS
```
public static final String PROP_JUMP_SERVERS
```
    Config key for jump server list.
    See Also:
    Constant Field Values
  - PROP_REFERER
```
public static final String PROP_REFERER
```
    all default to false
    See Also:
    Constant Field Values
  - PROP_SSL_SET
```
public static final String PROP_SSL_SET
```
    See Also:
    Constant Field Values
  - PROP_USER_AGENT
```
public static final String PROP_USER_AGENT
```
    Config key to enable sending User-Agent header.
    See Also:
    Constant Field Values
  - PROP_VIA
```
public static final String PROP_VIA
```
    Config key to enable sending Via header.
    See Also:
    Constant Field Values
- Constructor Detail
  - I2PTunnelHTTPClient
```
public I2PTunnelHTTPClient(int localPort,
                           Logging l,
                           boolean ownDest,
                           String wwwProxy,
                           EventDispatcher notifyThis,
                           I2PTunnel tunnel)
                    throws IllegalArgumentException
```
    As of 0.9.20 this is fast, and does NOT connect the manager to the router, or open the local socket. You MUST call startRunning() for that.
    Throws:
    IllegalArgumentException - if the I2PTunnel does not contain valid config to contact the router
  - I2PTunnelHTTPClient
```
public I2PTunnelHTTPClient(int localPort,
                           Logging l,
                           I2PSocketManager sockMgr,
                           I2PTunnel tunnel,
                           EventDispatcher notifyThis,
                           long clientId)
```
    This constructor always starts the tunnel (ignoring the i2cp.delayOpen option). It is used to add a client to an existing socket manager. As of 0.9.20 this is fast, and does NOT connect the manager to the router, or open the local socket. You MUST call startRunning() for that.
    Parameters:
    sockMgr - the existing socket manager
- Method Detail
  - clientConnectionRun
```
protected void clientConnectionRun(Socket s)
```
    Note: This does not handle RFC 2616 header line splitting, which is obsoleted in RFC 7230.
    Specified by:
    clientConnectionRun in class I2PTunnelClientBase
    Parameters:
    s - the socket to manage
  - close
```
public boolean close(boolean forced)
```
    Overridden to close internal socket too.
    Overrides:
    close in class I2PTunnelClientBase
    Returns:
    success
  - getDefaultOptions
```
protected I2PSocketOptions getDefaultOptions()
```
    Create the default options (using the default timeout, etc). Warning, this does not make a copy of I2PTunnel's client options, it modifies them directly. unused?
    Overrides:
    getDefaultOptions in class I2PTunnelClientBase
    Returns:
    the default options
  - getDefaultOptions
```
protected I2PSocketOptions getDefaultOptions(Properties overrides)
```
    Create the default options (using the default timeout, etc). Warning, this does not make a copy of I2PTunnel's client options, it modifies them directly. Do not use overrides for per-socket options.
    Overrides:
    getDefaultOptions in class I2PTunnelClientBase
    Parameters:
    overrides - the properties to override
    Returns:
    the default options
  - getRealm
```
protected String getRealm()
```
    Description copied from class: I2PTunnelHTTPClientBase
    Get the authentication realm string.
    Specified by:
    getRealm in class I2PTunnelHTTPClientBase
    Returns:
    realm string
  - startRunning
```
public void startRunning()
```
    Actually start working on incoming connections. Overridden to start an internal socket too.
    Overrides:
    startRunning in class I2PTunnelClientBase

Class I2PTunnelHTTPClient

Nested Class Summary

Nested classes/interfaces inherited from class net.i2p.i2ptunnel.I2PTunnelHTTPClientBase

Field Summary

Fields inherited from class net.i2p.i2ptunnel.I2PTunnelHTTPClientBase

Fields inherited from class net.i2p.i2ptunnel.I2PTunnelClientBase

Fields inherited from class net.i2p.i2ptunnel.I2PTunnelTask

Constructor Summary

Method Summary

Methods inherited from class net.i2p.i2ptunnel.I2PTunnelHTTPClientBase

Methods inherited from class net.i2p.i2ptunnel.I2PTunnelClientBase

Methods inherited from class net.i2p.i2ptunnel.I2PTunnelTask

Methods inherited from class net.i2p.util.EventDispatcherImpl

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Runnable

Field Detail

AUTH_REALM

BROWSER_KEEPALIVE_TIMEOUT

DEFAULT_JUMP_SERVERS

LOCAL_SERVER

OPT_KEEPALIVE_BROWSER

OPT_KEEPALIVE_I2P

PROP_ACCEPT

PROP_DISABLE_HELPER

PROP_INTERNAL_SSL

PROP_JUMP_SERVERS

PROP_REFERER

PROP_SSL_SET

PROP_USER_AGENT

PROP_VIA

Constructor Detail

I2PTunnelHTTPClient

I2PTunnelHTTPClient

Method Detail

clientConnectionRun

close

getDefaultOptions

getDefaultOptions

getRealm

startRunning