com.pega.pegarules.management
Class ListenerManagement

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

public class ListenerManagement
extends MBeanHelper


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String VERSION
           
 
Constructor Summary
ListenerManagement()
           
 
Method Summary
 java.lang.String getCategory()
           
 java.lang.String getMajorVersion()
           
 java.lang.String getMinorVersion()
           
 java.lang.String getName()
           
 java.lang.String isAlive(java.lang.String aListenerId)
          This method queries the specified listener to determine its status.
 java.lang.String ListenerStatus()
          This method returns a report which contains the list of available listeners and running listeners, including their current status (running, sleeping, disabled).
 java.lang.String Query(java.lang.String aListenerId)
          This method queries the listener and displays data about it: the status, the Listener Name, the Listener Java Class, etc.
 java.lang.String Restart(java.lang.String aListenerId)
          This method will stop and then restart the specified Listener.
 java.lang.String RestartAll()
          This method stops and then restarts all Listeners defined in the system.
 java.lang.String RestartType(java.lang.String aListenerClass, java.lang.String aListenerJavaClass)
          This method stops and then restarts all of the Listeners of the specified type: Email, MQ, File, JMS.
 void setCategory(java.lang.String aCategory)
           
 java.lang.String Start(java.lang.String aListenerClass, java.lang.String aListenerName, java.lang.String aServerName, java.lang.String aListenerJavaClass)
          This method starts the specified listener.
 java.lang.String Stop(java.lang.String aListenerId)
          This method disables the specified listener.
 java.lang.String StopAll()
          This method disables all the listeners defined in the system.
 java.lang.String StopType(java.lang.String aListenerClass)
          This method disables all Listeners of the specified Data-Admin-Connect class: Email, JMS, MQ, or File.
 java.lang.String ViewRuleData(java.lang.String aListenerId)
           
 
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

ListenerManagement

public ListenerManagement()
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()

ListenerStatus

public java.lang.String ListenerStatus()
This method returns a report which contains the list of available listeners and running listeners, including their current status (running, sleeping, disabled).

Since:
PRPC v5.1

ViewRuleData

public java.lang.String ViewRuleData(java.lang.String aListenerId)

Start

public java.lang.String Start(java.lang.String aListenerClass,
                              java.lang.String aListenerName,
                              java.lang.String aServerName,
                              java.lang.String aListenerJavaClass)
This method starts the specified listener.

Parameters:
aListenerClass - The class of the listener - instance of Data-Admin-Connect- ruletype (EmailListener, FileListener, JMSListener, MQListener)
aListenerName - The listener name (specified as a key in the Data-Admin-Connect instance).
aServerName - The server name (specified as a key only in the Email and MQ Data-Admin-Connect instances).
aListenerJavaClass - The name of the Process Commander Java class that implements the listener. All class names begin with com.pega.pegarules.services; the classes are EmailListener, file.FileListener, JMSListener, MQListener.
Since:
PRPC v5.1

Restart

public java.lang.String Restart(java.lang.String aListenerId)
This method will stop and then restart the specified Listener.

Parameters:
aListenerId - Unique character string assigned by the Listener management. This string does not exist until the listener is started.
Since:
PRPC v5.1

RestartType

public java.lang.String RestartType(java.lang.String aListenerClass,
                                    java.lang.String aListenerJavaClass)
This method stops and then restarts all of the Listeners of the specified type: Email, MQ, File, JMS.

Parameters:
aListenerClass - The Data-Admin-Connect class of the listener (see above list).
aListenerJavaClass - The Java class generated from the listener.
Since:
PRPC v5.1

RestartAll

public java.lang.String RestartAll()
This method stops and then restarts all Listeners defined in the system.

Since:
PRPC v5.1

Stop

public java.lang.String Stop(java.lang.String aListenerId)
This method disables the specified listener.

Parameters:
aListenerId - Unique character string assigned by the Listener management. This string does not exist until the listener is started.
Since:
PRPC v5.1

StopType

public java.lang.String StopType(java.lang.String aListenerClass)
This method disables all Listeners of the specified Data-Admin-Connect class: Email, JMS, MQ, or File.

Parameters:
aListenerClass - The Data-Admin-Connect class of the listener (see above list).
Since:
PRPC v5.1

StopAll

public java.lang.String StopAll()
This method disables all the listeners defined in the system.

Since:
PRPC v5.1

isAlive

public java.lang.String isAlive(java.lang.String aListenerId)
This method queries the specified listener to determine its status. If it is not disabled, the method returns a message that the listener is alive.

Parameters:
aListenerId - Unique character string assigned by the Listener management. This string does not exist until the listener is started.
Since:
PRPC v5.1

Query

public java.lang.String Query(java.lang.String aListenerId)
This method queries the listener and displays data about it: the status, the Listener Name, the Listener Java Class, etc.

Parameters:
aListenerId - Unique character string assigned by the Listener management. This string does not exist until the listener is started.
Since:
PRPC v5.1