All Superinterfaces:

HttpMessage, MessageHeaders

All Known Implementing Classes:

SSDPRequest, SSDPResponse
```
public interface SSDPMessage
extends HttpMessage
```
SSDP HttpMessage interface definition.

Author:

Allen D. Ball

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`AL`	SSDP message header name.
`static String`	`BOOTID_UPNP_ORG`	SSDP message header name.
`static String`	`CACHE_CONTROL`	SSDP message header name.
`static String`	`CONFIGID_UPNP_ORG`	SSDP message header name.
`static String`	`DATE`	SSDP message header name.
`static String`	`EOL`	`SSDPMessage` end-of-line sequence.
`static String`	`EOM`	`SSDPMessage` end-of-message sequence.
`static String`	`EXT`	SSDP message header name.
`static String`	`HOST`	SSDP message header name.
`static String`	`LOCATION`	SSDP message header name.
`static String`	`MAN`	SSDP message header name.
`static String`	`MAX_AGE`	HTTP cache control key.
`static String`	`MX`	SSDP message header name.
`static String`	`NEXTBOOTID_UPNP_ORG`	SSDP message header name.
`static String`	`NT`	SSDP message header name.
`static String`	`NTS`	SSDP message header name.
`static String`	`SEARCHPORT_UPNP_ORG`	SSDP message header name.
`static String`	`SECURELOCATION_UPNP_ORG`	SSDP message header name.
`static String`	`SERVER`	SSDP message header name.
`static String`	`SSDP_ALIVE`	SSDP `NTS` value.
`static URI`	`SSDP_ALL`	SSDP `ST` value.
`static String`	`SSDP_BYEBYE`	SSDP `NTS` value.
`static String`	`SSDP_UPDATE`	SSDP `NTS` value.
`static String`	`ST`	SSDP message header name.
`static String`	`USER_AGENT`	SSDP message header name.
`static String`	`USN`	SSDP message header name.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`long`	`getExpiration()`	Method to get the expiration time for `this` `SSDPMessage`.
`static long`	`getExpiration(SSDPMessage message, long timestamp)`	Implementation method for `getExpiration()`.
`default String`	`getHeaderParameterValue(String name, String parameter)`	Method to find the first `Header` matching `name` with a parameter matching `parameter` and return that parameter value.
`default <T> T`	`getHeaderParameterValue(Function<String,T> function, String name, String parameter)`	Method to find the first `Header` matching `name` with a parameter matching `parameter` and return that parameter value converted with `function`.
`default String`	`getHeaderValue(String... names)`	Method to find the first `Header` matching `names` and return that value.
`default <T> T`	`getHeaderValue(Function<String,T> function, String... names)`	Method to find the first `Header` matching `names` and return the value converted with `function`.
`default URI`	`getLocation()`	Method to get the location `URI`.
`default URI`	`getNT()`	Method to get the "NT" `URI`.
`default URI`	`getST()`	Method to get the "ST" `URI`.
`default URI`	`getUSN()`	Method to get the "USN" `URI`.
`static List<CharArrayBuffer>`	`parse(DatagramPacket packet)`	Static method to parse a `DatagramPacket` to a `List` of lines (`CharArrayBuffer`s).
`static CharArrayBuffer`	`toCharArrayBuffer(String string)`	Static method to convert a `String` to a `CharArrayBuffer`.
`static CharArrayBuffer`	`toCharArrayBuffer(DatagramPacket packet)`	Static method to convert a `DatagramPacket` to a `CharArrayBuffer`.

Methods inherited from interface org.apache.hc.core5.http.HttpMessage
addHeader, addHeader, getVersion, removeHeader, removeHeaders, setHeader, setHeader, setHeaders, setVersion

Methods inherited from interface org.apache.hc.core5.http.MessageHeaders
containsHeader, countHeaders, getFirstHeader, getHeader, getHeaders, getHeaders, getLastHeader, headerIterator, headerIterator

- Field Detail
  - AL
```
static final String AL
```
    SSDP message header name.
    
    See Also:
    
    Constant Field Values
  - CACHE_CONTROL
```
static final String CACHE_CONTROL
```
    SSDP message header name.
  - DATE
```
static final String DATE
```
    SSDP message header name.
    
    See Also:
    
    Constant Field Values
  - EXT
```
static final String EXT
```
    SSDP message header name.
    
    See Also:
    
    Constant Field Values
  - HOST
```
static final String HOST
```
    SSDP message header name.
  - LOCATION
```
static final String LOCATION
```
    SSDP message header name.
  - MAN
```
static final String MAN
```
    SSDP message header name.
    
    See Also:
    
    Constant Field Values
  - MX
```
static final String MX
```
    SSDP message header name.
    
    See Also:
    
    Constant Field Values
  - NT
```
static final String NT
```
    SSDP message header name.
    
    See Also:
    
    Constant Field Values
  - NTS
```
static final String NTS
```
    SSDP message header name.
    
    See Also:
    
    Constant Field Values
  - SERVER
```
static final String SERVER
```
    SSDP message header name.
  - ST
```
static final String ST
```
    SSDP message header name.
    
    See Also:
    
    Constant Field Values
  - USN
```
static final String USN
```
    SSDP message header name.
    
    See Also:
    
    Constant Field Values
  - BOOTID_UPNP_ORG
```
static final String BOOTID_UPNP_ORG
```
    SSDP message header name.
    
    See Also:
    
    Constant Field Values
  - NEXTBOOTID_UPNP_ORG
```
static final String NEXTBOOTID_UPNP_ORG
```
    SSDP message header name.
    
    See Also:
    
    Constant Field Values
  - CONFIGID_UPNP_ORG
```
static final String CONFIGID_UPNP_ORG
```
    SSDP message header name.
    
    See Also:
    
    Constant Field Values
  - SEARCHPORT_UPNP_ORG
