SOAPRequest

org.cybergarage.soap.SOAPRequest

Direct Known Subclasses:: ControlRequest, NotifyRequest

public class SOAPRequestextends HTTPRequest

Represents a SOAP (Simple Object Access Protocol) request message.

This class extends HTTPRequest to handle SOAP protocol messages used in UPnP control operations. It provides functionality for creating and parsing SOAP requests with proper XML formatting and SOAP action headers.

Key features:

SOAP action header management
XML content parsing and generation
SOAP envelope and body handling
UTF-8 encoding support
HTTP protocol integration

This class is used by UPnP control points to send action invocation requests to UPnP devices, enabling remote procedure calls through SOAP messaging over HTTP.

Field Summary
Fields
Modifier and Type
Field
Description
private Node
rootNode
/////////////////////////////////////////////
private static final String
SOAPACTION
Header naming the action a SOAP request carries.
Constructor Summary
Constructors
Constructor
Description
SOAPRequest()
Creates a POST request carrying the SOAP content type.
SOAPRequest(HTTPRequest httpReq)
Adopts the headers and body of an existing HTTP request.
Method Summary
Modifier and Type
Method
Description
Node
getBodyNode()
Return the SOAP body node.
Node
getEnvelopeNode()
Return the SOAP envelope node.
private Node
getRootNode()
Parses and caches the body if it has not been parsed.
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.
private void
setRootNode(Node node)
Records the parsed body of the request.
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

Field Details
- SOAPACTION
  private static final String SOAPACTION
  Header naming the action a SOAP request carries.
  See Also:
  Constant Field Values
- rootNode
  private Node rootNode
  /////////////////////////////////////////////
Constructor Details
- SOAPRequest
  public SOAPRequest()
  Creates a POST request carrying the SOAP content type.
- SOAPRequest
  public SOAPRequest(HTTPRequest httpReq)
  Adopts the headers and body of an existing HTTP request.
  Parameters:
  httpReq - the HTTP request whose headers and body this SOAP request copies
Method Details
- setSOAPAction
  public void setSOAPAction(String action)
  Set the SOAP action header.
  Parameters:
  action - the SOAP action to set
- getSOAPAction
  public String getSOAPAction()
  Return the SOAP action header value.
  Returns:
  the SOAP action header value
- isSOAPAction
  public boolean isSOAPAction(String value)
  Check if the SOAP action matches the given value.
  Parameters:
  value - value to compare
  Returns:
  true if the SOAP action matches the given value
- postMessage
  public SOAPResponse postMessage(String host, int port)
  Post a SOAP message to the target host and port.
  Parameters:
  host - the target host
  port - the target port
  Returns:
  the SOAP response
- setRootNode
  private void setRootNode(Node node)
  Records the parsed body of the request.
  Parameters:
  node - the root of the SOAP body
- getRootNode
  private Node getRootNode()
  Parses and caches the body if it has not been parsed.
  Returns:
  the root of the SOAP body
- setEnvelopeNode
  public void setEnvelopeNode(Node node)
  Set the SOAP envelope node.
  Parameters:
  node - the envelope node to set
- getEnvelopeNode
  public Node getEnvelopeNode()
  Return the SOAP envelope node.
  Returns:
  the envelope node
- getBodyNode
  public Node getBodyNode()
  Return the SOAP body node.
  Returns:
  the body node, or null if not available
- setContent
  public void setContent(Node node)
  Set the XML content from a node.
  Parameters:
  node - the node to set as content
- print
  public void print()
  Writes the request and its root element to the debug log.
  Overrides:
  print in class HTTPRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class HTTPRequest

Methods inherited from class HTTPPacket

Methods inherited from class Object

Field Details

SOAPACTION

rootNode

Constructor Details

SOAPRequest

Method Details

setSOAPAction

getSOAPAction

isSOAPAction

postMessage

setRootNode

getRootNode

setEnvelopeNode

getEnvelopeNode

getBodyNode

setContent

print