net.tomp2p.upnp

Class Service

java.lang.Object

net.tomp2p.upnp.Service

public class Service
extends Object

Representation of an UPNP service

Version:

1.0

Author:

SuperBonBon

Field Summary

Fields

Modifier and Type	Field and Description
URL	controlURL
URL	eventSubURL
URL	SCPDURL
String	serviceId
Device	serviceOwnerDevice
String	serviceType
String	USN

Constructor Summary

Constructors

Constructor and Description
Service(Node serviceCtx, URL baseDeviceURL, Device serviceOwnerDevice)

Method Summary

Methods

Modifier and Type	Method and Description
Iterator<String>	getAvailableActionsName()
int	getAvailableActionsSize()
Iterator<String>	getAvailableStateVariableName()
int	getAvailableStateVariableSize()
String	getSCDPData()
int	getSpecVersionMajor()
int	getSpecVersionMinor()
Action	getUPNPServiceAction(String actionName) Retrieves a service action for its given name
StateVariable	getUPNPServiceStateVariable(String stateVariableName) Retrieves a service state variable for its given name
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serviceType

public final String serviceType

serviceId

public final String serviceId

SCPDURL

public final URL SCPDURL

controlURL

public final URL controlURL

eventSubURL

public final URL eventSubURL

USN

public final String USN

serviceOwnerDevice

public final Device serviceOwnerDevice

Constructor Detail

Service

public Service(Node serviceCtx,
       URL baseDeviceURL,
       Device serviceOwnerDevice)
        throws MalformedURLException,
               XPathExpressionException

Parameters:

serviceCtx -

baseDeviceURL -

serviceOwnerDevice -

Throws:

MalformedURLException

XPathExpressionException

Method Detail

getSpecVersionMajor

public int getSpecVersionMajor()

Returns:

major version

getSpecVersionMinor

public int getSpecVersionMinor()

Returns:

minor version

getUPNPServiceAction

public Action getUPNPServiceAction(String actionName)

Retrieves a service action for its given name

Parameters:

actionName - the service action name

Returns:

a ServiceAction object or null if no matching action for this service has been found

getUPNPServiceStateVariable

public StateVariable getUPNPServiceStateVariable(String stateVariableName)

Retrieves a service state variable for its given name

Parameters:

stateVariableName - the state variable name

Returns:

a ServiceStateVariable object or null if no matching state variable has been found

getAvailableActionsName

public Iterator<String> getAvailableActionsName()

Returns:

action names

getAvailableActionsSize

public int getAvailableActionsSize()

Returns:

action count

getAvailableStateVariableName

public Iterator<String> getAvailableStateVariableName()

Returns:

state variable names

getAvailableStateVariableSize

public int getAvailableStateVariableSize()

Returns:

state variable count

getSCDPData

public String getSCDPData()

Returns:

definition xml

toString

public String toString()

Overrides:

toString in class Object