|
OSGi™ Compendium Release 5 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UPnPAction
A UPnP action. Each UPnP service contains zero or more actions. Each action may have zero or more UPnP state variables as arguments.
Method Summary | |
---|---|
java.lang.String[] |
getInputArgumentNames()
Lists all input arguments for this action. |
java.lang.String |
getName()
Returns the action name. |
java.lang.String[] |
getOutputArgumentNames()
List all output arguments for this action. |
java.lang.String |
getReturnArgumentName()
Returns the name of the designated return argument. |
UPnPStateVariable |
getStateVariable(java.lang.String argumentName)
Finds the state variable associated with an argument name. |
java.util.Dictionary |
invoke(java.util.Dictionary args)
Invokes the action. |
Method Detail |
---|
java.lang.String getName()
name
field in the
actionList
of the service description.
X_
nor A_
.X_
.This method must continue to return the action name after the UPnP action has been removed from the network.
java.lang.String getReturnArgumentName()
One of the output arguments can be flagged as a designated return argument.
This method must continue to return the action return argument name after the UPnP action has been removed from the network.
null
if
none is marked.java.lang.String[] getInputArgumentNames()
Each action may have zero or more input arguments.
This method must continue to return the action input argument names after the UPnP action has been removed from the network.
null
if no input
arguments.UPnPStateVariable
java.lang.String[] getOutputArgumentNames()
This method must continue to return the action output argument names after the UPnP action has been removed from the network.
null
if there are no
output arguments.UPnPStateVariable
UPnPStateVariable getStateVariable(java.lang.String argumentName)
argumentName
- The name of the UPnP action argument.
null
if there is no such argument.
java.lang.IllegalStateException
- if the UPnP action has been removed from
the network.UPnPStateVariable
java.util.Dictionary invoke(java.util.Dictionary args) throws java.lang.Exception
Dictionary
objects. Each entry in the Dictionary
object has a String
object as key representing the argument name and the value is the
argument itself. The class of an argument value must be assignable from
the class of the associated UPnP state variable.
The input argument Dictionary
object must contain exactly those
arguments listed by getInputArguments
method. The output argument
Dictionary
object will contain exactly those arguments listed by
getOutputArguments
method.
args
- A Dictionary
of arguments. Must contain the correct
set and type of arguments for this action. May be null
if
no input arguments exist.
Dictionary
with the output arguments. null
if
the action has no output arguments.
UPnPException
- A UPnP error has occurred.
java.lang.IllegalStateException
- if the UPnP action has been removed from
the network.
java.lang.Exception
- The execution fails for some reason.UPnPStateVariable
|
OSGi™ Compendium Release 5 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |