ball.upnp

Interface Service

All Superinterfaces:

Description, SSDP

All Known Subinterfaces:

AnnotatedService

All Known Implementing Classes:

AbstractService

@XmlNs(value="urn:schemas-upnp-org:service-1-0")
public interface Service
extends Description, SSDP

UPnP service interface.

Version:

$Revision: 7215 $

Author:

Allen D. Ball

Method Summary

Modifier and Type	Method and Description
List<? extends Action>	getActionList() Method to get this Service's Actions.
URI	getControlURL() Method to get this Service's control URL (as an URI).
Device	getDevice() Method to get the Device hosting this Service.
URI	getEventSubURL() Method to get this Service's event subscription URL (as an URI).
URI	getSCPDURL() Method to get this Service's description (SCPD) URL (as an URI).
URI	getServiceId() Method to get the URN (URI) describing this Service's service ID.
List<? extends StateVariable>	getServiceStateTable() Method to get this Service's StateVariables.
URI	getServiceType() Method to get the URN (URI) describing this Service's service type.
default URI	getUSN(URI urn) Method to get the USN for this Device UDN.
default Map<URI,Set<URI>>	getUSNMap() Method to provide the Map of USN to NT (ST) permutations required for NOTIFY("ssdp:alive") and NOTIFY("ssdp:byebye") requests and M-SEARCH("ssdp:all") responses for this Device or Service.

Methods inherited from interface ball.upnp.Description

getXmlns

Methods inherited from interface ball.upnp.SSDP

matches, matches

Method Detail

getDevice

Device getDevice()

Method to get the Device hosting this Service.

Returns:

The Device.

getServiceType

URI getServiceType()

Method to get the URN (URI) describing this Service's service type.

Returns:

The service type.

getServiceId

URI getServiceId()

Method to get the URN (URI) describing this Service's service ID.

Returns:

The service type.

getSCPDURL

URI getSCPDURL()

Method to get this Service's description (SCPD) URL (as an URI).

Returns:

The presentation URI.

getControlURL

URI getControlURL()

Method to get this Service's control URL (as an URI).

Returns:

The presentation URI.

getEventSubURL

URI getEventSubURL()

Method to get this Service's event subscription URL (as an URI).

Returns:

The presentation URI.

getActionList

List<? extends Action> getActionList()

Method to get this Service's Actions.

Returns:

The List of Actions.

getServiceStateTable

List<? extends StateVariable> getServiceStateTable()

Method to get this Service's StateVariables.

Returns:

The List of StateVariables.

getUSNMap

default Map<URI,Set<URI>> getUSNMap()

Description copied from interface: SSDP

Method to provide the Map of USN to NT (ST) permutations required for NOTIFY("ssdp:alive") and NOTIFY("ssdp:byebye") requests and M-SEARCH("ssdp:all") responses for this Device or Service.

Specified by:

getUSNMap in interface SSDP

Returns:

Map of USN/NT permutations.

getUSN

default URI getUSN(URI urn)

Description copied from interface: SSDP

Method to get the USN for this Device UDN.

Specified by:

getUSN in interface SSDP

Parameters:

urn - The URN URI.

Returns:

The USN URI.