```
static final String SEARCHPORT_UPNP_ORG
```
    SSDP message header name.
    
    See Also:
    
    Constant Field Values
  - USER_AGENT
```
static final String USER_AGENT
```
    SSDP message header name.
    
    See Also:
    
    Constant Field Values
  - SECURELOCATION_UPNP_ORG
```
static final String SECURELOCATION_UPNP_ORG
```
    SSDP message header name.
    
    See Also:
    
    Constant Field Values
  - SSDP_ALIVE
```
static final String SSDP_ALIVE
```
    SSDP NTS value.
    
    See Also:
    
    Constant Field Values
  - SSDP_UPDATE
```
static final String SSDP_UPDATE
```
    SSDP NTS value.
    
    See Also:
    
    Constant Field Values
  - SSDP_BYEBYE
```
static final String SSDP_BYEBYE
```
    SSDP NTS value.
    
    See Also:
    
    Constant Field Values
  - SSDP_ALL
```
static final URI SSDP_ALL
```
    SSDP ST value.
  - MAX_AGE
```
static final String MAX_AGE
```
    HTTP cache control key.
    
    See Also:
    
    Constant Field Values
  - EOL
```
static final String EOL
```
    SSDPMessage end-of-line sequence.
    
    See Also:
    
    Constant Field Values
  - EOM
```
static final String EOM
```
    SSDPMessage end-of-message sequence.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - parse
```
static List<CharArrayBuffer> parse(DatagramPacket packet)
```
    Static method to parse a DatagramPacket to a List of lines (CharArrayBuffers).
    
    Parameters:
    
    packet - The DatagramPacket.
    
    Returns:
    
    The List of parsed lines as CharArrayBuffers.
  - toCharArrayBuffer
```
static CharArrayBuffer toCharArrayBuffer(DatagramPacket packet)
```
    Static method to convert a DatagramPacket to a CharArrayBuffer.
    
    Parameters:
    
    packet - The DatagramPacket.
    
    Returns:
    
    The CharArrayBuffer.
  - toCharArrayBuffer
```
static CharArrayBuffer toCharArrayBuffer(String string)
```
    Static method to convert a String to a CharArrayBuffer.
    
    Parameters:
    
    string - The String.
    
    Returns:
    
    The CharArrayBuffer.
  - getExpiration
```
long getExpiration()
```
    Method to get the expiration time for this SSDPMessage.
    
    Returns:
    
    The expiration time (milliseconds since the UNIX epoch).
  - getHeaderValue
```
default String getHeaderValue(String... names)
```
    Method to find the first Header matching names and return that value.
    
    Parameters:
    
    names - The candidate Header names.
    
    Returns:
    
    The value or null if no header found.
  - getHeaderValue
```
default <T> T getHeaderValue(Function<String,T> function,
                             String... names)
```
    Method to find the first Header matching names and return the value converted with function.
    
    Type Parameters:
    
    T - The target type.
    
    Parameters:
    
    function - The conversion Function.
    
    names - The candidate Header names.
    
    Returns:
    
    The converted value or null if no header found.
  - getHeaderParameterValue
```
default String getHeaderParameterValue(String name,
                                       String parameter)
```
    Method to find the first Header matching name with a parameter matching parameter and return that parameter value.
    
    Parameters:
    
    name - The target Header name.
    
    parameter - The target parameter name.
    
    Returns:
    
    The value or null if no header/parameter combination is found.
  - getHeaderParameterValue
```
default <T> T getHeaderParameterValue(Function<String,T> function,
                                      String name,
                                      String parameter)
```
    Method to find the first Header matching name with a parameter matching parameter and return that parameter value converted with function.
    
    Type Parameters:
    
    T - The target type.
    
    Parameters:
    
    name - The target Header name.
    
    parameter - The target parameter name.
    
    Returns:
    
    The value or null if no header/parameter combination is found.
  - getNT
```
default URI getNT()
```
    Method to get the "NT" URI.
    
    Returns:
    
    The "NT" URI.
  - getST
```
default URI getST()
```
    Method to get the "ST" URI.
    
    Returns:
    
    The "ST" URI.
  - getUSN
```
default URI getUSN()
```
    Method to get the "USN" URI.
    
    Returns:
    
    The "USN" URI.
  - getLocation
```
default URI getLocation()
```
    Method to get the location URI.
    
    Returns:
    
    The service location URI.
  - getExpiration
```
static long getExpiration(SSDPMessage message,
                          long timestamp)
```
    Implementation method for getExpiration().
    
    Parameters:
    
    message - The SSDPMessage.
    
    timestamp - The message's timestamp.
    
    Returns:
    
    The expiration time (milliseconds since the UNIX epoch).

Interface SSDPMessage

Field Summary

Method Summary

Methods inherited from interface org.apache.hc.core5.http.HttpMessage

Methods inherited from interface org.apache.hc.core5.http.MessageHeaders

Field Detail

AL

CACHE_CONTROL

DATE

EXT

HOST

LOCATION

MAN

MX

NT

NTS

SERVER

ST

USN

BOOTID_UPNP_ORG

NEXTBOOTID_UPNP_ORG

CONFIGID_UPNP_ORG

SEARCHPORT_UPNP_ORG

USER_AGENT

SECURELOCATION_UPNP_ORG

SSDP_ALIVE

SSDP_UPDATE

SSDP_BYEBYE

SSDP_ALL

MAX_AGE

EOL

EOM

Method Detail

parse

toCharArrayBuffer

toCharArrayBuffer

getExpiration

getHeaderValue

getHeaderValue

getHeaderParameterValue

getHeaderParameterValue

getNT

getST

getUSN

getLocation

getExpiration