org.cybergarage.upnp
Class Service

java.lang.Object
  org.cybergarage.upnp.Service

public class Service
extends java.lang.Object

Field Summary

static java.lang.String	ELEM_NAME
static java.lang.String	MAJOR
static java.lang.String	MAJOR_VALUE
static java.lang.String	MINOR
static java.lang.String	MINOR_VALUE
static java.lang.String	SCPD_ROOTNODE
static java.lang.String	SCPD_ROOTNODE_NS
static java.lang.String	SPEC_VERSION

Constructor Summary

Service()

Service(Node node)

Method Summary

void	addAction(Action a)
void	addStateVariable(StateVariable var) Add the StateVariable to the service. Note: This method should be used to create a dynamic Device withtout writing any XML that describe the device .
void	addSubscriber(org.cybergarage.upnp.event.Subscriber sub)
void	announce(java.lang.String bindAddr)
void	byebye(java.lang.String bindAddr)
void	clearSID()
Action	getAction(java.lang.String actionName)
ActionList	getActionList()
java.lang.String	getControlURL()
java.lang.String	getDescriptionURL()
Device	getDevice()
java.lang.String	getEventSubURL()
Device	getRootDevice()
byte[]	getSCPDData()
java.lang.String	getSCPDURL()
java.lang.String	getServiceID()
Node	getServiceNode()
ServiceStateTable	getServiceStateTable()
java.lang.String	getServiceType()
java.lang.String	getSID()
StateVariable	getStateVariable(java.lang.String name)
org.cybergarage.upnp.event.Subscriber	getSubscriber(java.lang.String name)
org.cybergarage.upnp.event.SubscriberList	getSubscriberList()
long	getTimeout()
java.lang.Object	getUserData()
boolean	hasSID()
boolean	hasStateVariable(java.lang.String name)
boolean	isControlURL(java.lang.String url)
boolean	isEventSubURL(java.lang.String url)
boolean	isSCPDURL(java.lang.String url)
boolean	isService(java.lang.String name)
static boolean	isServiceNode(Node node)
boolean	isSubscribed()
boolean	loadSCPD(java.io.File file)
boolean	loadSCPD(java.io.InputStream input)
boolean	loadSCPD(java.lang.String scpdStr)
void	lock()
void	notify(StateVariable stateVar)
void	notifyAllStateVariables()
void	removeSubscriber(org.cybergarage.upnp.event.Subscriber sub)
boolean	serviceSearchResponse(org.cybergarage.upnp.ssdp.SSDPPacket ssdpPacket)
void	setActionListener(org.cybergarage.upnp.control.ActionListener listener)
void	setControlURL(java.lang.String value)
void	setDescriptionURL(java.lang.String value)
void	setEventSubURL(java.lang.String value)
void	setQueryListener(org.cybergarage.upnp.control.QueryListener queryListener)
void	setSCPDURL(java.lang.String value)
void	setServiceID(java.lang.String value)
void	setServiceType(java.lang.String value)
void	setSID(java.lang.String id)
void	setTimeout(long value)
void	setUserData(java.lang.Object data)
void	unlock()

Methods inherited from class java.lang.Object

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

Field Detail

ELEM_NAME

public static final java.lang.String ELEM_NAME

See Also:

Constant Field Values

SCPD_ROOTNODE

public static final java.lang.String SCPD_ROOTNODE

See Also:

Constant Field Values

SCPD_ROOTNODE_NS

public static final java.lang.String SCPD_ROOTNODE_NS

See Also:

Constant Field Values

SPEC_VERSION

public static final java.lang.String SPEC_VERSION

See Also:

Constant Field Values

MAJOR

public static final java.lang.String MAJOR

See Also:

Constant Field Values

MAJOR_VALUE

public static final java.lang.String MAJOR_VALUE

See Also:

Constant Field Values

MINOR

public static final java.lang.String MINOR

See Also:

Constant Field Values

MINOR_VALUE

public static final java.lang.String MINOR_VALUE

See Also:

Constant Field Values

Constructor Detail

Service

public Service()

Service

public Service(Node node)

Method Detail

getServiceNode

public Node getServiceNode()

lock

public void lock()

unlock

public void unlock()

isServiceNode

public static boolean isServiceNode(Node node)

getDevice

public Device getDevice()

getRootDevice

public Device getRootDevice()

setServiceType

public void setServiceType(java.lang.String value)

getServiceType

public java.lang.String getServiceType()

setServiceID

public void setServiceID(java.lang.String value)

getServiceID

public java.lang.String getServiceID()

setSCPDURL

public void setSCPDURL(java.lang.String value)

getSCPDURL

public java.lang.String getSCPDURL()

isSCPDURL

public boolean isSCPDURL(java.lang.String url)

setControlURL

public void setControlURL(java.lang.String value)

getControlURL

public java.lang.String getControlURL()

isControlURL

public boolean isControlURL(java.lang.String url)

setEventSubURL

public void setEventSubURL(java.lang.String value)

getEventSubURL

public java.lang.String getEventSubURL()

isEventSubURL

public boolean isEventSubURL(java.lang.String url)

loadSCPD

public boolean loadSCPD(java.lang.String scpdStr)
                 throws org.cybergarage.upnp.device.InvalidDescriptionException

Throws:

org.cybergarage.upnp.device.InvalidDescriptionException

loadSCPD

public boolean loadSCPD(java.io.File file)
                 throws ParserException

Throws:

ParserException

loadSCPD

public boolean loadSCPD(java.io.InputStream input)
                 throws ParserException

Throws:

ParserException

Since:

1.8.0

setDescriptionURL

public void setDescriptionURL(java.lang.String value)

getDescriptionURL

public java.lang.String getDescriptionURL()

getSCPDData

public byte[] getSCPDData()

getActionList

public ActionList getActionList()

getAction

public Action getAction(java.lang.String actionName)

addAction

public void addAction(Action a)

getServiceStateTable

public ServiceStateTable getServiceStateTable()

getStateVariable

public StateVariable getStateVariable(java.lang.String name)

hasStateVariable

public boolean hasStateVariable(java.lang.String name)

isService

public boolean isService(java.lang.String name)

announce

public void announce(java.lang.String bindAddr)

byebye

public void byebye(java.lang.String bindAddr)

serviceSearchResponse

public boolean serviceSearchResponse(org.cybergarage.upnp.ssdp.SSDPPacket ssdpPacket)

setQueryListener

public void setQueryListener(org.cybergarage.upnp.control.QueryListener queryListener)

getSubscriberList

public org.cybergarage.upnp.event.SubscriberList getSubscriberList()

addSubscriber

public void addSubscriber(org.cybergarage.upnp.event.Subscriber sub)

removeSubscriber

public void removeSubscriber(org.cybergarage.upnp.event.Subscriber sub)

getSubscriber

public org.cybergarage.upnp.event.Subscriber getSubscriber(java.lang.String name)

notify

public void notify(StateVariable stateVar)

notifyAllStateVariables

public void notifyAllStateVariables()

getSID

public java.lang.String getSID()

setSID

public void setSID(java.lang.String id)

clearSID

public void clearSID()

hasSID

public boolean hasSID()

isSubscribed

public boolean isSubscribed()

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long value)

setActionListener

public void setActionListener(org.cybergarage.upnp.control.ActionListener listener)

addStateVariable

public void addStateVariable(StateVariable var)

Add the StateVariable to the service.

Note: This method should be used to create a dynamic
Device withtout writing any XML that describe the device
.
Note: that no control for duplicate StateVariable is done.

Parameters:

var - StateVariable that will be added

setUserData

public void setUserData(java.lang.Object data)

getUserData

public java.lang.Object getUserData()