EepGet (Javadocs [I2P+ 2.13.0+] - API Version 0.9.70+)

java.lang.Object
- net.i2p.util.EepGet

Direct Known Subclasses:
EepHead, EepPost, I2PSocketEepGet, PartialEepGet, SSLEepGet
```
public class EepGet
extends Object
```
EepGet [-p 127.0.0.1:4444] [-n #retries] [-o outputFile] [-m markSize lineLen] url

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`EepGet.AUTH_MODE` Authentication mode enumeration.
`protected class`	`EepGet.AuthState` Manage the authentication parameters Ref: RFC 2617 Supports both Basic and Digest, however i2ptunnel HTTP proxy has migrated all previous Basic support to Digest.
`protected class`	`EepGet.CLIStatusListener` CLIStatusListener.
`protected class`	`EepGet.Gunzipper` Decompressor thread.
`static interface`	`EepGet.StatusListener` Callback interface for monitoring EepGet transfer progress.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`_aborted` Whether the fetch was aborted due to timeout or user request
`protected String`	`_acceptRanges` Accept-Ranges header value from the response
`protected String`	`_actualURL` The URL we actually fetch from (may differ from _url in case of redirect)
`protected long`	`_alreadyTransferred` Total bytes transferred across all attempts, including resumed content
`protected EepGet.AuthState`	`_authState` Authentication state for proxy digest/basic auth; created via addAuthorization()
`protected long`	`_bytesRemaining` Remaining bytes on the current attempt, -1 if unknown (chunked or no Content-Length)
`protected long`	`_bytesTransferred` Total bytes transferred including headers, retries, redirects, and discarded partial downloads
`protected String`	`_cacheControl` Cache-Control header value from the response
`protected String`	`_contentEncoding` Content-Encoding header value from the response
`protected String`	`_contentLanguage` Content-Language header value from the response
`protected String`	`_contentType` Content-Type header value from the response
`protected I2PAppContext`	`_context` I2P application context for configuration, logging, and random number generation
`protected String`	`_cookie` Set-Cookie header value from the response
`protected String`	`_csp` Content-Security-Policy header value from the response
`protected int`	`_currentAttempt` Zero-based attempt counter for the current fetch
`protected IOException`	`_decompressException` IOException from the background decompressor thread, if any
`protected boolean`	`_encodingChunked` Whether the response is using chunked transfer encoding
`protected String`	`_etag` ETag received from the server (for conditional requests)
`protected String`	`_etagOrig` Original ETag passed in constructor, preserved across redirects
`protected String`	`_expiryDate` Expires header value from the response
`protected List<String>`	`_extraHeaders` Additional HTTP headers to include in the request
`protected int`	`_fetchHeaderTimeout` Timeout in ms for receiving the HTTP response headers
`protected int`	`_fetchInactivityTimeout` Inactivity timeout in ms between data packets
`protected int`	`_fetchTotalTimeout` Total timeout in ms for the entire fetch operation
`protected boolean`	`_isGzippedResponse` Whether the response body is gzip-compressed
`protected boolean`	`_keepFetching` Whether to continue fetching; set false to abort
`protected String`	`_lastModified` Last-Modified header received from the server
`protected String`	`_lastModifiedOrig` Original Last-Modified passed in constructor, preserved across redirects
`protected List<EepGet.StatusListener>`	`_listeners` Registered status listeners for progress callbacks
`protected Log`	`_log` Logger for this instance
`protected int`	`_maxCompleteFails` Maximum number of complete (zero-byte) failures before giving up
`protected boolean`	`_notModified` Whether the server returned 304 Not Modified
`protected int`	`_numRetries` Maximum number of retry attempts per fetch
`protected OutputStream`	`_out` Output stream for writing fetched data (file or pipe)
`protected String`	`_outputFile` Path to the output file for saving the fetched content
`protected OutputStream`	`_outputStream` Output stream destination, overrides outputFile when non-null
`protected Socket`	`_proxy` The socket connection to the proxy or the target server (if not proxied).
`protected String`	`_proxyHost` Proxy hostname or IP address
`protected InputStream`	`_proxyIn` Input stream from the proxy/server socket
`protected OutputStream`	`_proxyOut` Output stream to the proxy/server socket
`protected int`	`_proxyPort` Proxy port number
`protected String`	`_redirectLocation` Location header value from redirect or 407 proxy auth response
`protected AtomicInteger`	`_redirects` Counter tracking the number of HTTP redirects followed
`protected String`	`_referrerPolicy` Referrer-Policy header value from the response
`protected int`	`_responseCode` HTTP response status code, -1 if no response received
`protected String`	`_responseText` HTTP response status text (e.g.
`protected String`	`_server` Server header value from the response
`protected boolean`	`_shouldProxy` Whether to route requests through an HTTP proxy
`protected boolean`	`_shouldWriteErrorToOutput` Whether to write error response bodies to the output
`protected String`	`_status` Status header value from the response
`protected String`	`_transferEncoding` Transfer-Encoding header value from the response
`protected boolean`	`_transferFailed` Whether the current transfer attempt failed (non-2xx response code)
`protected String`	`_url` The URL we were asked to fetch
`protected String`	`_vary` Vary header value from the response
`protected String`	`_xContentTypeOptions` X-Content-Type-Options header value from the response
`protected String`	`_xframeOptions` X-Frame-Options header value from the response
`protected String`	`_xPoweredBy` X-Powered-By header value from the response
`protected String`	`_xssProtection` X-XSS-Protection header value from the response
`protected static int`	`DEFAULT_CONNECT_TIMEOUT` Default connect timeout in milliseconds (90 seconds)
`protected static int`	`DEFAULT_INACTIVITY_TIMEOUT` Default inactivity timeout in milliseconds (5 minutes)
`protected static int`	`DEFAULT_MAX_COMPLETE_FAILS` Maximum times to try without getting any data at all, even if numRetries is higher @since 0.7.14
`protected static int`	`DEFAULT_NUM_RETRIES` Default number of retry attempts
`(package private) static String`	`PROP_CONNECT_TIMEOUT` Property name for connect timeout configuration
`(package private) static String`	`PROP_DEFAULT_RETRIES` Property name for default retries configuration
`(package private) static String`	`PROP_INACTIVITY_TIMEOUT` Property name for inactivity timeout configuration
`(package private) static String`	`PROP_MAX_COMPLETE_FAILS` Property name for max complete fails configuration
`protected static String`	`USER_AGENT` Default User-Agent header value.

Constructor Summary

Constructors
Constructor and Description
`EepGet(I2PAppContext ctx, boolean shouldProxy, String proxyHost, int proxyPort, int numRetries, long minSize, long maxSize, String outputFile, OutputStream outputStream, String url, boolean allowCaching, String etag, String postData)` Creates a new EepGet instance with size limits, output stream, and POST data.
`EepGet(I2PAppContext ctx, boolean shouldProxy, String proxyHost, int proxyPort, int numRetries, long minSize, long maxSize, String outputFile, OutputStream outputStream, String url, boolean allowCaching, String etag, String lastModified, String postData)` Full constructor for EepGet with all parameters.
`EepGet(I2PAppContext ctx, boolean shouldProxy, String proxyHost, int proxyPort, int numRetries, String outputFile, String url)` Creates a new EepGet instance with explicit proxy control, defaulting to allow caching.
`EepGet(I2PAppContext ctx, boolean shouldProxy, String proxyHost, int proxyPort, int numRetries, String outputFile, String url, boolean allowCaching, String etag)` Creates a new EepGet instance with conditional fetch via ETag.
`EepGet(I2PAppContext ctx, boolean shouldProxy, String proxyHost, int proxyPort, int numRetries, String outputFile, String url, boolean allowCaching, String etag, String lastModified)` Creates a new EepGet instance with conditional fetch via ETag and Last-Modified.
`EepGet(I2PAppContext ctx, boolean shouldProxy, String proxyHost, int proxyPort, int numRetries, String outputFile, String url, String postData)` Creates a new EepGet instance with POST data support.
`EepGet(I2PAppContext ctx, int numRetries, String outputFile, String url)` Creates a new EepGet instance without a proxy, defaulting to allow caching.
`EepGet(I2PAppContext ctx, int numRetries, String outputFile, String url, boolean allowCaching)` Creates a new EepGet instance without a proxy, with configurable caching.
`EepGet(I2PAppContext ctx, String proxyHost, int proxyPort, int numRetries, String outputFile, String url)` Creates a new EepGet instance with proxy support, defaulting to allow caching.
`EepGet(I2PAppContext ctx, String proxyHost, int proxyPort, int numRetries, String outputFile, String url, boolean allowCaching)` Creates a new EepGet instance with proxy support and configurable caching.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAuthorization(String userName, String password)` Add basic authorization header for the proxy.
`void`	`addHeader(String name, String value)` Add an extra header to the request.
`void`	`addStatusListener(EepGet.StatusListener lsnr)` Add a status listener.
`protected void`	`doFetch(SocketTimeout timeout)` Read response body for a single fetch.
`boolean`	`fetch()` Blocking fetch, returning true if the URL was retrieved, false if all retries failed.
`boolean`	`fetch(long fetchHeaderTimeout)` Blocking fetch, timing out individual attempts if the HTTP response headers don't come back in the time given.
`boolean`	`fetch(long fetchHeaderTimeout, long totalTimeout, long inactivityTimeout)` Blocking fetch.
`String`	`getAcceptRanges()` Show the Accept-Ranges field
`String`	`getCacheControl()` Show the Cache-Control field
`String`	`getContentEncoding()` Show the Content-Encoding field
`String`	`getContentLanguage()` Show the Content-Language field
`String`	`getContentType()` After fetch, the received value from the server, or null if none.
`String`	`getCookie()` Show the Set-Cookie field
`String`	`getCSP()` Content-Security-Policy header.
`String`	`getEtag()` After fetch, the received value from the server, or null if none.
`String`	`getExpiryDate()` Show the Expires field
`String`	`getLastModified()` After fetch, the received value from the server, or null if none.
`boolean`	`getNotModified()` Whether the server returned 304.
`String`	`getReferrerPolicy()` Referrer-Policy header.
`protected String`	`getRequest()` Build the HTTP request string for the current URL and state.
`String`	`getServer()` Show the Server field
`String`	`getStatus()` Combined server status message e.g.
`int`	`getStatusCode()` The server response (200, etc).
`String`	`getStatusText()` The server text ("OK", "Not Found", etc).
`String`	`getTransferEncoding()` Show the Transfer-Encoding field
`String`	`getVary()` Vary header.
`String`	`getXContentTypeOptions()` X-Content-Type-Options header.
`String`	`getXframeOptions()` X-Frame-Options header.
`String`	`getXPoweredBy()` X-Powered-By header.
`String`	`getXSSProtection()` X-XSS-Protection header.
`static void`	`main(String[] args)` Command-line entry point for EepGet.
`static Map<String,String>`	`parseAuthArgs(String args)` Parse the args in an authentication header.
`protected long`	`readChunkLength()` Parse a chunk length from the HTTP response stream.
`protected void`	`readHeaders()` Read and parse HTTP response headers.
`protected void`	`sendRequest(SocketTimeout timeout)` Open connection and send HTTP request.
`protected void`	`setPostData(String contentType, byte[] data)` Set post data (binary body).
`protected void`	`setPostData(String contentType, File data)` Set post data (file body).
`protected void`	`setPostData(String contentType, String data)` Set post data (string body).
`void`	`setWriteErrorToOutput()` If called (before calling fetch()), data from the server or proxy will be written to the output file or stream even on an error response code (4xx, 5xx, etc).
`protected boolean`	`shouldReadBody()` Whether to read the response body.
`void`	`stopFetching()` Stop the fetch in progress.
`static String`	`suggestName(String url)` Parse URL for a viable filename.

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

- Field Detail
  - _aborted
```
protected volatile boolean _aborted
```
    Whether the fetch was aborted due to timeout or user request
  - _acceptRanges
```
protected String _acceptRanges
```
    Accept-Ranges header value from the response
  - _actualURL
```
protected String _actualURL
```
    The URL we actually fetch from (may differ from _url in case of redirect)
  - _alreadyTransferred
```
protected long _alreadyTransferred
```
    Total bytes transferred across all attempts, including resumed content
  - _authState
```
protected EepGet.AuthState _authState
```
    Authentication state for proxy digest/basic auth; created via addAuthorization()
  - _bytesRemaining
```
protected long _bytesRemaining
```
    Remaining bytes on the current attempt, -1 if unknown (chunked or no Content-Length)
  - _bytesTransferred
```
protected long _bytesTransferred
```
    Total bytes transferred including headers, retries, redirects, and discarded partial downloads
  - _cacheControl
```
protected String _cacheControl
```
    Cache-Control header value from the response
  - _contentEncoding
```
protected String _contentEncoding
```
    Content-Encoding header value from the response
  - _contentLanguage
```
protected String _contentLanguage
```
    Content-Language header value from the response
  - _contentType
```
protected String _contentType
```
    Content-Type header value from the response
  - _context
```
protected final I2PAppContext _context
```
    I2P application context for configuration, logging, and random number generation
  - _cookie
```
protected String _cookie
```
    Set-Cookie header value from the response
  - _csp
```
protected String _csp
```
    Content-Security-Policy header value from the response
  - _currentAttempt
```
protected int _currentAttempt
```
    Zero-based attempt counter for the current fetch
  - _decompressException
```
protected IOException _decompressException
```
    IOException from the background decompressor thread, if any
  - _encodingChunked
```
protected volatile boolean _encodingChunked
```
    Whether the response is using chunked transfer encoding
  - _etag
```
protected String _etag
```
    ETag received from the server (for conditional requests)
  - _etagOrig
```
protected final String _etagOrig
```
    Original ETag passed in constructor, preserved across redirects
  - _expiryDate
```
protected String _expiryDate
```
    Expires header value from the response
  - _extraHeaders
```
protected List<String> _extraHeaders
```
    Additional HTTP headers to include in the request
  - _fetchHeaderTimeout
```
protected volatile int _fetchHeaderTimeout
```
    Timeout in ms for receiving the HTTP response headers
  - _fetchInactivityTimeout
```
protected volatile int _fetchInactivityTimeout
```
    Inactivity timeout in ms between data packets
  - _fetchTotalTimeout
```
protected volatile int _fetchTotalTimeout
```
    Total timeout in ms for the entire fetch operation
  - _isGzippedResponse
```
protected boolean _isGzippedResponse
```
    Whether the response body is gzip-compressed
  - _keepFetching
```
protected volatile boolean _keepFetching
```
    Whether to continue fetching; set false to abort
  - _lastModified
```
protected String _lastModified
```
    Last-Modified header received from the server
  - _lastModifiedOrig
```
protected final String _lastModifiedOrig
```
    Original Last-Modified passed in constructor, preserved across redirects
  - _listeners
```
protected final List<EepGet.StatusListener> _listeners
```
    Registered status listeners for progress callbacks
  - _log
```
protected final Log _log
```
    Logger for this instance
  - _maxCompleteFails
```
protected volatile int _maxCompleteFails
```
    Maximum number of complete (zero-byte) failures before giving up
  - _notModified
```
protected volatile boolean _notModified
```
    Whether the server returned 304 Not Modified
  - _numRetries
```
protected final int _numRetries
```
    Maximum number of retry attempts per fetch
  - _out
```
protected OutputStream _out
```
    Output stream for writing fetched data (file or pipe)
  - _outputFile
```
protected final String _outputFile
```
    Path to the output file for saving the fetched content
  - _outputStream
```
protected final OutputStream _outputStream
```
    Output stream destination, overrides outputFile when non-null
  - _proxy
```
protected Socket _proxy
```
    The socket connection to the proxy or the target server (if not proxied). Warning - null when extended by I2PSocketEepGet
  - _proxyHost
```
protected final String _proxyHost
```
    Proxy hostname or IP address
  - _proxyIn
```
protected InputStream _proxyIn
```
    Input stream from the proxy/server socket
  - _proxyOut
```
protected OutputStream _proxyOut
```
    Output stream to the proxy/server socket
  - _proxyPort
```
protected final int _proxyPort
```
    Proxy port number
  - _redirectLocation
```
protected String _redirectLocation
```
    Location header value from redirect or 407 proxy auth response
  - _redirects
```
protected AtomicInteger _redirects
```
    Counter tracking the number of HTTP redirects followed
  - _referrerPolicy
```
protected String _referrerPolicy
```
    Referrer-Policy header value from the response
  - _responseCode
```
protected volatile int _responseCode
```
    HTTP response status code, -1 if no response received
  - _responseText
```
protected String _responseText
```
    HTTP response status text (e.g. "OK", "Not Found")
  - _server
```
protected String _server
```
    Server header value from the response
  - _shouldProxy
```
protected final boolean _shouldProxy
```
    Whether to route requests through an HTTP proxy
  - _shouldWriteErrorToOutput
```
protected volatile boolean _shouldWriteErrorToOutput
```
    Whether to write error response bodies to the output
  - _status
```
protected String _status
```
    Status header value from the response
  - _transferEncoding
```
protected String _transferEncoding
```
    Transfer-Encoding header value from the response
  - _transferFailed
```
protected volatile boolean _transferFailed
```
    Whether the current transfer attempt failed (non-2xx response code)
  - _url
```
protected final String _url
```
    The URL we were asked to fetch
  - _vary
```
protected String _vary
```
    Vary header value from the response
  - _xContentTypeOptions
```
protected String _xContentTypeOptions
```
    X-Content-Type-Options header value from the response
  - _xframeOptions
```
protected String _xframeOptions
```
    X-Frame-Options header value from the response
  - _xPoweredBy
```
protected String _xPoweredBy
```
    X-Powered-By header value from the response
  - _xssProtection
```
protected String _xssProtection
```
    X-XSS-Protection header value from the response
  - DEFAULT_CONNECT_TIMEOUT
```
protected static final int DEFAULT_CONNECT_TIMEOUT
```
    Default connect timeout in milliseconds (90 seconds)
    See Also:
    Constant Field Values
  - DEFAULT_INACTIVITY_TIMEOUT
```
protected static final int DEFAULT_INACTIVITY_TIMEOUT
```
    Default inactivity timeout in milliseconds (5 minutes)
    See Also:
    Constant Field Values
  - DEFAULT_MAX_COMPLETE_FAILS
```
protected static final int DEFAULT_MAX_COMPLETE_FAILS
```
    Maximum times to try without getting any data at all, even if numRetries is higher @since 0.7.14
    See Also:
    Constant Field Values
  - DEFAULT_NUM_RETRIES
```
protected static final int DEFAULT_NUM_RETRIES
```
    Default number of retry attempts
    See Also:
    Constant Field Values
  - PROP_CONNECT_TIMEOUT
```
static final String PROP_CONNECT_TIMEOUT
```
    Property name for connect timeout configuration
    See Also:
    Constant Field Values
  - PROP_DEFAULT_RETRIES
```
static final String PROP_DEFAULT_RETRIES
```
    Property name for default retries configuration
    See Also:
    Constant Field Values
  - PROP_INACTIVITY_TIMEOUT
```
static final String PROP_INACTIVITY_TIMEOUT
```
    Property name for inactivity timeout configuration
    See Also:
    Constant Field Values
  - PROP_MAX_COMPLETE_FAILS
```
static final String PROP_MAX_COMPLETE_FAILS
```
    Property name for max complete fails configuration
    See Also:
    Constant Field Values
  - USER_AGENT
```
protected static final String USER_AGENT
```
    Default User-Agent header value. This will be replaced by the HTTP Proxy if we are using it
    See Also:
    Constant Field Values
- Constructor Detail
  - EepGet
```
public EepGet(I2PAppContext ctx,
              boolean shouldProxy,
              String proxyHost,
              int proxyPort,
              int numRetries,
              long minSize,
              long maxSize,
              String outputFile,
              OutputStream outputStream,
              String url,
              boolean allowCaching,
              String etag,
              String postData)
```
    Creates a new EepGet instance with size limits, output stream, and POST data.
    Parameters:
    ctx - I2P app context
    shouldProxy - whether to use a proxy
    proxyHost - proxy hostname
    proxyPort - proxy port
    numRetries - number of retries
    minSize - minimum acceptable response size, -1 for unlimited
    maxSize - maximum acceptable response size, -1 for unlimited
    outputFile - not used if outputStream is non-null
    outputStream - takes precedence over outputFile
    url - URL to fetch
    allowCaching - whether to allow caching
    etag - ETag for conditional fetch
    postData - POST data string
  - EepGet
```
public EepGet(I2PAppContext ctx,
              boolean shouldProxy,
              String proxyHost,
              int proxyPort,
              int numRetries,
              long minSize,
              long maxSize,
              String outputFile,
              OutputStream outputStream,
              String url,
              boolean allowCaching,
              String etag,
              String lastModified,
              String postData)
```
    Full constructor for EepGet with all parameters.
    Parameters:
    ctx - I2P app context
    shouldProxy - whether to use a proxy
    proxyHost - proxy hostname
    proxyPort - proxy port
    numRetries - number of retries
    minSize - minimum acceptable response size, -1 for unlimited
    maxSize - maximum acceptable response size, -1 for unlimited
    outputFile - not used if outputStream is non-null
    outputStream - takes precedence over outputFile
    url - URL to fetch
    allowCaching - whether to allow caching
    etag - ETag for conditional fetch
    lastModified - last-modified for conditional fetch
    postData - POST data string
  - EepGet
```
public EepGet(I2PAppContext ctx,
              boolean shouldProxy,
              String proxyHost,
              int proxyPort,
              int numRetries,
              String outputFile,
              String url)
```
    Creates a new EepGet instance with explicit proxy control, defaulting to allow caching.
    Parameters:
    ctx - I2P app context
    shouldProxy - whether to use a proxy
    proxyHost - proxy hostname
    proxyPort - proxy port
    numRetries - number of retries
    outputFile - output file path
    url - URL to fetch
  - EepGet
```
public EepGet(I2PAppContext ctx,
              boolean shouldProxy,
              String proxyHost,
              int proxyPort,
              int numRetries,
              String outputFile,
              String url,
              boolean allowCaching,
              String etag)
```
    Creates a new EepGet instance with conditional fetch via ETag.
    Parameters:
    ctx - I2P app context
    shouldProxy - whether to use a proxy
    proxyHost - proxy hostname
    proxyPort - proxy port
    numRetries - number of retries
    outputFile - output file path
    url - URL to fetch
    allowCaching - whether to allow caching
    etag - ETag for conditional fetch
  - EepGet
```
public EepGet(I2PAppContext ctx,
              boolean shouldProxy,
              String proxyHost,
              int proxyPort,
              int numRetries,
              String outputFile,
              String url,
              boolean allowCaching,
              String etag,
              String lastModified)
```
    Creates a new EepGet instance with conditional fetch via ETag and Last-Modified.
    Parameters:
    ctx - I2P app context
    shouldProxy - whether to use a proxy
    proxyHost - proxy hostname
    proxyPort - proxy port
    numRetries - number of retries
    outputFile - output file path
    url - URL to fetch
    allowCaching - whether to allow caching
    etag - ETag for conditional fetch
    lastModified - last-modified for conditional fetch
  - EepGet
```
public EepGet(I2PAppContext ctx,
              boolean shouldProxy,
              String proxyHost,
              int proxyPort,
              int numRetries,
              String outputFile,
              String url,
              String postData)
```
    Creates a new EepGet instance with POST data support.
    Parameters:
    ctx - I2P app context
    shouldProxy - whether to use a proxy
    proxyHost - proxy hostname
    proxyPort - proxy port
    numRetries - number of retries
    outputFile - output file path
    url - URL to fetch
    postData - POST data string
  - EepGet
```
public EepGet(I2PAppContext ctx,
              int numRetries,
              String outputFile,
              String url)
```
    Creates a new EepGet instance without a proxy, defaulting to allow caching.
    Parameters:
    ctx - I2P app context
    numRetries - number of retries
    outputFile - output file path
    url - URL to fetch
  - EepGet
```
public EepGet(I2PAppContext ctx,
              int numRetries,
              String outputFile,
              String url,
              boolean allowCaching)
```
    Creates a new EepGet instance without a proxy, with configurable caching.
    Parameters:
    ctx - I2P app context
    numRetries - number of retries
    outputFile - output file path
    url - URL to fetch
    allowCaching - whether to allow caching
  - EepGet
```
public EepGet(I2PAppContext ctx,
              String proxyHost,
              int proxyPort,
              int numRetries,
              String outputFile,
              String url)
```
    Creates a new EepGet instance with proxy support, defaulting to allow caching.
    Parameters:
    ctx - I2P app context
    proxyHost - proxy hostname
    proxyPort - proxy port
    numRetries - number of retries
    outputFile - output file path
    url - URL to fetch
  - EepGet
```
public EepGet(I2PAppContext ctx,
              String proxyHost,
              int proxyPort,
              int numRetries,
              String outputFile,
              String url,
              boolean allowCaching)
```
    Creates a new EepGet instance with proxy support and configurable caching.
    Parameters:
    ctx - I2P app context
    proxyHost - proxy hostname
    proxyPort - proxy port
    numRetries - number of retries
    outputFile - output file path
    url - URL to fetch
    allowCaching - whether to allow caching
- Method Detail
  - addAuthorization
```
public void addAuthorization(String userName,
                             String password)
```
    Add basic authorization header for the proxy. Only added if the request is going through a proxy. Must be called before fetch().
    Parameters:
    userName - proxy username
    password - proxy password
  - addHeader
```
public void addHeader(String name,
                      String value)
```
    Add an extra header to the request. Must be called before fetch(). Not supported by EepHead. As of 0.9.10, If name is User-Agent, this will replace the default User-Agent header. As of 0.9.14, If name is If-None-Match or If-Modified-Since, this will replace the etag or last-modified value given in the constructor. Note that headers may be subsequently modified or removed in the I2PTunnel HTTP Client proxy. In proxied SSLEepGet, these headers are sent to the remote server, NOT the proxy.
    Parameters:
    name - header name
    value - header value
  - addStatusListener
```
public void addStatusListener(EepGet.StatusListener lsnr)
```
    Add a status listener.
    Parameters:
    lsnr - the listener to add
  - doFetch
```
protected void doFetch(SocketTimeout timeout)
                throws IOException
```
    Read response body for a single fetch. Call after sendRequest().
    Parameters:
    timeout - may be null
    Throws:
    IOException - on IO error
  - fetch
```
public boolean fetch()
```
    Blocking fetch, returning true if the URL was retrieved, false if all retries failed. Header timeout default 45 sec, total timeout default none, inactivity timeout default 60 sec.
    Returns:
    success
  - fetch
```
public boolean fetch(long fetchHeaderTimeout)
```
    Blocking fetch, timing out individual attempts if the HTTP response headers don't come back in the time given. If the timeout is zero or less, this will wait indefinitely. Total timeout default none, inactivity timeout default 60 sec.
    Parameters:
    fetchHeaderTimeout - timeout in ms
    Returns:
    success
  - fetch
```
public boolean fetch(long fetchHeaderTimeout,
                     long totalTimeout,
                     long inactivityTimeout)
```
    Blocking fetch.
    Parameters:
    fetchHeaderTimeout - <= 0 for none (proxy will timeout if none, none isn't recommended if no proxy)
    totalTimeout - <= 0 for default none
    inactivityTimeout - <= 0 for default 60 sec
    Returns:
    success
  - getAcceptRanges
```
public String getAcceptRanges()
```
    Show the Accept-Ranges field
    Returns:
    the accept ranges
  - getCacheControl
```
public String getCacheControl()
```
    Show the Cache-Control field
    Returns:
    the cache control
  - getContentEncoding
```
public String getContentEncoding()
```
    Show the Content-Encoding field
    Returns:
    the content encoding
  - getContentLanguage
```
public String getContentLanguage()
```
    Show the Content-Language field
    Returns:
    the content language
  - getContentType
```
public String getContentType()
```
    After fetch, the received value from the server, or null if none.
    Returns:
    the content type
  - getCookie
```
public String getCookie()
```
    Show the Set-Cookie field
    Returns:
    the cookie
  - getCSP
```
public String getCSP()
```
    Content-Security-Policy header.
    Returns:
    the CSP value, or null
  - getEtag
```
public String getEtag()
```
    After fetch, the received value from the server, or null if none. Before fetch, and after some errors, may be the value passed in the constructor.
    Returns:
    the etag
  - getExpiryDate
```
public String getExpiryDate()
```
    Show the Expires field
    Returns:
    the expiry date
  - getLastModified
```
public String getLastModified()
```
    After fetch, the received value from the server, or null if none. Before fetch, and after some errors, may be the value passed in the constructor.
    Returns:
    the last modified date
  - getNotModified
```
public boolean getNotModified()
```
    Whether the server returned 304.
    Returns:
    true if the server returned 304
  - getReferrerPolicy
```
public String getReferrerPolicy()
```
    Referrer-Policy header.
    Returns:
    the referrer policy, or null
  - getRequest
```
protected String getRequest()
                     throws IOException
```
    Build the HTTP request string for the current URL and state.
    Returns:
    the HTTP request string
    Throws:
    IOException - on bad URL
  - getServer
```
public String getServer()
```
    Show the Server field
    Returns:
    the server
  - getStatus
```
public String getStatus()
```
    Combined server status message e.g. "200 OK".
    Returns:
    the status string
  - getStatusCode
```
public int getStatusCode()
```
    The server response (200, etc).
    Returns:
    -1 if invalid, or if the proxy never responded, or if no proxy was used and the server never responded. If a non-proxied request partially succeeded (for example a redirect followed by a fail, or a partial fetch followed by a fail), this will be the last status code received. Note that fetch() may return false even if this returns 200.
  - getStatusText
```
public String getStatusText()
```
    The server text ("OK", "Not Found", etc). Note that the text may contain % encoding.
    Returns:
    null if invalid, or if the proxy never responded, or if no proxy was used and the server never responded. If a non-proxied request partially succeeded (for example a redirect followed by a fail, or a partial fetch followed by a fail), this will be the last status code received. Note that fetch() may return false even if this returns "OK".
  - getTransferEncoding
```
public String getTransferEncoding()
```
    Show the Transfer-Encoding field
    Returns:
    the transfer encoding
  - getVary
```
public String getVary()
```
    Vary header.
    Returns:
    the vary value, or null
  - getXContentTypeOptions
```
public String getXContentTypeOptions()
```
    X-Content-Type-Options header.
    Returns:
    the content type options, or null
  - getXframeOptions
```
public String getXframeOptions()
```
    X-Frame-Options header.
    Returns:
    the frame options, or null
  - getXPoweredBy
```
public String getXPoweredBy()
```
    X-Powered-By header.
    Returns:
    the powered-by value, or null
  - getXSSProtection
```
public String getXSSProtection()
```
    X-XSS-Protection header.
    Returns:
    the XSS protection value, or null
  - main
```
public static void main(String[] args)
```
    Command-line entry point for EepGet. Usage: eepget [-p 127.0.0.1:4444] [-n #retries] [-e etag] [-o outputFile] [-m markSize lineLen] url As of 0.9.45, supports https and redirect to https
    Parameters:
    args - command-line arguments
  - parseAuthArgs
```
public static Map<String,String> parseAuthArgs(String args)
```
    Parse the args in an authentication header. Modified from LoadClientAppsJob. All keys are mapped to lower case. Double quotes around values are stripped. Ref: RFC 2617 Public for I2PTunnelHTTPClientBase; use outside of tree at own risk, subject to change or removal
    Parameters:
    args - non-null, starting after "Digest " or "Basic "
    Returns:
    parsed key-value pairs
  - readChunkLength
```
protected long readChunkLength()
                        throws IOException
```
    Parse a chunk length from the HTTP response stream. TODO does not skip chunk extensions (RFC 2616 sec. 3.6.1)
    Returns:
    the chunk length
    Throws:
    IOException - on IO error
  - readHeaders
```
protected void readHeaders()
                    throws IOException
```
    Read and parse HTTP response headers.
    Throws:
    IOException - on IO error
  - sendRequest
```
protected void sendRequest(SocketTimeout timeout)
                    throws IOException
```
    Open connection and send HTTP request.
    Parameters:
    timeout - may be null
    Throws:
    IOException - on IO error
  - setPostData
```
protected void setPostData(String contentType,
                           byte[] data)
```
    Set post data (binary body). Must be called before fetch().
    Parameters:
    contentType - Content-Type header value
    data - POST body bytes
    Throws:
    IllegalStateException - if already set
  - setPostData
```
protected void setPostData(String contentType,
                           File data)
```
    Set post data (file body). Must be called before fetch().
    Parameters:
    contentType - Content-Type header value
    data - file containing POST body
    Throws:
    IllegalStateException - if already set
  - setPostData
```
protected void setPostData(String contentType,
                           String data)
```
    Set post data (string body). Must be called before fetch().
    Parameters:
    contentType - Content-Type header value
    data - POST body
    Throws:
    IllegalStateException - if already set
  - setWriteErrorToOutput
```
public void setWriteErrorToOutput()
```
    If called (before calling fetch()), data from the server or proxy will be written to the output file or stream even on an error response code (4xx, 5xx, etc). The error data will only be written if no previous data was written on an earlier try. Caller must of course check getStatusCode() or the fetch() return value.
  - shouldReadBody
```
protected boolean shouldReadBody()
```
    Whether to read the response body.
    Returns:
    true always, overridden in EepHead
  - stopFetching
```
public void stopFetching()
```
    Stop the fetch in progress.
  - suggestName
```
public static String suggestName(String url)
```
    Parse URL for a viable filename.
    Parameters:
    url - a URL giving the location of an online resource
    Returns:
    a filename to save the resource as on local filesystem

Class EepGet

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_aborted

_acceptRanges

_actualURL

_alreadyTransferred

_authState

_bytesRemaining

_bytesTransferred

_cacheControl

_contentEncoding

_contentLanguage

_contentType

_context

_cookie

_csp

_currentAttempt

_decompressException

_encodingChunked

_etag

_etagOrig

_expiryDate

_extraHeaders

_fetchHeaderTimeout

_fetchInactivityTimeout

_fetchTotalTimeout

_isGzippedResponse

_keepFetching

_lastModified

_lastModifiedOrig

_listeners

_log

_maxCompleteFails

_notModified

_numRetries

_out

_outputFile

_outputStream

_proxy

_proxyHost

_proxyIn

_proxyOut

_proxyPort

_redirectLocation

_redirects

_referrerPolicy

_responseCode

_responseText

_server

_shouldProxy

_shouldWriteErrorToOutput

_status

_transferEncoding

_transferFailed

_url

_vary

_xContentTypeOptions

_xframeOptions

_xPoweredBy

_xssProtection

DEFAULT_CONNECT_TIMEOUT

DEFAULT_INACTIVITY_TIMEOUT

DEFAULT_MAX_COMPLETE_FAILS

DEFAULT_NUM_RETRIES

PROP_CONNECT_TIMEOUT

PROP_DEFAULT_RETRIES

PROP_INACTIVITY_TIMEOUT

PROP_MAX_COMPLETE_FAILS

USER_AGENT

Constructor Detail

EepGet

EepGet

EepGet

EepGet

EepGet