ruon.jiao
Class JIAO.Directive

java.lang.Object
  extended by ruon.jiao.JIAO.Directive
Enclosing class:
JIAO

public static class JIAO.Directive
extends java.lang.Object

Directive is returned by methods communicating with the server to indicate what the server is expecting the agent to do. A directive has a verb which describes the action and a modifier called X that changes in meaning, depending on the verb.


Field Summary
static ruon.jiao.JIAO.Directive.VERB DIE
          Something is going terribly wrong and the server would like the agent to stop communicating.
static ruon.jiao.JIAO.Directive.VERB SLEEP
          Agent is expected call keep alive again in X seconds.
static ruon.jiao.JIAO.Directive.VERB UNINSTALL
          Sent as a response to an explicit request by the user to perform an uninstall.
static ruon.jiao.JIAO.Directive.VERB UPGRADE
          This directive is intended for public agents only and tells the agent to perform an upgrade.
 
Method Summary
 ruon.jiao.JIAO.Directive.VERB getVerb()
          Return the directive's verb
 java.lang.String getX()
          Verb modifier, meaning depends on verb context
 java.lang.String toString()
          Returns a String representation
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DIE

public static ruon.jiao.JIAO.Directive.VERB DIE
Something is going terribly wrong and the server would like the agent to stop communicating. After sending back this directive the JIAO object will no longer be valid and will throw exceptions for any subsequent request to communicate with the server. X is the reason associated with this request.


SLEEP

public static ruon.jiao.JIAO.Directive.VERB SLEEP
Agent is expected call keep alive again in X seconds. The agent can communicate alarms in the mean time. If a new sleep directive is obtained the original one is discarded (i.e. the sleep counter resets).


UNINSTALL

public static ruon.jiao.JIAO.Directive.VERB UNINSTALL
Sent as a response to an explicit request by the user to perform an uninstall. X is the text associated with this request.


UPGRADE

public static ruon.jiao.JIAO.Directive.VERB UPGRADE
This directive is intended for public agents only and tells the agent to perform an upgrade. Private agents cannot be upgraded via the R-U-ON platform. X is the text associated with this request.

Method Detail

getVerb

public ruon.jiao.JIAO.Directive.VERB getVerb()
Return the directive's verb

Returns:
The verb Object

getX

public java.lang.String getX()
Verb modifier, meaning depends on verb context

Returns:
The modifier

toString

public java.lang.String toString()
Returns a String representation

Overrides:
toString in class java.lang.Object
Returns:
The String