I2PTunnelHTTPClientBase (Javadocs [I2P+ 2.13.0+]

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

All Implemented Interfaces:
Runnable, EventDispatcher
Direct Known Subclasses:
I2PTunnelConnectClient, I2PTunnelHTTPClient
```
public abstract class I2PTunnelHTTPClientBase
extends I2PTunnelClientBase
implements Runnable
```
Common things for HTTPClient and ConnectClient Retrofit over them in 0.8.2

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`I2PTunnelHTTPClientBase.AuthResult` Authentication result status for HTTP client connections
`protected class`	`I2PTunnelHTTPClientBase.OnProxySuccess` Callback for successful proxy connections.
`protected class`	`I2PTunnelHTTPClientBase.OnTimeout` Callback for timeout events.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static AtomicLong`	`__requestId` Counter for unique request IDs
`protected List<String>`	`_proxyList` list of configured outproxies
`static String`	`BASIC_AUTH` Basic auth type constant
`protected static int`	`BROWSER_READ_TIMEOUT` Failsafe
`protected static int`	`DEFAULT_READ_TIMEOUT` -1 (forever) as of 0.9.36, so that large POSTs won't timeout on the read side
`static String`	`DIGEST_AUTH` Digest auth type constant
`protected static String`	`ERR_DESTINATION_UNKNOWN` error response when destination is not found
`protected static String`	`ERR_NO_OUTPROXY` error response when no outproxy is configured
`protected static int`	`INITIAL_SO_TIMEOUT` This is a standard soTimeout, not a total timeout.
`static String`	`PROP_AUTH` all auth
`static String`	`PROP_OUTPROXY_AUTH` Outproxy auth property
`static String`	`PROP_OUTPROXY_PW` Outproxy password property
`static String`	`PROP_OUTPROXY_PW_PREFIX` Outproxy password property prefix.
`static String`	`PROP_OUTPROXY_USER` Outproxy username property
`static String`	`PROP_OUTPROXY_USER_PREFIX` passwords for specific outproxies may be added with outproxyUsername.fooproxy.i2p=user and outproxyPassword.fooproxy.i2p=pw
`static String`	`PROP_PROXY_DIGEST_PREFIX` new style MD5 auth
`static String`	`PROP_PROXY_DIGEST_SHA256_SUFFIX` SHA-256 digest suffix
`static String`	`PROP_PROXY_DIGEST_SUFFIX` MD5 digest suffix
`static String`	`PROP_PW` Proxy password property
`static String`	`PROP_PW_PREFIX` additional users may be added with proxyPassword.user=pw
`static String`	`PROP_SSL_OUTPROXIES` Property for SSL outproxies.
`static String`	`PROP_USE_OUTPROXY_PLUGIN` Property to use local outproxy plugin.
`static String`	`PROP_USER` Proxy username property
`protected static String`	`SUCCESS_RESPONSE` HTTP 200 response for established CONNECT tunnels

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
`I2PTunnelHTTPClientBase(int localPort, boolean ownDest, Logging l, EventDispatcher notifyThis, String handlerName, I2PTunnel tunnel)` Create a new HTTP client tunnel.
`I2PTunnelHTTPClientBase(int localPort, Logging l, I2PSocketManager sktMgr, I2PTunnel tunnel, EventDispatcher notifyThis, long clientId)` This constructor always starts the tunnel (ignoring the i2cp.delayOpen option).

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected String`	`_t(String key)` Translate
`protected String`	`_t(String key, Object o)` Translate with one parameter {0}
`protected String`	`_t(String key, Object o, Object o2)` Translate with two parameters {0} and {1}
`protected I2PTunnelHTTPClientBase.AuthResult`	`authorize(Socket s, long requestId, String method, String authorization)` Authorization Ref: RFC 2617 If the socket is an InternalSocket, no auth required.
`static String`	`decodeIDNHost(String host)` Decode a hostname for display.
`protected String`	`getAuthError(boolean isStale)` What to send if digest auth fails
`protected static String`	`getErrorPage(I2PAppContext ctx, String base, String backup)` foo => errordir/foo-header_xx.ht for lang xx, or errordir/foo-header.ht, or the backup byte array on fail.
`protected String`	`getErrorPage(String base, String backup)` foo => errordir/foo-header_xx.ht for lang xx, or errordir/foo-header.ht, or the backup byte array on fail.
`protected String`	`getPrefix(long requestId)` Generates a unique log prefix for request tracking.
`protected abstract String`	`getRealm()` Get the authentication realm string.
`protected void`	`handleClientException(Exception ex, OutputStream out, String targetRequest, boolean usingWWWProxy, String wwwProxy, long requestId)` Handle an exception from a client connection.
`protected void`	`handleI2PSocketException(I2PSocketException ise, OutputStream out, String targetRequest, boolean usingWWWProxy, String wwwProxy)` Generate an error page based on the status code in our custom exception.
`protected boolean`	`isDigestAuthRequired()` Checks if HTTP Digest authentication is required by the outproxy.
`protected void`	`noteProxyResult(String proxy, String host, boolean isSSL, boolean ok)` Update the cache and note if failed.
`void`	`optionsUpdated(I2PTunnel tunnel)` Update the outproxy list then call super.
`protected String`	`selectProxy(String host)` Selects an appropriate outproxy for the given host from the proxy pool.
`protected String`	`selectSSLProxy(String host)` Selects an SSL-capable outproxy for HTTPS connections.
`protected void`	`writeErrorMessage(String errMessage, OutputStream out, String targetRequest, boolean usingWWWProxy, String wwwProxy)` No jump servers or extra message
`protected void`	`writeErrorMessage(String errMessage, OutputStream out, String targetRequest, boolean usingWWWProxy, String wwwProxy, String jumpServers)` No extra message
`protected void`	`writeErrorMessage(String errMessage, String extraMessage, OutputStream out, String targetRequest, boolean usingWWWProxy, String wwwProxy)` No jump servers
`protected void`	`writeErrorMessage(String errMessage, String extraMessage, OutputStream outs, String targetRequest, boolean usingWWWProxy, String wwwProxy, String jumpServers)` Write the complete error message to the output stream.
`static void`	`writeFooter(OutputStream out)` Flushes.
`static void`	`writeFooter(Writer out)` Flushes.

Methods inherited from class net.i2p.i2ptunnel.I2PTunnelClientBase
buildSocketManager, buildSocketManager, buildSocketManager, buildSocketManager, clientConnectionRun, close, closeSocket, createI2PSocket, createI2PSocket, createI2PSocket, destroy, getDefaultOptions, getDefaultOptions, getListenHost, getLocalPort, getSocketManager, getSocketManager, getSocketManager, killSharedClient, manageConnection, run, startRunning, 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
  - __requestId
```
protected static final AtomicLong __requestId
```
    Counter for unique request IDs
  - _proxyList
```
protected final List<String> _proxyList
```
    list of configured outproxies
  - BASIC_AUTH
```
public static final String BASIC_AUTH
```
    Basic auth type constant
    See Also:
    Constant Field Values
  - BROWSER_READ_TIMEOUT
```
protected static final int BROWSER_READ_TIMEOUT
```
    Failsafe
    See Also:
    Constant Field Values
  - DEFAULT_READ_TIMEOUT
```
protected static final int DEFAULT_READ_TIMEOUT
```
    -1 (forever) as of 0.9.36, so that large POSTs won't timeout on the read side
    See Also:
    Constant Field Values
  - DIGEST_AUTH
```
public static final String DIGEST_AUTH
```
    Digest auth type constant
    See Also:
    Constant Field Values
  - ERR_DESTINATION_UNKNOWN
```
protected static final String ERR_DESTINATION_UNKNOWN
```
    error response when destination is not found
    See Also:
    Constant Field Values
  - ERR_NO_OUTPROXY
```
protected static final String ERR_NO_OUTPROXY
```
    error response when no outproxy is configured
    See Also:
    Constant Field Values
  - INITIAL_SO_TIMEOUT
```
protected static final int INITIAL_SO_TIMEOUT
```
    This is a standard soTimeout, not a total timeout. We have no slowloris protection on the client side. See I2PTunnelHTTPServer or SAM's ReadLine if we need that.
    See Also:
    Constant Field Values
  - PROP_AUTH
```
public static final String PROP_AUTH
```
    all auth
    See Also:
    Constant Field Values
  - PROP_OUTPROXY_AUTH
```
public static final String PROP_OUTPROXY_AUTH
```
    Outproxy auth property
    See Also:
    Constant Field Values
  - PROP_OUTPROXY_PW
```
public static final String PROP_OUTPROXY_PW
```
    Outproxy password property
    See Also:
    Constant Field Values
  - PROP_OUTPROXY_PW_PREFIX
```
public static final String PROP_OUTPROXY_PW_PREFIX
```
    Outproxy password property prefix.
    See Also:
    Constant Field Values
  - PROP_OUTPROXY_USER
```
public static final String PROP_OUTPROXY_USER
```
    Outproxy username property
    See Also:
    Constant Field Values
  - PROP_OUTPROXY_USER_PREFIX
```
public static final String PROP_OUTPROXY_USER_PREFIX
```
    passwords for specific outproxies may be added with outproxyUsername.fooproxy.i2p=user and outproxyPassword.fooproxy.i2p=pw
    See Also:
    Constant Field Values
  - PROP_PROXY_DIGEST_PREFIX
```
public static final String PROP_PROXY_DIGEST_PREFIX
```
    new style MD5 auth
    See Also:
    Constant Field Values
  - PROP_PROXY_DIGEST_SHA256_SUFFIX
```
public static final String PROP_PROXY_DIGEST_SHA256_SUFFIX
```
    SHA-256 digest suffix
    See Also:
    Constant Field Values
  - PROP_PROXY_DIGEST_SUFFIX
```
public static final String PROP_PROXY_DIGEST_SUFFIX
```
    MD5 digest suffix
    See Also:
    Constant Field Values
  - PROP_PW
```
public static final String PROP_PW
```
    Proxy password property
    See Also:
    Constant Field Values
  - PROP_PW_PREFIX
```
public static final String PROP_PW_PREFIX
```
    additional users may be added with proxyPassword.user=pw
    See Also:
    Constant Field Values
  - PROP_SSL_OUTPROXIES
```
public static final String PROP_SSL_OUTPROXIES
```
    Property for SSL outproxies.
    See Also:
    Constant Field Values
  - PROP_USE_OUTPROXY_PLUGIN
```
public static final String PROP_USE_OUTPROXY_PLUGIN
```
    Property to use local outproxy plugin.
    See Also:
    Constant Field Values
  - PROP_USER
```
public static final String PROP_USER
```
    Proxy username property
    See Also:
    Constant Field Values
  - SUCCESS_RESPONSE
```
protected static final String SUCCESS_RESPONSE
```
    HTTP 200 response for established CONNECT tunnels
    See Also:
    Constant Field Values
- Constructor Detail
  - I2PTunnelHTTPClientBase
```
public I2PTunnelHTTPClientBase(int localPort,
                               boolean ownDest,
                               Logging l,
                               EventDispatcher notifyThis,
                               String handlerName,
                               I2PTunnel tunnel)
                        throws IllegalArgumentException
```
    Create a new HTTP client tunnel.
    Parameters:
    localPort - the local port to bind to
    ownDest - whether to use our own destination
    l - logging instance
    notifyThis - event dispatcher for notifications
    handlerName - the handler name
    tunnel - the parent I2PTunnel instance
    Throws:
    IllegalArgumentException
  - I2PTunnelHTTPClientBase
```
public I2PTunnelHTTPClientBase(int localPort,
                               Logging l,
                               I2PSocketManager sktMgr,
                               I2PTunnel tunnel,
                               EventDispatcher notifyThis,
                               long clientId)
                        throws IllegalArgumentException
```
    This constructor always starts the tunnel (ignoring the i2cp.delayOpen option). It is used to add a client to an existing socket manager.
    Parameters:
    localPort - the local port to bind to
    l - logging instance
    sktMgr - the existing socket manager
    tunnel - the parent I2PTunnel instance
    notifyThis - event dispatcher for notifications
    clientId - the client identifier
    Throws:
    IllegalArgumentException
- Method Detail
  - _t
```
protected String _t(String key)
```
    Translate
    Parameters:
    key - the translation key
    Returns:
    the translated string
  - _t
```
protected String _t(String key,
                    Object o)
```
    Translate with one parameter {0}
    Parameters:
    key - the translation key
    o - the parameter to insert
    Returns:
    the translated string
  - _t
```
protected String _t(String key,
                    Object o,
                    Object o2)
```
    Translate with two parameters {0} and {1}
    Parameters:
    key - the translation key
    o - the first parameter to insert
    o2 - the second parameter to insert
    Returns:
    the translated string
  - authorize
```
protected I2PTunnelHTTPClientBase.AuthResult authorize(Socket s,
                                                       long requestId,
                                                       String method,
                                                       String authorization)
```
    Authorization Ref: RFC 2617 If the socket is an InternalSocket, no auth required.
    Parameters:
    s - the client socket
    requestId - the unique request identifier for logging
    method - GET, POST, etc.
    authorization - may be null, the full auth line e.g. "Basic lskjlksjf"
    Returns:
    success
  - decodeIDNHost
```
public static String decodeIDNHost(String host)
```
    Decode a hostname for display. Returns original string on any error.
    Parameters:
    host - the hostname to decode
    Returns:
    the decoded hostname, or the original on error
  - getAuthError
```
protected String getAuthError(boolean isStale)
```
    What to send if digest auth fails
    Parameters:
    isStale - true if the previous nonce was stale
    Returns:
    the HTTP error response string
  - getErrorPage
```
protected static String getErrorPage(I2PAppContext ctx,
                                     String base,
                                     String backup)
```
    foo => errordir/foo-header_xx.ht for lang xx, or errordir/foo-header.ht, or the backup byte array on fail. .ht files must be UTF-8 encoded and use \r\n terminators so the HTTP headers are conformant. We can't use FileUtil.readFile() because it strips \r
    Parameters:
    ctx - the I2P application context
    base - the error page base name
    backup - fallback string if the file cannot be read
    Returns:
    non-null
  - getErrorPage
```
protected String getErrorPage(String base,
                              String backup)
```
    foo => errordir/foo-header_xx.ht for lang xx, or errordir/foo-header.ht, or the backup byte array on fail. .ht files must be UTF-8 encoded and use \r\n terminators so the HTTP headers are conformant. We can't use FileUtil.readFile() because it strips \r
    Parameters:
    base - the error page base name
    backup - fallback string if the file cannot be read
    Returns:
    non-null
  - getPrefix
```
protected String getPrefix(long requestId)
```
    Generates a unique log prefix for request tracking.
    This method creates a consistent prefix string that includes the request ID for correlating log entries across multiple threads and connections.
    Parameters:
    requestId - the unique identifier for this request
    Returns:
    a formatted string suitable for logging
  - getRealm
```
protected abstract String getRealm()
```
    Get the authentication realm string.
    Returns:
    realm string
  - handleClientException
```
protected void handleClientException(Exception ex,
                                     OutputStream out,
                                     String targetRequest,
                                     boolean usingWWWProxy,
                                     String wwwProxy,
                                     long requestId)
```
    Handle an exception from a client connection.
    Parameters:
    ex - may be null
    out - the output stream for the error response
    targetRequest - the original request URI
    usingWWWProxy - whether a WWW outproxy is in use
    wwwProxy - the outproxy destination
    requestId - the request identifier for logging
  - handleI2PSocketException
```
protected void handleI2PSocketException(I2PSocketException ise,
                                        OutputStream out,
                                        String targetRequest,
                                        boolean usingWWWProxy,
                                        String wwwProxy)
```
    Generate an error page based on the status code in our custom exception.
    Parameters:
    ise - may be null
    out - the output stream for the error response
    targetRequest - the original request URI
    usingWWWProxy - whether a WWW outproxy is in use
    wwwProxy - the outproxy destination
  - isDigestAuthRequired
```
protected boolean isDigestAuthRequired()
```
    Checks if HTTP Digest authentication is required by the outproxy.
    This method checks the configured authentication requirements and determines whether the current request requires digest authentication.
    Returns:
    true if digest authentication is required, false otherwise
  - noteProxyResult
```
protected void noteProxyResult(String proxy,
                               String host,
                               boolean isSSL,
                               boolean ok)
```
    Update the cache and note if failed.
    Parameters:
    proxy - which
    host - clearnet hostname targeted
    isSSL - set to FALSE for ConnectClient
    ok - success or failure
  - optionsUpdated
```
public void optionsUpdated(I2PTunnel tunnel)
```
    Update the outproxy list then call super.
    Overrides:
    optionsUpdated in class I2PTunnelClientBase
  - selectProxy
```
protected String selectProxy(String host)
```
    Selects an appropriate outproxy for the given host from the proxy pool.
    This method implements load balancing across multiple configured outproxies. It uses a simple round-robin or hash-based selection to distribute requests evenly across the available proxies. Failed proxies are remembered and temporarily skipped.
    Parameters:
    host - the target hostname to route through the outproxy (may be used for stickiness)
    Returns:
    the selected proxy destination string (Base32 address), or null if no proxies configured
    See Also:
    _proxyList
  - selectSSLProxy
```
protected String selectSSLProxy(String host)
```
    Selects an SSL-capable outproxy for HTTPS connections.
    This method is similar to selectProxy() but only considers outproxies configured for SSL support (via i2ptunnel.httpclient.SSLOutproxies).
    Unlike selectProxy(), we parse the option on the fly so it can be changed without restart. ConnectClient should use selectProxy().
    Parameters:
    host - the target hostname (may be used for proxy stickiness)
    Returns:
    the selected SSL proxy destination, or null if none configured
    See Also:
    selectProxy(String)
  - writeErrorMessage
```
protected void writeErrorMessage(String errMessage,
                                 OutputStream out,
                                 String targetRequest,
                                 boolean usingWWWProxy,
                                 String wwwProxy)
                          throws IOException
```
    No jump servers or extra message
    Parameters:
    errMessage - the error header
    out - the output stream
    targetRequest - the original request URI
    usingWWWProxy - whether a WWW outproxy is in use
    wwwProxy - the outproxy destination
    Throws:
    IOException - on write error
  - writeErrorMessage
```
protected void writeErrorMessage(String errMessage,
                                 OutputStream out,
                                 String targetRequest,
                                 boolean usingWWWProxy,
                                 String wwwProxy,
                                 String jumpServers)
                          throws IOException
```
    No extra message
    Parameters:
    errMessage - the error header
    out - the output stream
    targetRequest - the original request URI
    usingWWWProxy - whether a WWW outproxy is in use
    wwwProxy - the outproxy destination
    jumpServers - comma- or space-separated list, or null
    Throws:
    IOException - on write error
  - writeErrorMessage
```
protected void writeErrorMessage(String errMessage,
                                 String extraMessage,
                                 OutputStream out,
                                 String targetRequest,
                                 boolean usingWWWProxy,
                                 String wwwProxy)
                          throws IOException
```
    No jump servers
    Parameters:
    errMessage - the error header
    extraMessage - extra message or null, will be HTML-escaped
    out - the output stream
    targetRequest - the original request URI
    usingWWWProxy - whether a WWW outproxy is in use
    wwwProxy - the outproxy destination
    Throws:
    IOException - on write error
  - writeErrorMessage
```
protected void writeErrorMessage(String errMessage,
                                 String extraMessage,
                                 OutputStream outs,
                                 String targetRequest,
                                 boolean usingWWWProxy,
                                 String wwwProxy,
                                 String jumpServers)
                          throws IOException
```
    Write the complete error message to the output stream.
    Parameters:
    errMessage - the error header
    extraMessage - extra message or null, will be HTML-escaped
    outs - the output stream
    targetRequest - the original request URI
    usingWWWProxy - whether a WWW outproxy is in use
    wwwProxy - the outproxy destination
    jumpServers - comma- or space-separated list, or null
    Throws:
    IOException - on write error
  - writeFooter
```
public static void writeFooter(OutputStream out)
                        throws IOException
```
    Flushes. Public only for LocalHTTPServer, not for general use
    Parameters:
    out - the output stream to write to
    Throws:
    IOException - on write error
  - writeFooter
```
public static void writeFooter(Writer out)
                        throws IOException
```
    Flushes. Public only for LocalHTTPServer, not for general use
    Parameters:
    out - the writer to write to
    Throws:
    IOException - on write error

Class I2PTunnelHTTPClientBase

Nested Class Summary

Field Summary

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

__requestId

_proxyList

BASIC_AUTH

BROWSER_READ_TIMEOUT

DEFAULT_READ_TIMEOUT

DIGEST_AUTH

ERR_DESTINATION_UNKNOWN

ERR_NO_OUTPROXY

INITIAL_SO_TIMEOUT

PROP_AUTH

PROP_OUTPROXY_AUTH

PROP_OUTPROXY_PW

PROP_OUTPROXY_PW_PREFIX

PROP_OUTPROXY_USER

PROP_OUTPROXY_USER_PREFIX

PROP_PROXY_DIGEST_PREFIX

PROP_PROXY_DIGEST_SHA256_SUFFIX

PROP_PROXY_DIGEST_SUFFIX

PROP_PW

PROP_PW_PREFIX

PROP_SSL_OUTPROXIES

PROP_USE_OUTPROXY_PLUGIN

PROP_USER

SUCCESS_RESPONSE

Constructor Detail

I2PTunnelHTTPClientBase

I2PTunnelHTTPClientBase

Method Detail

_t

_t

_t

authorize

decodeIDNHost

getAuthError

getErrorPage

getErrorPage

getPrefix

getRealm

handleClientException

handleI2PSocketException

isDigestAuthRequired

noteProxyResult

optionsUpdated

selectProxy

selectSSLProxy

writeErrorMessage

writeErrorMessage

writeErrorMessage

writeErrorMessage

writeFooter

writeFooter