public interface UPnPAction
Modifier and Type | Method and Description |
---|---|
String[] |
getInputArgumentNames()
Lists all input arguments for this action.
|
String |
getName()
Returns the action name.
|
String[] |
getOutputArgumentNames()
List all output arguments for this action.
|
String |
getReturnArgumentName()
Returns the name of the designated return argument.
|
UPnPStateVariable |
getStateVariable(String argumentName)
Finds the state variable associated with an argument name.
|
Dictionary |
invoke(Dictionary args)
Invokes the action.
|
String getName()
name
field in the
actionList
of the service description.
X_
nor A_
.X_
.String getReturnArgumentName()
One of the output arguments can be flagged as a designated return argument.
null
if
none is marked.String[] getInputArgumentNames()
Each action may have zero or more input arguments.
null
if no input
arguments.UPnPStateVariable
String[] getOutputArgumentNames()
null
if there are no
output arguments.UPnPStateVariable
UPnPStateVariable getStateVariable(String argumentName)
argumentName
- The name of the UPnP action argument.null
if there is no such argument.UPnPStateVariable
Dictionary invoke(Dictionary args) throws 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 occured.Exception
- The execution fails for some reason.UPnPStateVariable
Copyright © 2006–2017 OSGi Alliance. All rights reserved.