org.cybergarage.upnp.Action Class Reference

Inheritance diagram for org.cybergarage.upnp.Action:

Public Member Functions
Service	getService ()
Node	getActionNode ()
	Action (Node serviceNode)
	Action (Node serviceNode, Node actionNode)
	Action (Action action)
void	lock ()
void	unlock ()
void	setName (String value)
String	getName ()
ArgumentList	getArgumentList ()
void	setArgumentList (ArgumentList al)
ArgumentList	getInputArgumentList ()
ArgumentList	getOutputArgumentList ()
Argument	getArgument (String name)
void	setArgumentValues (ArgumentList argList)
void	setInArgumentValues (ArgumentList argList)
void	setOutArgumentValues (ArgumentList argList)
void	setArgumentValue (String name, String value)
void	setArgumentValue (String name, int value)
String	getArgumentValue (String name)
int	getArgumentIntegerValue (String name)
ActionListener	getActionListener ()
void	setActionListener (ActionListener listener)
boolean	performActionListener (ActionRequest actionReq)
UPnPStatus	getControlStatus ()
boolean	postControlAction ()
void	print ()
void	setStatus (int code, String descr)
void	setStatus (int code)
UPnPStatus	getStatus ()
void	setUserData (Object data)
Object	getUserData ()

Static Public Member Functions
static boolean	isActionNode (Node node)

Static Public Attributes
static final String	ELEM_NAME = "action"

Private Member Functions
Node	getServiceNode ()
void	clearOutputAgumentValues ()
ActionData	getActionData ()
ControlResponse	getControlResponse ()
void	setControlResponse (ControlResponse res)

Private Attributes
Node	serviceNode
Node	actionNode
Mutex	mutex = new Mutex()
UPnPStatus	upnpStatus = new UPnPStatus()
Object	userData = null

Static Private Attributes
static final String	NAME = "name"

Constructor & Destructor Documentation

Action() [1/3]

org.cybergarage.upnp.Action.Action ( Node serviceNode )

inline

Action() [2/3]

org.cybergarage.upnp.Action.Action ( Node serviceNode, Node actionNode )

inline

Action() [3/3]

org.cybergarage.upnp.Action.Action ( Action action )

inline

Member Function Documentation

clearOutputAgumentValues()

void org.cybergarage.upnp.Action.clearOutputAgumentValues ( )

inlineprivate

getActionData()

ActionData org.cybergarage.upnp.Action.getActionData ( )

inlineprivate

getActionListener()

ActionListener org.cybergarage.upnp.Action.getActionListener ( )

inline

getActionNode()

Node org.cybergarage.upnp.Action.getActionNode ( )

inline

getArgument()

Argument org.cybergarage.upnp.Action.getArgument ( String name )

inline

getArgumentIntegerValue()

int org.cybergarage.upnp.Action.getArgumentIntegerValue ( String name )

inline

getArgumentList()

ArgumentList org.cybergarage.upnp.Action.getArgumentList ( )

inline

getArgumentValue()

String org.cybergarage.upnp.Action.getArgumentValue ( String name )

inline

getControlResponse()

ControlResponse org.cybergarage.upnp.Action.getControlResponse ( )

inlineprivate

getControlStatus()

UPnPStatus org.cybergarage.upnp.Action.getControlStatus ( )

inline

getInputArgumentList()

ArgumentList org.cybergarage.upnp.Action.getInputArgumentList ( )

inline

getName()

String org.cybergarage.upnp.Action.getName ( )

inline

getOutputArgumentList()

ArgumentList org.cybergarage.upnp.Action.getOutputArgumentList ( )

inline

getService()

Service org.cybergarage.upnp.Action.getService ( )

inline

getServiceNode()

Node org.cybergarage.upnp.Action.getServiceNode ( )

inlineprivate

getStatus()

UPnPStatus org.cybergarage.upnp.Action.getStatus ( )

inline

getUserData()

Object org.cybergarage.upnp.Action.getUserData ( )

inline

isActionNode()

static boolean org.cybergarage.upnp.Action.isActionNode ( Node node )

inlinestatic

lock()

void org.cybergarage.upnp.Action.lock ( )

inline

performActionListener()

boolean org.cybergarage.upnp.Action.performActionListener ( ActionRequest actionReq )

inline

postControlAction()

boolean org.cybergarage.upnp.Action.postControlAction ( )

inline

print()

void org.cybergarage.upnp.Action.print ( )

inline

setActionListener()

void org.cybergarage.upnp.Action.setActionListener ( ActionListener listener )

inline

setArgumentList()

void org.cybergarage.upnp.Action.setArgumentList ( ArgumentList al )

inline

setArgumentValue() [1/2]

void org.cybergarage.upnp.Action.setArgumentValue ( String name, int value )

inline

setArgumentValue() [2/2]

void org.cybergarage.upnp.Action.setArgumentValue ( String name, String value )

inline

setArgumentValues()

void org.cybergarage.upnp.Action.setArgumentValues ( ArgumentList argList )

inline

Deprecated

You should use one of the following methods instead:

• setInArgumentValues(ArgumentList)
  
• setOutArgumentValues(ArgumentList)

setControlResponse()

void org.cybergarage.upnp.Action.setControlResponse ( ControlResponse res )

inlineprivate

setInArgumentValues()

void org.cybergarage.upnp.Action.setInArgumentValues ( ArgumentList argList )

inline

Parameters

argList

Since

1.8.0

setName()

void org.cybergarage.upnp.Action.setName ( String value )

inline

setOutArgumentValues()

void org.cybergarage.upnp.Action.setOutArgumentValues ( ArgumentList argList )

inline

Parameters

argList

Since

1.8.0

setStatus() [1/2]

void org.cybergarage.upnp.Action.setStatus ( int code )

inline

setStatus() [2/2]

void org.cybergarage.upnp.Action.setStatus ( int code, String descr )

inline

setUserData()

void org.cybergarage.upnp.Action.setUserData ( Object data )

inline

unlock()

void org.cybergarage.upnp.Action.unlock ( )

inline

Field Documentation

actionNode

Node org.cybergarage.upnp.Action.actionNode

private

ELEM_NAME

final String org.cybergarage.upnp.Action.ELEM_NAME = "action"

static

mutex

Mutex org.cybergarage.upnp.Action.mutex = new Mutex()

private

NAME

final String org.cybergarage.upnp.Action.NAME = "name"

staticprivate

serviceNode

Node org.cybergarage.upnp.Action.serviceNode

private

upnpStatus

UPnPStatus org.cybergarage.upnp.Action.upnpStatus = new UPnPStatus()

private

userData

Object org.cybergarage.upnp.Action.userData = null

private

---

The documentation for this class was generated from the following file:

• core/src/main/java/org/cybergarage/upnp/Action.java