ActionRequest

org.cybergarage.upnp.control.ActionRequest

public class ActionRequestextends ControlRequest

Represents a UPnP action control request. Extends ControlRequest to provide action-specific functionality.

Constructor Summary
Constructors
Constructor
Description
ActionRequest()
/////////////////////////////////////////////
ActionRequest(HTTPRequest httpReq)
Constructs an ActionRequest from an HTTP request.
Method Summary
Modifier and Type
Method
Description
private Node
createContentNode(Service service, Action action, ArgumentList argList)
Creates the response content node for one action.
String
getActionName()
Gets the action name from the request.
Node
getActionNode()
Gets the action node from the request.
ArgumentList
getArgumentList()
Gets the argument list from the request.
ActionResponse
post()
Posts the action request and gets the response.
void
setRequest(Action action, ArgumentList argList)
Sets the request with the specified action and argument list.
Methods inherited from class ControlRequest
isActionControl, isQueryControl, setRequestHost
Modifier and Type
Method
Description
boolean
isActionControl()
Checks if this is an action control request.
boolean
isQueryControl()
Checks if this is a query control request.
protected void
setRequestHost(Service service)
Sets the request host and port for the specified service.
Methods inherited from class SOAPRequest
getBodyNode, getEnvelopeNode, getSOAPAction, isSOAPAction, postMessage, print, setContent, setEnvelopeNode, setSOAPAction
Modifier and Type
Method
Description
Node
getBodyNode()
Return the SOAP body node.
Node
getEnvelopeNode()
Return the SOAP envelope node.
String
getSOAPAction()
Return the SOAP action header value.
boolean
isSOAPAction(String value)
Check if the SOAP action matches the given value.
SOAPResponse
postMessage(String host, int port)
Post a SOAP message to the target host and port.
void
print()
Writes the request and its root element to the debug log.
void
setContent(Node node)
Set the XML content from a node.
void
setEnvelopeNode(Node node)
Set the SOAP envelope node.
void
setSOAPAction(String action)
Set the SOAP action header.
Methods inherited from class HTTPRequest
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, read, returnBadRequest, returnOK, returnResponse, set, setBindHost, setMethod, setRequestHost, setRequestPort, setSocket, setURI, setURI, toString
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.
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

Constructor Details
- ActionRequest
  public ActionRequest()
  /////////////////////////////////////////////
- ActionRequest
  public ActionRequest(HTTPRequest httpReq)
  Constructs an ActionRequest from an HTTP request.
  Parameters:
  httpReq - the HTTP request to wrap
Method Details
- getActionNode
  public Node getActionNode()
  Gets the action node from the request.
  Returns:
  the action node
- getActionName
  public String getActionName()
  Gets the action name from the request.
  Returns:
  the action name
- getArgumentList
  public ArgumentList getArgumentList()
  Gets the argument list from the request.
  Returns:
  the argument list
- setRequest
  public void setRequest(Action action, ArgumentList argList)
  Sets the request with the specified action and argument list.
  Parameters:
  action - the action to set
  argList - the argument list
- createContentNode
  private Node createContentNode(Service service, Action action, ArgumentList argList)
  Creates the response content node for one action.
  Parameters:
  service - the service the action belongs to, supplying the service type
  action - the action to describe, supplying the action name
  argList - the argument list, each argument becoming a child node
  Returns:
  the created content node
- post
  public ActionResponse post()
  Posts the action request and gets the response.
  Returns:
  the action response

Constructor Summary

Method Summary

Methods inherited from class ControlRequest

Methods inherited from class SOAPRequest

Methods inherited from class HTTPRequest

Methods inherited from class HTTPPacket

Methods inherited from class Object

Constructor Details

ActionRequest

Method Details

getActionNode

getActionName

getArgumentList

setRequest

createContentNode

post