HTTPPacket (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- org.cybergarage.http.HTTPPacket

Direct Known Subclasses:
HTTPRequest, HTTPResponse
```
public class HTTPPacket
extends Object
```
Represents a parsed HTTP packet with header and body handling.

Constructor Summary

Constructors
Constructor and Description
`HTTPPacket()` Creates a new HTTP packet with default settings.
`HTTPPacket(HTTPPacket httpPacket)` Creates a copy of an existing HTTP packet.
`HTTPPacket(InputStream in)` Creates an HTTP packet by parsing from an input stream.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHeader(HTTPHeader header)` Adds a header to this HTTP packet.
`void`	`addHeader(String name, String value)` Adds a header with the specified name and value.
`void`	`clearHeaders()` Clears all headers from this HTTP packet.
`String`	`getCacheControl()` Get the Cache-Control header value.
`String`	`getCharSet()` Gets the character set from the Content-Type header.
`String`	`getConnection()` Gets the Connection header value.
`byte[]`	`getContent()` Gets the content of this HTTP packet.
`InputStream`	`getContentInputStream()` Gets the content input stream.
`String`	`getContentLanguage()` Gets the Content-Language header value.
`long`	`getContentLength()` Gets the content length from the Content-Length header.
`long[]`	`getContentRange()` Gets the content range values as an array.
`long`	`getContentRangeFirstPosition()` Get the first position from the content range.
`long`	`getContentRangeInstanceLength()` Get the instance length from the content range.
`long`	`getContentRangeLastPosition()` Get the last position from the content range.
`String`	`getContentString()` Gets the content of this HTTP packet as a string.
`String`	`getContentType()` Gets the Content-Type header value.
`String`	`getDate()` Get the Date header value.
`protected String`	`getFirstLine()` Gets the first line of the HTTP packet.
`protected String`	`getFirstLineToken(int num)` Gets a specific token from the first line using HTTP request line delimiters.
`HTTPHeader`	`getHeader(int n)` Gets the header at the specified index.
`HTTPHeader`	`getHeader(String name)` Gets the header with the specified name, ignoring case.
`String`	`getHeaderString()` Gets all headers as a formatted string.
`String`	`getHeaderValue(String name)` Gets the value of a header by name.
`String`	`getHost()` Get the Host header value.
`int`	`getIntegerHeaderValue(String name)` Gets an integer header value by name.
`long`	`getLongHeaderValue(String name)` Gets a long header value by name.
`int`	`getNHeaders()` Gets the number of headers in this HTTP packet.
`String`	`getServer()` Get the Server header value.
`String`	`getStringHeaderValue(String name)` Gets a string header value, stripping double quotes if present.
`String`	`getStringHeaderValue(String name, String startWidth, String endWidth)` Gets a string header value, stripping the specified delimiters if present.
`String`	`getTransferEncoding()` Get the Transfer-Encoding header value.
`String`	`getVersion()` Gets the HTTP version of this packet.
`boolean`	`hasConnection()` Checks if the Connection header is set.
`boolean`	`hasContent()` Checks if this HTTP packet has content.
`boolean`	`hasContentInputStream()` Checks if a content input stream has been set.
`boolean`	`hasContentRange()` Checks if the Content-Range or Range header is set.
`boolean`	`hasFirstLine()` Checks if the first line of the HTTP packet has been set.
`boolean`	`hasHeader(String name)` Checks if a header with the specified name exists.
`boolean`	`hasTransferEncoding()` Check if the Transfer-Encoding header is set.
`void`	`init()` Initializes the HTTP packet to empty state.
`boolean`	`isChunked()` Check if the content is chunked.
`boolean`	`isCloseConnection()` Checks if the Connection header is set to close.
`boolean`	`isKeepAliveConnection()` Checks if the Connection header is set to keep-alive.
`boolean`	`read(HTTPSocket httpSock)` Reads and parses HTTP packet from a socket.
`protected void`	`set(HTTPPacket httpPacket)` Copies all data from another HTTP packet to this packet.
`protected boolean`	`set(HTTPSocket httpSock)` Parses HTTP packet data from an HTTP socket.
`protected boolean`	`set(InputStream in)` Parses HTTP packet data from an input stream including content.
`protected boolean`	`set(InputStream in, boolean onlyHeaders)` Parses HTTP packet data from an input stream.
`void`	`setCacheControl(int value)` Set the Cache-Control header with a max-age value.
`void`	`setCacheControl(String directive)` Set the Cache-Control header.
`void`	`setCacheControl(String directive, int value)` Set the Cache-Control header with a directive and value.
`void`	`setConnection(String value)` Sets the Connection header.
`void`	`setContent(byte[] data)` Sets the content of this HTTP packet.
`void`	`setContent(byte[] data, boolean updateWithContentLength)` Sets the content of this HTTP packet.
`void`	`setContent(String data)` Sets the content of this HTTP packet from a string.
`void`	`setContent(String data, boolean updateWithContentLength)` Sets the content of this HTTP packet from a string.
`void`	`setContentInputStream(InputStream in)` Sets the content input stream.
`void`	`setContentLanguage(String code)` Sets the Content-Language header.
`void`	`setContentLength(long len)` Sets the Content-Length header.
`void`	`setContentRange(long firstPos, long lastPos, long length)` Sets the Content-Range header.
`void`	`setContentType(String type)` Sets the Content-Type header.
`void`	`setDate(Calendar cal)` Set the Date header.
`void`	`setHeader(HTTPHeader header)` Sets the value of a header from an HTTP header object.
`void`	`setHeader(String name, int value)` Sets the value of a header from an integer.
`void`	`setHeader(String name, long value)` Sets the value of a header from a long.
`void`	`setHeader(String name, String value)` Sets the value of a header.
`void`	`setHost(String host, int port)` Set the Host header.
`void`	`setIntegerHeader(String name, int value)` Sets an integer header value.
`void`	`setLongHeader(String name, long value)` Sets a long header value.
`void`	`setServer(String name)` Set the Server header.
`void`	`setStringHeader(String name, String value)` Sets a string header value, wrapping it with double quotes if not already wrapped.
`void`	`setStringHeader(String name, String value, String startWidth, String endWidth)` Sets a string header value, wrapping it with the specified delimiters if not already wrapped.
`void`	`setTransferEncoding(String value)` Set the Transfer-Encoding header.
`void`	`setVersion(String ver)` Sets the HTTP version for this packet.

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

- Constructor Detail
  - HTTPPacket
```
public HTTPPacket()
```
    Creates a new HTTP packet with default settings. Initializes with HTTP version and empty content.
  - HTTPPacket
```
public HTTPPacket(HTTPPacket httpPacket)
```
    Creates a copy of an existing HTTP packet.
    Parameters:
    httpPacket - HTTP packet to copy
  - HTTPPacket
```
public HTTPPacket(InputStream in)
```
    Creates an HTTP packet by parsing from an input stream.
    Parameters:
    in - input stream containing the HTTP packet data
- Method Detail
  - addHeader
```
public void addHeader(HTTPHeader header)
```
    Adds a header to this HTTP packet.
    Parameters:
    header - the header to add
  - addHeader
```
public void addHeader(String name,
                      String value)
```
    Adds a header with the specified name and value.
    Parameters:
    name - the header name
    value - the header value
  - clearHeaders
```
public void clearHeaders()
```
    Clears all headers from this HTTP packet.
  - getCacheControl
```
public String getCacheControl()
```
    Get the Cache-Control header value.
    Returns:
    the cache control string
  - getCharSet
```
public String getCharSet()
```
    Gets the character set from the Content-Type header.
    Returns:
    the charset string, or empty string if not specified
  - getConnection
```
public String getConnection()
```
    Gets the Connection header value.
    Returns:
    the connection directive, or empty string if not set
  - getContent
```
public byte[] getContent()
```
    Gets the content of this HTTP packet.
    Returns:
    content as byte array
  - getContentInputStream
```
public InputStream getContentInputStream()
```
    Gets the content input stream.
    Returns:
    the content input stream, or null if not set
  - getContentLanguage
```
public String getContentLanguage()
```
    Gets the Content-Language header value.
    Returns:
    the content language, or empty string if not set
  - getContentLength
```
public long getContentLength()
```
    Gets the content length from the Content-Length header.
    Returns:
    the content length
  - getContentRange
```
public long[] getContentRange()
```
    Gets the content range values as an array.
    Returns:
    array containing first position, last position, and length
  - getContentRangeFirstPosition
```
public long getContentRangeFirstPosition()
```
    Get the first position from the content range.
    Returns:
    the first byte position
  - getContentRangeInstanceLength
```
public long getContentRangeInstanceLength()
```
    Get the instance length from the content range.
    Returns:
    the instance length
  - getContentRangeLastPosition
```
public long getContentRangeLastPosition()
```
    Get the last position from the content range.
    Returns:
    the last byte position
  - getContentString
```
public String getContentString()
```
    Gets the content of this HTTP packet as a string. Uses the character set specified in Content-Type header if available.
    Returns:
    content as string, using UTF-8 as default charset
  - getContentType
```
public String getContentType()
```
    Gets the Content-Type header value.
    Returns:
    the content type, or empty string if not set
  - getDate
```
public String getDate()
```
    Get the Date header value.
    Returns:
    the date string
  - getFirstLine
```
protected String getFirstLine()
```
    Gets the first line of the HTTP packet.
    For requests, this returns the request line containing method, URI, and HTTP version. For responses, this returns the status line containing HTTP version, status code, and reason phrase.
    Returns:
    the first line string, or empty string if not set
  - getFirstLineToken
```
protected String getFirstLineToken(int num)
```
    Gets a specific token from the first line using HTTP request line delimiters.
    This method parses the first line (request line or status line) and returns the token at the specified position. Tokens are separated by spaces.
    For request lines: token 0 = method, token 1 = URI, token 2 = HTTP version
    For status lines: token 0 = HTTP version, token 1 = status code, token 2 = reason phrase
    Parameters:
    num - the zero-based token position to retrieve
    Returns:
    the token at the specified position, or empty string if not found
  - getHeader
```
public HTTPHeader getHeader(int n)
```
    Gets the header at the specified index.
    Parameters:
    n - the index of the header to retrieve
    Returns:
    the header at the specified index
  - getHeader
```
public HTTPHeader getHeader(String name)
```
    Gets the header with the specified name, ignoring case.
    Parameters:
    name - the header name
    Returns:
    the matching header, or null if not found
  - getHeaderString
```
public String getHeaderString()
```
    Gets all headers as a formatted string.
    Returns:
    the header string in "Name: Value" format, each header on its own line
  - getHeaderValue
```
public String getHeaderValue(String name)
```
    Gets the value of a header by name.
    Parameters:
    name - the header name
    Returns:
    the header value, or empty string if not found
  - getHost
```
public String getHost()
```
    Get the Host header value.
    Returns:
    the host string including port
  - getIntegerHeaderValue
```
public int getIntegerHeaderValue(String name)
```
    Gets an integer header value by name.
    Parameters:
    name - the header name
    Returns:
    the header value as integer, or 0 if not found
  - getLongHeaderValue
```
public long getLongHeaderValue(String name)
```
    Gets a long header value by name.
    Parameters:
    name - the header name
    Returns:
    the header value as long, or 0 if not found
  - getNHeaders
```
public int getNHeaders()
```
    Gets the number of headers in this HTTP packet.
    Returns:
    the number of headers
  - getServer
```
public String getServer()
```
    Get the Server header value.
    Returns:
    the server string
  - getStringHeaderValue
```
public String getStringHeaderValue(String name)
```
    Gets a string header value, stripping double quotes if present.
    Parameters:
    name - the header name
    Returns:
    the header value with double quotes stripped
  - getStringHeaderValue
```
public String getStringHeaderValue(String name,
                                   String startWidth,
                                   String endWidth)
```
    Gets a string header value, stripping the specified delimiters if present.
    Parameters:
    name - the header name
    startWidth - the start delimiter to strip
    endWidth - the end delimiter to strip
    Returns:
    the header value with delimiters stripped
  - getTransferEncoding
```
public String getTransferEncoding()
```
    Get the Transfer-Encoding header value.
    Returns:
    the transfer encoding string
  - getVersion
```
public String getVersion()
```
    Gets the HTTP version of this packet.
    Returns:
    HTTP version string, or null if not set
  - hasConnection
```
public boolean hasConnection()
```
    Checks if the Connection header is set.
    Returns:
    true if the Connection header exists, false otherwise
  - hasContent
```
public boolean hasContent()
```
    Checks if this HTTP packet has content.
    Returns:
    true if content length is greater than 0, false otherwise
  - hasContentInputStream
```
public boolean hasContentInputStream()
```
    Checks if a content input stream has been set.
    Returns:
    true if a content input stream is set, false otherwise
  - hasContentRange
```
public boolean hasContentRange()
```
    Checks if the Content-Range or Range header is set.
    Returns:
    true if a range header exists, false otherwise
  - hasFirstLine
```
public boolean hasFirstLine()
```
    Checks if the first line of the HTTP packet has been set.
    Returns:
    true if the first line has content, false otherwise
  - hasHeader
```
public boolean hasHeader(String name)
```
    Checks if a header with the specified name exists.
    Parameters:
    name - the header name
    Returns:
    true if the header exists, false otherwise
  - hasTransferEncoding
```
public boolean hasTransferEncoding()
```
    Check if the Transfer-Encoding header is set.
    Returns:
    true if Transfer-Encoding is present
  - init
```
public void init()
```
    Initializes the HTTP packet to empty state. Clears first line, headers, content, and content input stream.
  - isChunked
```
public boolean isChunked()
```
    Check if the content is chunked.
    Returns:
    true if chunked transfer encoding is set
  - isCloseConnection
```
public boolean isCloseConnection()
```
    Checks if the Connection header is set to close.
    Returns:
    true if close, false otherwise
  - isKeepAliveConnection
```
public boolean isKeepAliveConnection()
```
    Checks if the Connection header is set to keep-alive.
    Returns:
    true if keep-alive, false otherwise
  - read
```
public boolean read(HTTPSocket httpSock)
```
    Reads and parses HTTP packet from a socket.
    Parameters:
    httpSock - socket containing the HTTP packet data
    Returns:
    true if packet was read successfully, false otherwise
  - set
```
protected void set(HTTPPacket httpPacket)
```
    Copies all data from another HTTP packet to this packet.
    This method performs a deep copy by copying the first line, all headers, and content from the source packet. The target packet is first cleared before copying.
    Parameters:
    httpPacket - the source HTTP packet to copy from
  - set
```
protected boolean set(HTTPSocket httpSock)
```
    Parses HTTP packet data from an HTTP socket.
    This is a convenience method that extracts the input stream from the HTTP socket and parses the complete HTTP packet including content.
    Parameters:
    httpSock - the HTTP socket containing the HTTP packet data
    Returns:
    true if parsing was successful, false otherwise
  - set
```
protected boolean set(InputStream in)
```
    Parses HTTP packet data from an input stream including content.
    This is a convenience method that calls set(InputStream, boolean) with onlyHeaders set to false.
    Parameters:
    in - the input stream containing HTTP packet data
    Returns:
    true if parsing was successful, false otherwise
  - set
```
protected boolean set(InputStream in,
                      boolean onlyHeaders)
```
    Parses HTTP packet data from an input stream.
    This method reads and parses the HTTP packet including the first line, headers, and optionally the content body. It handles special cases such as:
    - HTTP 100 Continue responses (IIS compatibility)
    - Chunked transfer encoding
    - Content length parsing
    Parameters:
    in - the input stream containing HTTP packet data
    onlyHeaders - if true, only parse headers and skip content body
    Returns:
    true if parsing was successful, false otherwise
  - setCacheControl
```
public void setCacheControl(int value)
```
    Set the Cache-Control header with a max-age value.
    Parameters:
    value - the max age in seconds
  - setCacheControl
```
public void setCacheControl(String directive)
```
    Set the Cache-Control header.
    Parameters:
    directive - the cache directive
  - setCacheControl
```
public void setCacheControl(String directive,
                            int value)
```
    Set the Cache-Control header with a directive and value.
    Parameters:
    directive - the cache directive
    value - the directive value
  - setConnection
```
public void setConnection(String value)
```
    Sets the Connection header.
    Parameters:
    value - the connection directive
  - setContent
```
public void setContent(byte[] data)
```
    Sets the content of this HTTP packet. Automatically updates Content-Length header.
    Parameters:
    data - content data as byte array
  - setContent
```
public void setContent(byte[] data,
                       boolean updateWithContentLength)
```
    Sets the content of this HTTP packet.
    Parameters:
    data - content data as byte array
    updateWithContentLength - whether to update Content-Length header automatically
  - setContent
```
public void setContent(String data)
```
    Sets the content of this HTTP packet from a string. Automatically updates Content-Length header.
    Parameters:
    data - content data as string
  - setContent
```
public void setContent(String data,
                       boolean updateWithContentLength)
```
    Sets the content of this HTTP packet from a string.
    Parameters:
    data - content data as string
    updateWithContentLength - whether to update Content-Length header automatically
  - setContentInputStream
```
public void setContentInputStream(InputStream in)
```
    Sets the content input stream.
    Parameters:
    in - the input stream to use as content source
  - setContentLanguage
```
public void setContentLanguage(String code)
```
    Sets the Content-Language header.
    Parameters:
    code - the language code
  - setContentLength
```
public void setContentLength(long len)
```
    Sets the Content-Length header.
    Parameters:
    len - the content length
  - setContentRange
```
public void setContentRange(long firstPos,
                            long lastPos,
                            long length)
```
    Sets the Content-Range header.
    Parameters:
    firstPos - the first byte position
    lastPos - the last byte position
    length - the total length, or 0 for unknown
  - setContentType
```
public void setContentType(String type)
```
    Sets the Content-Type header.
    Parameters:
    type - the content type string
  - setDate
```
public void setDate(Calendar cal)
```
    Set the Date header.
    Parameters:
    cal - the calendar to set as the date
  - setHeader
```
public void setHeader(HTTPHeader header)
```
    Sets the value of a header from an HTTP header object.
    Parameters:
    header - the header to set
  - setHeader
```
public void setHeader(String name,
                      int value)
```
    Sets the value of a header from an integer.
    Parameters:
    name - the header name
    value - the header value as integer
  - setHeader
```
public void setHeader(String name,
                      long value)
```
    Sets the value of a header from a long.
    Parameters:
    name - the header name
    value - the header value as long
  - setHeader
```
public void setHeader(String name,
                      String value)
```
    Sets the value of a header. If the header does not exist, it is created.
    Parameters:
    name - the header name
    value - the header value
  - setHost
```
public void setHost(String host,
                    int port)
```
    Set the Host header.
    Parameters:
    host - the host name
    port - the port number
  - setIntegerHeader
```
public void setIntegerHeader(String name,
                             int value)
```
    Sets an integer header value.
    Parameters:
    name - the header name
    value - the header value as integer
  - setLongHeader
```
public void setLongHeader(String name,
                          long value)
```
    Sets a long header value.
    Parameters:
    name - the header name
    value - the header value as long
  - setServer
```
public void setServer(String name)
```
    Set the Server header.
    Parameters:
    name - the server name
  - setStringHeader
```
public void setStringHeader(String name,
                            String value)
```
    Sets a string header value, wrapping it with double quotes if not already wrapped.
    Parameters:
    name - the header name
    value - the header value
  - setStringHeader
```
public void setStringHeader(String name,
                            String value,
                            String startWidth,
                            String endWidth)
```
    Sets a string header value, wrapping it with the specified delimiters if not already wrapped.
    Parameters:
    name - the header name
    value - the header value
    startWidth - the start delimiter
    endWidth - the end delimiter
  - setTransferEncoding
```
public void setTransferEncoding(String value)
```
    Set the Transfer-Encoding header.
    Parameters:
    value - the transfer encoding value
  - setVersion
```
public void setVersion(String ver)
```
    Sets the HTTP version for this packet.
    Parameters:
    ver - HTTP version string (e.g., "1.0", "1.1")

Class HTTPPacket

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HTTPPacket

HTTPPacket

HTTPPacket

Method Detail

addHeader

addHeader

clearHeaders

getCacheControl

getCharSet

getConnection

getContent

getContentInputStream

getContentLanguage

getContentLength

getContentRange

getContentRangeFirstPosition

getContentRangeInstanceLength

getContentRangeLastPosition

getContentString

getContentType

getDate

getFirstLine

getFirstLineToken

getHeader

getHeader

getHeaderString

getHeaderValue

getHost

getIntegerHeaderValue

getLongHeaderValue

getNHeaders

getServer

getStringHeaderValue

getStringHeaderValue

getTransferEncoding

getVersion

hasConnection

hasContent

hasContentInputStream

hasContentRange

hasFirstLine

hasHeader

hasTransferEncoding

init

isChunked

isCloseConnection

isKeepAliveConnection

read

set

set

set

set

setCacheControl

setCacheControl

setCacheControl

setConnection

setContent

setContent

setContent

setContent

setContentInputStream

setContentLanguage

setContentLength

setContentRange

setContentType

setDate

setHeader

setHeader

setHeader

setHeader

setHost

setIntegerHeader

setLongHeader

setServer

setStringHeader