|
OSGi™ Service Platform Compendium Specification Release 4 Version 4.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UPnPService
A representation of a UPnP Service. Each UPnP device contains zero or more services. The UPnP description for a service defines actions, their arguments, and event characteristics.
Field Summary | |
---|---|
static java.lang.String |
ID
Property key for the optional service id. |
static java.lang.String |
TYPE
Property key for the optional service type uri. |
Method Summary | |
---|---|
UPnPAction |
getAction(java.lang.String name)
Locates a specific action by name. |
UPnPAction[] |
getActions()
Lists all actions provided by this service. |
java.lang.String |
getId()
Returns the serviceId field in the UPnP service description. |
UPnPStateVariable |
getStateVariable(java.lang.String name)
Gets a UPnPStateVariable objects provided by this service by name |
UPnPStateVariable[] |
getStateVariables()
Lists all UPnPStateVariable objects provided by this service. |
java.lang.String |
getType()
Returns the serviceType field in the UPnP service description. |
java.lang.String |
getVersion()
Returns the version suffix encoded in the serviceType field in
the UPnP service description. |
Field Detail |
---|
static final java.lang.String TYPE
String
array (String[]
) of service types. A UPnP Device service can thus
announce what types of services it contains. A UPnP Event Listener
service can announce for what type of UPnP services it wants
notifications. The service version is encoded in the type string as
specified in the UPnP specification. A null
value is a wildcard,
matching all service types. Value is "UPnP.service.type".
getType()
,
Constant Field Valuesstatic final java.lang.String ID
String
array (String[]
) of service ids. A UPnP Device
service can thus announce what service ids it contains. A UPnP Event
Listener service can announce for what UPnP service ids it wants
notifications. A service id does not have to be universally
unique. It must be unique only within a device. A null
value is a
wildcard, matching all services. The value is "UPnP.service.id".
Method Detail |
---|
java.lang.String getId()
serviceId
field in the UPnP service description.
For standard services defined by a UPnP Forum working committee, the serviceId must contain the following components in the indicated order:
urn:upnp-org:serviceId:
urn:upnp-org:serviceId:serviceID
.
Note that upnp-org
is used instead of schemas-upnp-org
in
this example because an XML schema is not defined for each serviceId.
For non-standard services specified by UPnP vendors, the serviceId must contain the following components in the indicated order:
urn:
:serviceId:
urn:domain-name:serviceId:serviceID
.
This method must continue to return the service id after the UPnP service has been removed from the network.
java.lang.String getType()
serviceType
field in the UPnP service description.
For standard services defined by a UPnP Forum working committee, the serviceType must contain the following components in the indicated order:
urn:schemas-upnp-org:service:
urn:schemas-upnp-org:service:serviceType:v
.
For non-standard services specified by UPnP vendors, the
serviceType
must contain the following components in the
indicated order:
urn:
:service:
urn:domain-name:service:serviceType:v
.
This method must continue to return the service type after the UPnP service has been removed from the network.
java.lang.String getVersion()
serviceType
field in
the UPnP service description.
This method must continue to return the service version after the UPnP service has been removed from the network.
UPnPAction getAction(java.lang.String name)
name
- Name of action. Must not contain hyphen or hash characters.
Should be < 32 characters.
null
if no action is found.
java.lang.IllegalStateException
- if the UPnP service has been removed from
the network.UPnPAction[] getActions()
UPnPAction[]
)or null
if no
actions are defined for this service.
java.lang.IllegalStateException
- if the UPnP service has been removed from
the network.UPnPStateVariable[] getStateVariables()
UPnPStateVariable
objects provided by this service.
null
if none are defined for
this service.
java.lang.IllegalStateException
- if the UPnP service has been removed from
the network.UPnPStateVariable getStateVariable(java.lang.String name)
UPnPStateVariable
objects provided by this service by name
name
- Name of the State Variable
null
if no such state variable exists
for this service.
java.lang.IllegalStateException
- if the UPnP service has been removed from
the network.
|
OSGi™ Service Platform Compendium Specification Release 4 Version 4.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |