SOAPResponse

org.cybergarage.soap.SOAPResponse

Direct Known Subclasses:: ControlResponse

public class SOAPResponseextends HTTPResponse

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

This class extends HTTPResponse to handle SOAP protocol responses used in UPnP control operations. It provides functionality for creating and parsing SOAP responses with proper XML formatting and envelope structure.

Key features:

SOAP envelope and body creation
XML content management
UTF-8 encoding support
HTTP response integration
Fault message handling

This class is used by UPnP devices to send action invocation responses to control points, enabling structured XML responses through SOAP messaging over HTTP.

Field Summary
Fields
Modifier and Type
Field
Description
private Node
rootNode
/////////////////////////////////////////////
Constructor Summary
Constructors
Constructor
Description
SOAPResponse()
Creates an empty response carrying a fresh SOAP envelope body.
SOAPResponse(HTTPResponse httpRes)
Copies the connection state of an HTTP response, replacing its payload with an empty SOAP envelope.
SOAPResponse(SOAPResponse soapRes)
Adopts the envelope node of another SOAP response.
Method Summary
Modifier and Type
Method
Description
Node
getBodyNode()
Get the SOAP body node.
Node
getEnvelopeNode()
Get the SOAP envelope node.
String
getFaultActor()
Get the SOAP fault actor string.
Node
getFaultActorNode()
Get the SOAP fault actor node.
String
getFaultCode()
Get the SOAP fault code string.
Node
getFaultCodeNode()
Get the SOAP fault code node.
Node
getFaultDetailNode()
Get the SOAP fault detail node.
Node
getFaultNode()
Get the SOAP fault node.
String
getFaultString()
Get the SOAP fault string.
Node
getFaultStringNode()
Get the SOAP fault string node.
Node
getMethodResponseNode(String name)
Get the method response node for the given name.
private Node
getRootNode()
The SOAP body's root node.
void
print()
Writes the response to the debug log, as text or as its root element.
void
setContent(Node node)
Set the content from an XML node.
void
setEnvelopeNode(Node node)
Set the SOAP envelope node.
private void
setRootNode(Node node)
Sets the SOAP body's root node.
Methods inherited from class HTTPResponse
getHeader, getStatusCode, getStatusLineString, isSuccessful, setStatusCode, toString
Modifier and Type
Method
Description
String
getHeader()
Return the full header string for this HTTP response.
int
getStatusCode()
Gets the HTTP status code of this response.
String
getStatusLineString()
Gets the status line string of this HTTP response.
boolean
isSuccessful()
Checks if this response has a successful status code.
void
setStatusCode(int code)
Sets the HTTP status code of this response.
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
- rootNode
  private Node rootNode
  /////////////////////////////////////////////
Constructor Details
- SOAPResponse
  public SOAPResponse()
  Creates an empty response carrying a fresh SOAP envelope body.
- SOAPResponse
  public SOAPResponse(HTTPResponse httpRes)
  Copies the connection state of an HTTP response, replacing its payload with an empty SOAP envelope.
  Parameters:
  httpRes - the response to copy the connection state from; its payload is discarded and replaced with an empty SOAP envelope
- SOAPResponse
  public SOAPResponse(SOAPResponse soapRes)
  Adopts the envelope node of another SOAP response.
  Parameters:
  soapRes - the response whose envelope node is adopted, not copied, by this one
Method Details
- setRootNode
  private void setRootNode(Node node)
  Sets the SOAP body's root node.
  Parameters:
  node - the new root node
- getRootNode
  private Node getRootNode()
  The SOAP body's root node.
  Returns:
  the root node
- setEnvelopeNode
  public void setEnvelopeNode(Node node)
  Set the SOAP envelope node.
  Parameters:
  node - the envelope node to set
- getEnvelopeNode
  public Node getEnvelopeNode()
  Get the SOAP envelope node.
  Returns:
  the envelope node, or null if not set
- getBodyNode
  public Node getBodyNode()
  Get the SOAP body node.
  Returns:
  the body node, or null if no envelope
- getMethodResponseNode
  public Node getMethodResponseNode(String name)
  Get the method response node for the given name.
  Parameters:
  name - the method name
  Returns:
  the response node, or null if not found
- getFaultNode
  public Node getFaultNode()
  Get the SOAP fault node.
  Returns:
  the fault node, or null if not found
- getFaultCodeNode
  public Node getFaultCodeNode()
  Get the SOAP fault code node.
  Returns:
  the fault code node, or null if not found
- getFaultStringNode
  public Node getFaultStringNode()
  Get the SOAP fault string node.
  Returns:
  the fault string node, or null if not found
- getFaultActorNode
  public Node getFaultActorNode()
  Get the SOAP fault actor node.
  Returns:
  the fault actor node, or null if not found
- getFaultDetailNode
  public Node getFaultDetailNode()
  Get the SOAP fault detail node.
  Returns:
  the fault detail node, or null if not found
- getFaultCode
  public String getFaultCode()
  Get the SOAP fault code string.
  Returns:
  the fault code, or empty string if not found
- getFaultString
  public String getFaultString()
  Get the SOAP fault string.
  Returns:
  the fault string, or empty string if not found
- getFaultActor
  public String getFaultActor()
  Get the SOAP fault actor string.
  Returns:
  the fault actor, or empty string if not found
- setContent
  public void setContent(Node node)
  Set the content from an XML node.
  Parameters:
  node - the XML node to set as content
- print
  public void print()
  Writes the response to the debug log, as text or as its root element.
  Overrides:
  print in class HTTPResponse

Field Summary

Constructor Summary

Method Summary

Methods inherited from class HTTPResponse

Methods inherited from class HTTPPacket

Methods inherited from class Object

Field Details

rootNode

Constructor Details

SOAPResponse

SOAPResponse

Method Details

setRootNode

getRootNode

setEnvelopeNode

getEnvelopeNode

getBodyNode

getMethodResponseNode

getFaultNode

getFaultCodeNode

getFaultStringNode

getFaultActorNode

getFaultDetailNode

getFaultCode

getFaultString

getFaultActor

setContent

print