com.pega.pegarules.management
Class AgentManagement

java.lang.Object
  extended by MBeanHelper
      extended by com.pega.pegarules.management.AgentManagement

public class AgentManagement
extends MBeanHelper


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String VERSION
           
 
Constructor Summary
AgentManagement()
           
 
Method Summary
 java.lang.String AgentStatus()
           
 java.lang.String Delay(java.lang.String aRuleset, java.lang.String aQNum)
          This method will delay the start of the agent execution until the Tracer is started, to allow the developer to trace the agent activity.
 java.lang.String getCategory()
           
 java.lang.String getMajorVersion()
           
 java.lang.String getMinorVersion()
           
 java.lang.String getName()
           
 java.lang.String isAliveQueue(java.lang.String aRuleset, java.lang.String aQueueNum)
          This method displays information on whether the agent activity (specified by RuleSet and Queue number) is enabled.
 java.lang.String isAliveQueues(java.lang.String aRuleset)
          This method displays information on whether all agents in the Rule-Agent-Queue instance for the specified RuleSet are enabled.
 java.lang.String QueryQueue(java.lang.String aRuleset, java.lang.String aQueueNum)
          This method reports data about the status of the agent activity (specified by RuleSet and Queue number).
 java.lang.String QueryQueues(java.lang.String aRuleset)
          This method reports data about the status of all agent activities in the Rule-Agent-Queue instance for the specified RuleSet.
 java.lang.String QueryRulesets()
          This method displays the RuleSets where agents have been defined.
 java.lang.String RestartQueue(java.lang.String aRuleset, java.lang.String aQNum)
          This method will stop and then restart the agent activity (specified by the RuleSet and Queue number).
 java.lang.String RestartQueues(java.lang.String aRuleset)
          This method will stop and then restart all agent activities defined in the specified RuleSet.
 void setCategory(java.lang.String aCategory)
           
 java.lang.String StartQueue(java.lang.String aRuleset, java.lang.String aQueueNum)
          This method will start the agent activity (specified by the RuleSet and Queue number).
 java.lang.String StartQueues(java.lang.String aRuleset)
          This method will start all agent activities defined in the specified RuleSet.
 java.lang.String StopQueue(java.lang.String aRuleset, java.lang.String aQNum)
          This method will stop the agent activity (specified by the RuleSet and Queue number) from executing.
 java.lang.String StopQueues(java.lang.String aRuleset)
          This method will stop all agent activities defined in the specified RuleSet.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values

VERSION

public static final java.lang.String VERSION
Constructor Detail

AgentManagement

public AgentManagement()
Method Detail

getCategory

public java.lang.String getCategory()

setCategory

public void setCategory(java.lang.String aCategory)

getName

public java.lang.String getName()

getMajorVersion

public java.lang.String getMajorVersion()

getMinorVersion

public java.lang.String getMinorVersion()

AgentStatus

public java.lang.String AgentStatus()

RestartQueue

public java.lang.String RestartQueue(java.lang.String aRuleset,
                                     java.lang.String aQNum)
This method will stop and then restart the agent activity (specified by the RuleSet and Queue number).

Parameters:
aRuleset - RuleSet where the agent is defined
aQNum - position number in the agent definition (Rule-Agent-Queue instance)
Since:
PRPC v5.1

StopQueue

public java.lang.String StopQueue(java.lang.String aRuleset,
                                  java.lang.String aQNum)
This method will stop the agent activity (specified by the RuleSet and Queue number) from executing.

Parameters:
aRuleset - RuleSet where the agent is defined
aQNum - position number in the agent definition (Rule-Agent-Queue instance)
Since:
PRPC v5.1

Delay

public java.lang.String Delay(java.lang.String aRuleset,
                              java.lang.String aQNum)
This method will delay the start of the agent execution until the Tracer is started, to allow the developer to trace the agent activity.

Parameters:
aRuleset - RuleSet where the agent is defined
aQNum - position number in the agent definition (Rule-Agent-Queue instance)
Since:
PRPC v5.1

StartQueues

public java.lang.String StartQueues(java.lang.String aRuleset)
This method will start all agent activities defined in the specified RuleSet.

Parameters:
aRuleset - RuleSet where the agent is defined
Since:
PRPC v5.1

StopQueues

public java.lang.String StopQueues(java.lang.String aRuleset)
This method will stop all agent activities defined in the specified RuleSet.

Parameters:
aRuleset - RuleSet where the agent is defined
Since:
PRPC v5.1

RestartQueues

public java.lang.String RestartQueues(java.lang.String aRuleset)
This method will stop and then restart all agent activities defined in the specified RuleSet.

Parameters:
aRuleset - RuleSet where the agent is defined
Since:
PRPC v5.1

StartQueue

public java.lang.String StartQueue(java.lang.String aRuleset,
                                   java.lang.String aQueueNum)
This method will start the agent activity (specified by the RuleSet and Queue number).

Parameters:
aRuleset - RuleSet where the agent is defined
aQNum - position number in the agent definition (Rule-Agent-Queue instance)
Since:
PRPC v5.1

isAliveQueue

public java.lang.String isAliveQueue(java.lang.String aRuleset,
                                     java.lang.String aQueueNum)
This method displays information on whether the agent activity (specified by RuleSet and Queue number) is enabled.

Parameters:
aRuleset - RuleSet where the agent is defined
aQueueNum - position number in the agent definition (Rule-Agent-Queue instance)
Since:
PRPC v5.1

isAliveQueues

public java.lang.String isAliveQueues(java.lang.String aRuleset)
This method displays information on whether all agents in the Rule-Agent-Queue instance for the specified RuleSet are enabled.

Parameters:
aRuleset - RuleSet where the agent is defined
Since:
PRPC v5.1

QueryQueue

public java.lang.String QueryQueue(java.lang.String aRuleset,
                                   java.lang.String aQueueNum)
This method reports data about the status of the agent activity (specified by RuleSet and Queue number).

Parameters:
aRuleset - RuleSet where the agent is defined
aQueueNum - position number in the agent definition (Rule-Agent-Queue instance)
Since:
PRPC v5.1

QueryQueues

public java.lang.String QueryQueues(java.lang.String aRuleset)
This method reports data about the status of all agent activities in the Rule-Agent-Queue instance for the specified RuleSet.

Parameters:
aRuleset - RuleSet where the agent is defined
Since:
PRPC v5.1

QueryRulesets

public java.lang.String QueryRulesets()
This method displays the RuleSets where agents have been defined.

Since:
PRPC v5.1