SSDPResponse

org.cybergarage.upnp.ssdp.SSDPResponse

Direct Known Subclasses:: SSDPSearchResponse

public class SSDPResponseextends HTTPResponse

Represents an SSDP response message.

This class extends HTTPResponse to handle SSDP (Simple Service Discovery Protocol) response messages used in UPnP device discovery. It manages the creation and parsing of responses to M-SEARCH requests from control points.

Key features:

SSDP response header management
ST (Search Target) header handling
USN (Unique Service Name) header management
MYNAME header support for Intel compatibility
HTTP/1.1 version compliance

This class is used by UPnP devices to respond to discovery searches from control points, providing information about device capabilities and availability. It handles both standard UPnP responses and vendor-specific extensions.

Constructor Summary
Constructors
Constructor
Description
SSDPResponse()
Creates an empty response declaring HTTP 1.1.
SSDPResponse(InputStream in)
Creates a response whose headers are parsed from a stream.
Method Summary
All Methods
Modifier and Type
Method
Description
int
getBootId()
Gets the boot identifier header.
String
getHeader()
Renders the whole response as a status line, headers and blank line.
int
getLeaseTime()
Gets the advertisement lifetime from the CACHE-CONTROL header.
String
getLocation()
Gets the Location header.
String
getMYNAME()
Gets the MYNAME header.
String
getST()
Gets the search target header.
String
getUSN()
Gets the unique service name header.
void
setBootId(int bootId)
Sets the boot identifier header.
void
setLeaseTime(int len)
Sets the CACHE-CONTROL max-age header from a lifetime in seconds.
void
setLocation(String value)
Sets the Location header to a device description URL.
void
setMYNAME(String value)
Sets the MYNAME header, Intel's friendly-name extension.
void
setST(String value)
Sets the search target header.
void
setUSN(String value)
Sets the unique service name header.
Methods inherited from class HTTPResponse
getStatusCode, getStatusLineString, isSuccessful, print, setStatusCode, toString
Modifier and Type
Method
Description
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
- SSDPResponse
  public SSDPResponse()
  Creates an empty response declaring HTTP 1.1.
- SSDPResponse
  public SSDPResponse(InputStream in)
  Creates a response whose headers are parsed from a stream.
  Parameters:
  in - the response stream to parse the headers from
Method Details
- setST
  public void setST(String value)
  Sets the search target header.
  Parameters:
  value - the search target, identifying which service answered
- getST
  public String getST()
  Gets the search target header.
  Returns:
  the ST header, or null if this response carries none
- setLocation
  public void setLocation(String value)
  Sets the Location header to a device description URL.
  Parameters:
  value - the URL of the device description document that was searched
- getLocation
  public String getLocation()
  Gets the Location header.
  Returns:
  the Location header, or null if this response carries none
- setUSN
  public void setUSN(String value)
  Sets the unique service name header.
  Parameters:
  value - the unique service name identifying the answering device
- getUSN
  public String getUSN()
  Gets the unique service name header.
  Returns:
  the USN header, or null if this response carries none
- setMYNAME
  public void setMYNAME(String value)
  Sets the MYNAME header, Intel's friendly-name extension.
  Parameters:
  value - the friendly device name, for Intel's MYNAME extension
- getMYNAME
  public String getMYNAME()
  Gets the MYNAME header.
  Returns:
  the MYNAME header, or null if this response carries none
- setLeaseTime
  public void setLeaseTime(int len)
  Sets the CACHE-CONTROL max-age header from a lifetime in seconds.
  Parameters:
  len - the advertisement lifetime in seconds, advertised as max-age
- getLeaseTime
  public int getLeaseTime()
  Gets the advertisement lifetime from the CACHE-CONTROL header.
  Returns:
  the max-age value in seconds, 0 if the header is absent or unparsable
- setBootId
  public void setBootId(int bootId)
  Sets the boot identifier header.
  Parameters:
  bootId - the device's boot identifier, bumped on each reboot
- getBootId
  public int getBootId()
  Gets the boot identifier header.
  Returns:
  the BOOTID.UPNP.ORG value, 0 if this response carries none
- getHeader
  public String getHeader()
  Renders the whole response as a status line, headers and blank line.
  Overrides:
  getHeader in class HTTPResponse
  Returns:
  the header string

Constructor Summary

Method Summary

Methods inherited from class HTTPResponse

Methods inherited from class HTTPPacket

Methods inherited from class Object

Constructor Details

SSDPResponse

Method Details

setST

getST

setLocation

getLocation

setUSN

getUSN

setMYNAME

getMYNAME

setLeaseTime

getLeaseTime

setBootId

getBootId

getHeader