|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sbbi.upnp.messages.ActionMessage
Message object for an UPNP action, simply call setInputParameter() to add the required action message params and then service() to receive the ActionResponse built with the parsed UPNP device SOAP xml response.
Method Summary | |
void |
clearInputParameters()
Method to clear all set input parameters so that this object can be reused |
java.util.List |
getInputParameterNames()
The list of input parameters that should be accepted by the device service for this message |
java.util.List |
getOutputParameterNames()
The list of output parameters that should be returned by the device service |
ActionResponse |
service()
Executes the message and retuns the UPNP device response, according to the UPNP specs, this method could take up to 30 secs to process ( time allowed for a device to respond to a request ) |
ActionMessage |
setInputParameter(java.lang.String parameterName,
boolean parameterValue)
Set the value of an input parameter before a message service call |
ActionMessage |
setInputParameter(java.lang.String parameterName,
byte parameterValue)
Set the value of an input parameter before a message service call |
ActionMessage |
setInputParameter(java.lang.String parameterName,
java.util.Date parameterValue)
Set the value of an input parameter before a message service call |
ActionMessage |
setInputParameter(java.lang.String parameterName,
double parameterValue)
Set the value of an input parameter before a message service call |
ActionMessage |
setInputParameter(java.lang.String parameterName,
float parameterValue)
Set the value of an input parameter before a message service call |
ActionMessage |
setInputParameter(java.lang.String parameterName,
int parameterValue)
Set the value of an input parameter before a message service call |
ActionMessage |
setInputParameter(java.lang.String parameterName,
long parameterValue)
Set the value of an input parameter before a message service call |
ActionMessage |
setInputParameter(java.lang.String parameterName,
java.lang.Object parameterValue)
Set the value of an input parameter before a message service call. |
ActionMessage |
setInputParameter(java.lang.String parameterName,
short parameterValue)
Set the value of an input parameter before a message service call |
ActionMessage |
setInputParameter(java.lang.String parameterName,
java.lang.String parameterValue)
Set the value of an input parameter before a message service call. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public void clearInputParameters()
public ActionResponse service() throws java.io.IOException, UPNPResponseException
java.io.IOException
- if some IOException occurs during message send and reception process
UPNPResponseException
- if an UPNP error message is returned from the server
or if some parsing exception occurs ( detailErrorCode = 899, detailErrorDescription = SAXException message )public java.util.List getInputParameterNames()
public java.util.List getOutputParameterNames()
public ActionMessage setInputParameter(java.lang.String parameterName, java.lang.Object parameterValue) throws java.lang.IllegalArgumentException
parameterName
- the parameter nameparameterValue
- the parameter value as an object, primitive object are handled, all other object
will be assigned with a call to their toString() method call
java.lang.IllegalArgumentException
- if the provided parameterName is not valid for this message
or if no input parameters are required for this messagepublic ActionMessage setInputParameter(java.lang.String parameterName, java.lang.String parameterValue) throws java.lang.IllegalArgumentException
parameterName
- the parameter nameparameterValue
- the string parameter value
java.lang.IllegalArgumentException
- if the provided parameterName is not valid for this message
or if no input parameters are required for this messagepublic ActionMessage setInputParameter(java.lang.String parameterName, java.util.Date parameterValue) throws java.lang.IllegalArgumentException
parameterName
- the parameter nameparameterValue
- the date parameter value, will be automatically translated to the correct
ISO 8601 date format for the given action input param related state variable
java.lang.IllegalArgumentException
- if the provided parameterName is not valid for this message
or if no input parameters are required for this messagepublic ActionMessage setInputParameter(java.lang.String parameterName, boolean parameterValue) throws java.lang.IllegalArgumentException
parameterName
- the parameter nameparameterValue
- the boolean parameter value
java.lang.IllegalArgumentException
- if the provided parameterName is not valid for this message
or if no input parameters are required for this messagepublic ActionMessage setInputParameter(java.lang.String parameterName, byte parameterValue) throws java.lang.IllegalArgumentException
parameterName
- the parameter nameparameterValue
- the byte parameter value
java.lang.IllegalArgumentException
- if the provided parameterName is not valid for this message
or if no input parameters are required for this messagepublic ActionMessage setInputParameter(java.lang.String parameterName, short parameterValue) throws java.lang.IllegalArgumentException
parameterName
- the parameter nameparameterValue
- the short parameter value
java.lang.IllegalArgumentException
- if the provided parameterName is not valid for this message
or if no input parameters are required for this messagepublic ActionMessage setInputParameter(java.lang.String parameterName, int parameterValue) throws java.lang.IllegalArgumentException
parameterName
- the parameter nameparameterValue
- the integer parameter value
java.lang.IllegalArgumentException
- if the provided parameterName is not valid for this message
or if no input parameters are required for this messagepublic ActionMessage setInputParameter(java.lang.String parameterName, long parameterValue) throws java.lang.IllegalArgumentException
parameterName
- the parameter nameparameterValue
- the long parameter value
java.lang.IllegalArgumentException
- if the provided parameterName is not valid for this message
or if no input parameters are required for this messagepublic ActionMessage setInputParameter(java.lang.String parameterName, float parameterValue) throws java.lang.IllegalArgumentException
parameterName
- the parameter nameparameterValue
- the float parameter value
java.lang.IllegalArgumentException
- if the provided parameterName is not valid for this message
or if no input parameters are required for this messagepublic ActionMessage setInputParameter(java.lang.String parameterName, double parameterValue) throws java.lang.IllegalArgumentException
parameterName
- the parameter nameparameterValue
- the double parameter value
java.lang.IllegalArgumentException
- if the provided parameterName is not valid for this message
or if no input parameters are required for this message
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |