HTTPRequest

java.lang.Object

org.cybergarage.http.HTTPPacket

org.cybergarage.http.HTTPRequest

Direct Known Subclasses:: SOAPRequest, SSDPRequest, SubscriptionRequest

public class HTTPRequestextends HTTPPacket

HTTP request message with method, URI, headers, and content body.

Field Summary
Fields
Modifier and Type
Field
Description
private String
bindTo
Local address the connection is bound to.
private HTTPSocket
httpSocket
/////////////////////////////////////////////
private String
method
/////////////////////////////////////////////
private Socket
postSocket
/////////////////////////////////////////////
private String
requestHost
/////////////////////////////////////////////
private int
requestPort
Port the request was sent to, -1 until known.
private String
uri
/////////////////////////////////////////////
Constructor Summary
Constructors
Constructor
Description
HTTPRequest()
/////////////////////////////////////////////
HTTPRequest(InputStream in)
Parses an HTTP request from the given input stream.
HTTPRequest(HTTPSocket httpSock)
Creates an HTTP request from the given socket's input stream.
Method Summary
All Methods
Modifier and Type
Method
Description
String
getFirstLineString()
Returns the first line of the HTTP request (method, URI, and version).
String
getHeader()
Returns the complete HTTP header as a string.
String
getHTTPVersion()
Returns the HTTP version string for this request.
String
getLocalAddress()
Returns the local address of the underlying socket.
int
getLocalPort()
Returns the local port of the underlying socket.
String
getMethod()
Returns the HTTP method.
ParameterList
getParameterList()
Parses the URI query string and returns the parameters as a ParameterList.
String
getParameterValue(String name)
Returns the value of the specified URI query parameter.
String
getRequestHost()
Returns the request host.
int
getRequestPort()
Returns the request port.
HTTPSocket
getSocket()
Returns the HTTPSocket for this request.
String
getURI()
Returns the request URI.
boolean
isGetRequest()
Determines if this is a GET request.
boolean
isHeadRequest()
Determines if this is a HEAD request.
boolean
isKeepAlive()
Determines if this connection should be kept alive.
boolean
isMethod(String method)
Checks if the HTTP method matches the given string.
boolean
isNotifyRequest()
Determines if this is a NOTIFY request.
boolean
isPostRequest()
Determines if this is a POST request.
boolean
isSOAPAction()
Checks if this request has a SOAPAction header.
boolean
isSubscribeRequest()
Determines if this is a SUBSCRIBE request.
boolean
isUnsubscribeRequest()
Determines if this is an UNSUBSCRIBE request.
boolean
parseRequestLine(String lineStr)
Parses an HTTP request line and extracts method, URI, and version.
HTTPResponse
post(String host, int port)
Posts this HTTP request to the specified host and port with no keep-alive.
HTTPResponse
post(String host, int port, boolean isKeepAlive)
Posts this HTTP request to the specified host and port.
boolean
post(HTTPResponse httpRes)
Posts an HTTP response back to the client.
void
print()
Prints the HTTP request to the debug message stream.
boolean
read()
Reads the HTTP request from the underlying socket.
boolean
returnBadRequest()
Sends an HTTP 400 Bad Request response with no content.
boolean
returnOK()
Sends an HTTP 200 OK response with no content.
boolean
returnResponse(int statusCode)
Sends an HTTP response with the specified status code and no content.
void
set(HTTPRequest httpReq)
Copies the contents of the given HTTP request into this request.
void
setBindHost(String host)
I2P - bind HTTP socket to specified local host address
void
setMethod(String value)
Sets the HTTP method (e.g., GET, POST).
void
setRequestHost(String host)
Sets the host for this request.
void
setRequestPort(int host)
Sets the port for this request.
void
setSocket(HTTPSocket value)
Sets the HTTPSocket for this request.
void
setURI(String value)
Sets the URI for this HTTP request without relative URL conversion.
void
setURI(String value, boolean isCheckRelativeURL)
Sets the URI for this HTTP request.
String
toString()
/////////////////////////////////////////////
Methods inherited from class HTTPPacket
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, setStringHeader, setTransferEncoding, setVersion
Modifier and Type
Method
Description
void
addHeader(String name, String value)
Adds a header with the specified name and value.
void
addHeader(HTTPHeader header)
Adds a header to this HTTP packet.
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 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.
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.
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(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
setHeader(HTTPHeader header)
Sets the value of a header from an HTTP header object.
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 Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- method
  private String method
  /////////////////////////////////////////////
- uri
  private String uri
  /////////////////////////////////////////////
- requestHost
  private String requestHost
  /////////////////////////////////////////////
- requestPort
  private int requestPort
  Port the request was sent to, -1 until known.
- httpSocket
  private HTTPSocket httpSocket
  /////////////////////////////////////////////
- postSocket
  private Socket postSocket
  /////////////////////////////////////////////
- bindTo
  private String bindTo
  Local address the connection is bound to.
Constructor Details
- HTTPRequest
  public HTTPRequest()
  /////////////////////////////////////////////
- HTTPRequest
  public HTTPRequest(InputStream in)
  Parses an HTTP request from the given input stream.
  Parameters:
  in - the stream supplying the raw request bytes
- HTTPRequest
  public HTTPRequest(HTTPSocket httpSock)
  Creates an HTTP request from the given socket's input stream.
  Parameters:
  httpSock - the socket supplying the request bytes, retained on the new request
Method Details
- setMethod
  public void setMethod(String value)
  Sets the HTTP method (e.g., GET, POST).
  Parameters:
  value - the HTTP method string
- getMethod
  public String getMethod()
  Returns the HTTP method.
  Returns:
  the HTTP method string, or null if not set
- isMethod
  public boolean isMethod(String method)
  Checks if the HTTP method matches the given string.
  Parameters:
  method - the method string to compare
  Returns:
  true if the methods match (case-insensitive), false otherwise
- isGetRequest
  public boolean isGetRequest()
  Determines if this is a GET request.
  Returns:
  true if the method is GET, false otherwise
- isPostRequest
  public boolean isPostRequest()
  Determines if this is a POST request.
  Returns:
  true if the method is POST, false otherwise
- isHeadRequest
  public boolean isHeadRequest()
  Determines if this is a HEAD request.
  Returns:
  true if the method is HEAD, false otherwise
- isSubscribeRequest
  public boolean isSubscribeRequest()
  Determines if this is a SUBSCRIBE request.
  Returns:
  true if the method is SUBSCRIBE, false otherwise
- isUnsubscribeRequest
  public boolean isUnsubscribeRequest()
  Determines if this is an UNSUBSCRIBE request.
  Returns:
  true if the method is UNSUBSCRIBE, false otherwise
- isNotifyRequest
  public boolean isNotifyRequest()
  Determines if this is a NOTIFY request.
  Returns:
  true if the method is NOTIFY, false otherwise
- setURI
  public void setURI(String value, boolean isCheckRelativeURL)
  Sets the URI for this HTTP request.
  Sets the request URI and optionally converts it to a relative URL. This is used to handle both absolute and relative URLs in HTTP requests.
  Parameters:
  value - the URI string to set
  isCheckRelativeURL - if true, converts the URI to a relative URL using HTTP.toRelativeURL()
- setURI
  public void setURI(String value)
  Sets the URI for this HTTP request without relative URL conversion.
  This is a convenience method that calls setURI(String, boolean) with isCheckRelativeURL set to false.
  Parameters:
  value - the URI string to set
- getURI
  public String getURI()
  Returns the request URI.
  Returns:
  the URI string, or null if not set
- getParameterList
  public ParameterList getParameterList()
  Parses the URI query string and returns the parameters as a ParameterList.
  Returns:
  the ParameterList containing all query parameters, or an empty list if none exist
- getParameterValue
  public String getParameterValue(String name)
  Returns the value of the specified URI query parameter.
  Parameters:
  name - the parameter name
  Returns:
  the parameter value, or null if not found
- isSOAPAction
  public boolean isSOAPAction()
  Checks if this request has a SOAPAction header.
  Returns:
  true if the SOAPAction header is present, false otherwise
- setRequestHost
  public void setRequestHost(String host)
  Sets the host for this request.
  Parameters:
  host - the host string
- getRequestHost
  public String getRequestHost()
  Returns the request host.
  Returns:
  the host string
- setRequestPort
  public void setRequestPort(int host)
  Sets the port for this request.
  Parameters:
  host - the port number
- getRequestPort
  public int getRequestPort()
  Returns the request port.
  Returns:
  the port number
- setSocket
  public void setSocket(HTTPSocket value)
  Sets the HTTPSocket for this request.
  Parameters:
  value - the HTTPSocket to set
- getSocket
  public HTTPSocket getSocket()
  Returns the HTTPSocket for this request.
  Returns:
  the HTTPSocket, or null if not set
- getLocalAddress
  public String getLocalAddress()
  Returns the local address of the underlying socket.
  Returns:
  the local address string
- getLocalPort
  public int getLocalPort()
  Returns the local port of the underlying socket.
  Returns:
  the local port number
- parseRequestLine
  public boolean parseRequestLine(String lineStr)
  Parses an HTTP request line and extracts method, URI, and version.
  This method parses a request line in the format "METHOD URI VERSION" (e.g., "GET /path HTTP/1.1") and sets the corresponding properties on this HTTP request object.
  Parameters:
  lineStr - the request line string to parse
  Returns:
  true if parsing was successful and all three components were found, false otherwise
- getHTTPVersion
  public String getHTTPVersion()
  Returns the HTTP version string for this request.
  Returns:
  the HTTP version (e.g., "HTTP/1.1")
- getFirstLineString
  public String getFirstLineString()
  Returns the first line of the HTTP request (method, URI, and version).
  Returns:
  the request line string
- getHeader
  public String getHeader()
  Returns the complete HTTP header as a string.
  Returns:
  the header string including the request line and headers
- isKeepAlive
  public boolean isKeepAlive()
  Determines if this connection should be kept alive.
  Returns:
  true if keep-alive is enabled, false otherwise
- read
  public boolean read()
  Reads the HTTP request from the underlying socket.
  Returns:
  true if the request was read successfully, false otherwise
- post
  public boolean post(HTTPResponse httpRes)
  Posts an HTTP response back to the client.
  Parameters:
  httpRes - the HTTP response to send
  Returns:
  true if the response was sent successfully, false otherwise
- setBindHost
  public void setBindHost(String host)
  I2P - bind HTTP socket to specified local host address
  Parameters:
  host - null to not bind to a particular local address
- post
  public HTTPResponse post(String host, int port, boolean isKeepAlive)
  Posts this HTTP request to the specified host and port.
  Parameters:
  host - the target host
  port - the target port
  isKeepAlive - whether to keep the connection alive
  Returns:
  the HTTP response
- post
  public HTTPResponse post(String host, int port)
  Posts this HTTP request to the specified host and port with no keep-alive.
  Parameters:
  host - the target host
  port - the target port
  Returns:
  the HTTP response
- set
  public void set(HTTPRequest httpReq)
  Copies the contents of the given HTTP request into this request.
  Parameters:
  httpReq - the HTTP request to copy from
- returnResponse
  public boolean returnResponse(int statusCode)
  Sends an HTTP response with the specified status code and no content.
  This method creates a new HTTP response with the given status code, sets content length to 0, and sends it back to the client using the post(HTTPResponse) method. This is commonly used for error responses or responses that don't require a body.
  Parameters:
  statusCode - the HTTP status code to send (e.g., 200, 404, 500)
  Returns:
  true if the response was sent successfully, false otherwise
- returnOK
  public boolean returnOK()
  Sends an HTTP 200 OK response with no content.
  This is a convenience method that sends a 200 OK status code response, typically used to indicate successful request processing when no response body is needed.
  Returns:
  true if the response was sent successfully, false otherwise
- returnBadRequest
  public boolean returnBadRequest()
  Sends an HTTP 400 Bad Request response with no content.
  This is a convenience method that sends a 400 Bad Request status code response, typically used when the client request is malformed or cannot be understood by the server.
  Returns:
  true if the response was sent successfully, false otherwise
- toString
  public String toString()
  /////////////////////////////////////////////
  Overrides:
  toString in class Object
- print
  public void print()
  Prints the HTTP request to the debug message stream.
  This method outputs the complete HTTP request including headers and content to the debug logging system using Debug.message(). Useful for debugging HTTP request processing.

Field Summary

Constructor Summary

Method Summary

Methods inherited from class HTTPPacket

Methods inherited from class Object

Field Details

method

uri

requestHost

requestPort

httpSocket

postSocket

bindTo

Constructor Details

HTTPRequest

HTTPRequest

Method Details

setMethod

getMethod

isMethod

isGetRequest

isPostRequest

isHeadRequest

isSubscribeRequest

isUnsubscribeRequest

isNotifyRequest

setURI

setURI

getURI

getParameterList

getParameterValue

isSOAPAction

setRequestHost

getRequestHost

setRequestPort

getRequestPort

setSocket

getSocket

getLocalAddress

getLocalPort

parseRequestLine

getHTTPVersion

getFirstLineString

getHeader

isKeepAlive

read

post

setBindHost

post

post

set

returnResponse

returnOK

returnBadRequest

toString

print