org.ocap.hn.upnp.common

Interface UPnPAdvertisedService

All Superinterfaces:

UPnPService

All Known Subinterfaces:

UPnPClientService

public interface UPnPAdvertisedService
extends UPnPService

This interface represents a UPnP service as it is advertised on a particular network. It provides the data constituting a UPnP service, portions of which depend on the network interface on which it is advertised. Corresponds to the information carried in the UPnP service description document plus service-specific data from the UPnP device description document.

Method Summary

Methods

Modifier and Type	Method and Description
UPnPAdvertisedStateVariable	getAdvertisedStateVariable(String stateVariableName) Gets a UPnP state variable from the UPnP description of this service.
UPnPAdvertisedStateVariable[]	getAdvertisedStateVariables() Gets all of the UPnP state variables supported by this service.
String	getControlURL() Gets the UPnP controlURL of this service.
String	getEventSubURL() Gets the UPnP eventSubURL of this service.
String	getSCPDURL() Gets the UPnP SCPDURL of this service.
org.w3c.dom.Document	getXML() Gets the service description document (SCPD document) in XML.

Methods inherited from interface org.ocap.hn.upnp.common.UPnPService

getAction, getActions, getServiceId, getServiceType, getSpecVersion

Method Detail

getControlURL

String getControlURL()

Gets the UPnP controlURL of this service. This value is taken from the value of the controlURL element within the device description.

Returns:

The URL used by a control point to invoke actions on this service.

getEventSubURL

String getEventSubURL()

Gets the UPnP eventSubURL of this service. This value is taken from the value of the eventSubURL element within a device description. If this service does not have eventing, the value returned is the empty string.

Returns:

The URL used by a control point to subscribe to evented state variables.

getSCPDURL

String getSCPDURL()

Gets the UPnP SCPDURL of this service. This value is taken from the value of the SCPDURL element within a device description.

Returns:

The URL used to retrieve the service description of this service.

getAdvertisedStateVariable

UPnPAdvertisedStateVariable getAdvertisedStateVariable(String stateVariableName)

Gets a UPnP state variable from the UPnP description of this service. Supported state variable names are provided by a UPnP device in the name element of each stateVariable element in a device service description.

Parameters:

stateVariableName - The name of the state variable to get.

Returns:

The state variable corresponding to the stateVariableName parameter.

Throws:

IllegalArgumentException - if the stateVariableName does not match a state variable name in this service.

getAdvertisedStateVariables

UPnPAdvertisedStateVariable[] getAdvertisedStateVariables()

Gets all of the UPnP state variables supported by this service. UPnP state variable information is taken from the stateVariable elements in the UPnP service description.

Returns:

The UPnP state variables supported by this service. If the service has no state variables, returns a zero-length array.

getXML

org.w3c.dom.Document getXML()

Gets the service description document (SCPD document) in XML. The form of the document is defined by the UPnP Device Architecture specification.

Returns:

The service description document.