ball.upnp.ssdp

Class SSDPRequest

java.lang.Object

org.apache.http.message.AbstractHttpMessage

org.apache.http.message.BasicHttpRequest

ball.upnp.ssdp.SSDPRequest

All Implemented Interfaces:

SSDPMessage, HttpMessage, HttpRequest, HttpStatus

public class SSDPRequest
extends BasicHttpRequest
implements SSDPMessage

SSDP HttpRequest implementation.

Bean Property Summary

Name	Mode	Type	isHidden	isBound	isConstrained
MX	R	int	false	false	false
allHeaders	R	Header[]	false	false	false
expiration	R	long	false	false	false
header	W	Header	false	false	false
headers	W	Header[]	false	false	false
method	R	String	false	false	false
params	RW	HttpParams	false	false	false
protocolVersion	R	ProtocolVersion	false	false	false
requestLine	R	RequestLine	false	false	false
socketAddress	R	SocketAddress	false	false	false

Version:

$Revision: 7215 $

Author:

Allen D. Ball

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SSDPRequest.Method SSDPRequest enumerated SSDPRequest.Methods.

Field Summary

Fields inherited from class org.apache.http.message.AbstractHttpMessage

headergroup, params

Fields inherited from interface ball.upnp.ssdp.SSDPMessage

AL, BOOTID_UPNP_ORG, CACHE_CONTROL, CONFIGID_UPNP_ORG, DATE, EOL, EOM, EXT, GENERATOR, HOST, LOCATION, MAN, MAX_AGE, MX, NEXTBOOTID_UPNP_ORG, NT, NTS, SEARCHPORT_UPNP_ORG, SECURELOCATION_UPNP_ORG, SERVER, SSDP_ALIVE, SSDP_ALL, SSDP_BYEBYE, SSDP_UPDATE, ST, USER_AGENT, USN

Fields inherited from interface org.apache.http.HttpStatus

SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FAILED_DEPENDENCY, SC_FORBIDDEN, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INSUFFICIENT_SPACE_ON_RESOURCE, SC_INSUFFICIENT_STORAGE, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_LOCKED, SC_METHOD_FAILURE, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTI_STATUS, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROCESSING, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_TIMEOUT, SC_REQUEST_TOO_LONG, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNPROCESSABLE_ENTITY, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SSDPRequest(SSDPRequest.Method method) Sole non-private constructor.

Method Summary

Modifier and Type	Method and Description
static SSDPRequest	from(DatagramPacket packet) Method to parse a SSDPRequest from a DatagramPacket.
long	getExpiration() Method to get the expiration time for this SSDPMessage.
String	getMethod() Method to get the RequestLine method.
int	getMX() Method to get the MX header value as an int.
SocketAddress	getSocketAddress() Method to get the SocketAddress from the DatagramPacket if this SSDPRequest was parsed from a packet.
<T> SSDPRequest	header(String name, Function<T,String> function, T value) Fluent header setter.
SSDPRequest	header(String name, InetSocketAddress value) InetSocketAddress fluent header setter.
SSDPRequest	header(String name, Number value) Number fluent header setter.
SSDPRequest	header(String name, SocketAddress value) SocketAddress fluent header setter.
SSDPRequest	header(String name, String value) String fluent header setter.
SSDPRequest	header(String name, URI value) URI fluent header setter.
String	toString()

Methods inherited from class org.apache.http.message.BasicHttpRequest

getProtocolVersion, getRequestLine

Methods inherited from class org.apache.http.message.AbstractHttpMessage

addHeader, addHeader, containsHeader, getAllHeaders, getFirstHeader, getHeaders, getLastHeader, getParams, headerIterator, headerIterator, removeHeader, removeHeaders, setHeader, setHeader, setHeaders, setParams

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ball.upnp.ssdp.SSDPMessage

getExpiration, getHeaderParameterValue, getHeaderParameterValue, getHeaderValue, getHeaderValue, getLocation, getNT, getST, getUSN, parse

Methods inherited from interface org.apache.http.HttpMessage

addHeader, addHeader, containsHeader, getAllHeaders, getFirstHeader, getHeaders, getLastHeader, getParams, getProtocolVersion, headerIterator, headerIterator, removeHeader, removeHeaders, setHeader, setHeader, setHeaders, setParams

Constructor Detail

SSDPRequest

protected SSDPRequest(SSDPRequest.Method method)

Sole non-private constructor.

Parameters:

method - The SSDPRequest SSDPRequest.Method.

Method Detail

from

public static SSDPRequest from(DatagramPacket packet)

Method to parse a SSDPRequest from a DatagramPacket.

Parameters:

packet - The DatagramPacket.

Returns:

A new SSDPRequest.

getMethod

public String getMethod()

Method to get the RequestLine method.

Returns:

The method specified on the request line.

getSocketAddress

public SocketAddress getSocketAddress()

Method to get the SocketAddress from the DatagramPacket if this SSDPRequest was parsed from a packet.

Returns:

The SocketAddress.

getMX

public int getMX()

Method to get the MX header value as an int. Returns 120 if the header is not specified or the if the value is not in the range of 1 <= mx <= 120.

Returns:

The MX value.

header

public SSDPRequest header(String name,
                          String value)

String fluent header setter.

Parameters:

name - The header name.

value - The header value.

Returns:

this

header

public SSDPRequest header(String name,
                          SocketAddress value)

SocketAddress fluent header setter.

Parameters:

name - The header name.

value - The header value.

Returns:

this

header

public SSDPRequest header(String name,
                          InetSocketAddress value)

InetSocketAddress fluent header setter.

Parameters:

name - The header name.

value - The header value.

Returns:

this

header

public SSDPRequest header(String name,
                          Number value)

Number fluent header setter.

Parameters:

name - The header name.

value - The header value.

Returns:

this

header

public SSDPRequest header(String name,
                          URI value)

URI fluent header setter.

Parameters:

name - The header name.

value - The header value.

Returns:

this

header

public <T> SSDPRequest header(String name,
                              Function<T,String> function,
                              T value)

Fluent header setter.

Type Parameters:

T - The target type.

Parameters:

name - The header name.

value - The header value.

Returns:

this

getExpiration

public long getExpiration()

Description copied from interface: SSDPMessage

Method to get the expiration time for this SSDPMessage.

Specified by:

getExpiration in interface SSDPMessage

Returns:

The expiration time (milliseconds since the UNIX epoch).

toString

public String toString()

Overrides:

toString in class BasicHttpRequest