ControlResponse

org.cybergarage.upnp.control.ControlResponse

Direct Known Subclasses:: ActionResponse, QueryResponse

public class ControlResponseextends SOAPResponse

Represents a UPnP control response. Extends SOAPResponse to provide UPnP-specific error handling and fault response functionality.

Field Summary
Modifier and Type
Field
Description
static final String
FAULT_CODE
Default fault code for UPnP errors
static final String
FAULT_STRING
Default fault string for UPnP errors
private UPnPStatus
upnpErr
/////////////////////////////////////////////
Constructor Summary
Constructors
Constructor
Description
ControlResponse()
/////////////////////////////////////////////
ControlResponse(SOAPResponse soapRes)
Constructs a ControlResponse from a SOAP response.
Method Summary
Modifier and Type
Method
Description
private Node
createFaultResponseNode(int errCode)
Builds a SOAP fault element with a default description.
private Node
createFaultResponseNode(int errCode, String errDescr)
Builds the SOAP fault node for an error.
UPnPStatus
getUPnPError()
Gets the complete UPnP error status from the response.
int
getUPnPErrorCode()
Gets the UPnP error code from the response.
private Node
getUPnPErrorCodeNode()
Gets the UPnP error code node.
String
getUPnPErrorDescription()
Gets the UPnP error description from the response.
private Node
getUPnPErrorDescriptionNode()
Gets the UPnP error description node.
private Node
getUPnPErrorNode()
Gets the UPnP error node from the fault detail.
void
setFaultResponse(int errCode)
Sets a fault response with the specified error code.
void
setFaultResponse(int errCode, String errDescr)
Sets a fault response with the specified error code and description.
Methods inherited from class SOAPResponse
getBodyNode, getEnvelopeNode, getFaultActor, getFaultActorNode, getFaultCode, getFaultCodeNode, getFaultDetailNode, getFaultNode, getFaultString, getFaultStringNode, getMethodResponseNode, print, setContent, setEnvelopeNode
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.
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.
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
- FAULT_CODE
  public static final String FAULT_CODE
  Default fault code for UPnP errors
  See Also:
  Constant Field Values
- FAULT_STRING
  public static final String FAULT_STRING
  Default fault string for UPnP errors
  See Also:
  Constant Field Values
- upnpErr
  private UPnPStatus upnpErr
  /////////////////////////////////////////////
Constructor Details
- ControlResponse
  public ControlResponse()
  /////////////////////////////////////////////
- ControlResponse
  public ControlResponse(SOAPResponse soapRes)
  Constructs a ControlResponse from a SOAP response.
  Parameters:
  soapRes - the SOAP response to wrap
Method Details
- setFaultResponse
  public void setFaultResponse(int errCode, String errDescr)
  Sets a fault response with the specified error code and description.
  Parameters:
  errCode - the UPnP error code
  errDescr - the error description
- setFaultResponse
  public void setFaultResponse(int errCode)
  Sets a fault response with the specified error code. The error description is automatically generated from the error code.
  Parameters:
  errCode - the UPnP error code
- createFaultResponseNode
  private Node createFaultResponseNode(int errCode, String errDescr)
  Builds the SOAP fault node for an error.
  Parameters:
  errCode - the UPnP error code
  errDescr - the description of the error
  Returns:
  the fault response node
- createFaultResponseNode
  private Node createFaultResponseNode(int errCode)
  Builds a SOAP fault element with a default description.
  Parameters:
  errCode - the UPnP error number
  Returns:
  the fault node
- getUPnPErrorNode
  private Node getUPnPErrorNode()
  Gets the UPnP error node from the fault detail.
  Returns:
  the UPnP error node, or null if not found
- getUPnPErrorCodeNode
  private Node getUPnPErrorCodeNode()
  Gets the UPnP error code node.
  Returns:
  the error code node, or null if not found
- getUPnPErrorDescriptionNode
  private Node getUPnPErrorDescriptionNode()
  Gets the UPnP error description node.
  Returns:
  the error description node, or null if not found
- getUPnPErrorCode
  public int getUPnPErrorCode()
  Gets the UPnP error code from the response.
  Returns:
  the error code, or -1 if not found or invalid
- getUPnPErrorDescription
  public String getUPnPErrorDescription()
  Gets the UPnP error description from the response.
  Returns:
  the error description, or empty string if not found
- getUPnPError
  public UPnPStatus getUPnPError()
  Gets the complete UPnP error status from the response.
  Returns:
  a UPnPStatus object containing the error code and description

Field Summary

Constructor Summary

Method Summary

Methods inherited from class SOAPResponse

Methods inherited from class HTTPResponse

Methods inherited from class HTTPPacket

Methods inherited from class Object

Field Details

FAULT_CODE

FAULT_STRING

upnpErr

Constructor Details

ControlResponse

Method Details

setFaultResponse

setFaultResponse

createFaultResponseNode

createFaultResponseNode

getUPnPErrorNode

getUPnPErrorCodeNode

getUPnPErrorDescriptionNode

getUPnPErrorCode

getUPnPErrorDescription

getUPnPError