SubscriptionResponse

org.cybergarage.upnp.event.SubscriptionResponse

public class SubscriptionResponseextends HTTPResponse

Represents a UPnP event subscription response.

This class extends HTTPResponse to handle GENA (General Event Notification Architecture) subscription responses for UPnP event notifications. It manages the response to SUBSCRIBE and UNSUBSCRIBE requests, including success and error handling.

Key features:

Subscription response status management
SID (Subscription ID) header handling
Timeout response management
Error response generation
UPnP server identification

This class is used by UPnP devices to respond to subscription requests from control points, providing subscription confirmation, timeout information, and error status when necessary.

Constructor Summary
Constructors
Constructor
Description
SubscriptionResponse()
Creates an empty response naming this library as the server.
SubscriptionResponse(HTTPResponse httpRes)
Wraps the response received from the subscriber.
Method Summary
All Methods
Modifier and Type
Method
Description
String
getSID()
Returns the subscription identifier from the SID header.
long
getTimeout()
Returns the subscription lifetime from the TIMEOUT header.
void
setErrorResponse(int code)
Sets the error status code and clears the body length.
void
setResponse(int code)
Sets the status code and clears the body length.
void
setSID(String id)
Writes the subscription identifier to the SID header.
void
setTimeout(long value)
Writes the subscription lifetime to the TIMEOUT header.
Methods inherited from class HTTPResponse
getHeader, getStatusCode, getStatusLineString, isSuccessful, print, 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
print()
Outputs the full HTTP response to the debug log.
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

Constructor Details
- SubscriptionResponse
  public SubscriptionResponse()
  Creates an empty response naming this library as the server.
- SubscriptionResponse
  public SubscriptionResponse(HTTPResponse httpRes)
  Wraps the response received from the subscriber.
  Parameters:
  httpRes - the response received from the subscriber, holding the headers
Method Details
- setResponse
  public void setResponse(int code)
  Sets the status code and clears the body length.
  Parameters:
  code - the HTTP status code to record, sent with an empty body
- setErrorResponse
  public void setErrorResponse(int code)
  Sets the error status code and clears the body length.
  Parameters:
  code - the HTTP error status code to record, sent with an empty body
- setSID
  public void setSID(String id)
  Writes the subscription identifier to the SID header.
  Parameters:
  id - the bare subscription identifier to publish in the SID header
- getSID
  public String getSID()
  Returns the subscription identifier from the SID header.
  Returns:
  the subscription identifier from the SID header, or the empty string when absent
- setTimeout
  public void setTimeout(long value)
  Writes the subscription lifetime to the TIMEOUT header.
  Parameters:
  value - the subscription lifetime in seconds, or INFINITE_VALUE for unlimited
- getTimeout
  public long getTimeout()
  Returns the subscription lifetime from the TIMEOUT header.
  Returns:
  the subscription lifetime in seconds from the TIMEOUT header, or INFINITE_VALUE when the header is absent or unparseable

Constructor Summary

Method Summary

Methods inherited from class HTTPResponse

Methods inherited from class HTTPPacket

Methods inherited from class Object

Constructor Details

SubscriptionResponse

Method Details

setResponse

setErrorResponse

setSID

getSID

setTimeout

getTimeout