HTTPRequest (Javadocs [I2P+ 2.13.0+]

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

Direct Known Subclasses:
SOAPRequest, SSDPRequest, SubscriptionRequest
```
public class HTTPRequest
extends HTTPPacket
```
HTTP request message with method, URI, headers, and content body.

Constructor Summary

Constructors
Constructor and Description
`HTTPRequest()`
`HTTPRequest(HTTPSocket httpSock)` Creates an HTTP request from the given socket's input stream.
`HTTPRequest(InputStream in)` Parses an HTTP request from the given input stream.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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.
`boolean`	`post(HTTPResponse httpRes)` Posts an HTTP response back to the client.
`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.
`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 org.cybergarage.http.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

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

- Constructor Detail
  - HTTPRequest
```
public HTTPRequest()
```
  - HTTPRequest
```
public HTTPRequest(HTTPSocket httpSock)
```
    Creates an HTTP request from the given socket's input stream.
  - HTTPRequest
```
public HTTPRequest(InputStream in)
```
    Parses an HTTP request from the given input stream.
- Method Detail
  - 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
  - getHTTPVersion
```
public String getHTTPVersion()
```
    Returns the HTTP version string for this request.
    Returns:
    the HTTP version (e.g., "HTTP/1.1")
  - 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
  - getMethod
```
public String getMethod()
```
    Returns the HTTP method.
    Returns:
    the HTTP method 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
  - getRequestHost
```
public String getRequestHost()
```
    Returns the request host.
    Returns:
    the host string
  - getRequestPort
```
public int getRequestPort()
```
    Returns the request port.
    Returns:
    the port number
  - getSocket
```
public HTTPSocket getSocket()
```
    Returns the HTTPSocket for this request.
    Returns:
    the HTTPSocket, or null if not set
  - getURI
```
public String getURI()
```
    Returns the request URI.
    Returns:
    the URI string, or null if not set
  - isGetRequest
```
public boolean isGetRequest()
```
    Determines if this is a GET request.
    Returns:
    true if the method is GET, false otherwise
  - isHeadRequest
```
public boolean isHeadRequest()
```
    Determines if this is a HEAD request.
    Returns:
    true if the method is HEAD, false otherwise
  - isKeepAlive
```
public boolean isKeepAlive()
```
    Determines if this connection should be kept alive.
    Returns:
    true if keep-alive is enabled, false otherwise
  - 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
  - isNotifyRequest
```
public boolean isNotifyRequest()
```
    Determines if this is a NOTIFY request.
    Returns:
    true if the method is NOTIFY, false otherwise
  - isPostRequest
```
public boolean isPostRequest()
```
    Determines if this is a POST request.
    Returns:
    true if the method is POST, false otherwise
  - isSOAPAction
```
public boolean isSOAPAction()
```
    Checks if this request has a SOAPAction header.
    Returns:
    true if the SOAPAction header is present, 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
  - 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
  - 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
  - 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
  - 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
  - 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.
  - read
```
public boolean read()
```
    Reads the HTTP request from the underlying socket.
    Returns:
    true if the request was read 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
  - 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
  - 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() 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
  - 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
  - setBindHost
```
public void setBindHost(String host)
```
    I2P - bind HTTP socket to specified local host address
    Parameters:
    host - null to not bind to a particlar local address
  - setMethod
```
public void setMethod(String value)
```
    Sets the HTTP method (e.g., GET, POST).
    Parameters:
    value - the HTTP method string
  - setRequestHost
```
public void setRequestHost(String host)
```
    Sets the host for this request.
    Parameters:
    host - the host string
  - setRequestPort
```
public void setRequestPort(int host)
```
    Sets the port for this request.
    Parameters:
    host - the port number
  - setSocket
```
public void setSocket(HTTPSocket value)
```
    Sets the HTTPSocket for this request.
    Parameters:
    value - the HTTPSocket to set
  - 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
  - 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()
  - toString
```
public String toString()
```
    Overrides:
    toString in class Object

Class HTTPRequest

Constructor Summary

Method Summary

Methods inherited from class org.cybergarage.http.HTTPPacket

Methods inherited from class java.lang.Object

Constructor Detail

HTTPRequest

HTTPRequest

HTTPRequest

Method Detail

getFirstLineString

getHeader

getHTTPVersion

getLocalAddress

getLocalPort

getMethod

getParameterList

getParameterValue

getRequestHost

getRequestPort

getSocket

getURI

isGetRequest

isHeadRequest

isKeepAlive

isMethod

isNotifyRequest

isPostRequest

isSOAPAction

isSubscribeRequest

isUnsubscribeRequest

parseRequestLine

post

post

post

print

read

returnBadRequest

returnOK

returnResponse

set

setBindHost

setMethod

setRequestHost

setRequestPort

setSocket

setURI

setURI

toString