com.netscape.cms.listeners
Class RequestInQListener

java.lang.Object
  extended by com.netscape.cms.listeners.RequestInQListener
All Implemented Interfaces:
IRequestListener

public class RequestInQListener
extends java.lang.Object
implements IRequestListener

a listener for every request gets into the request queue.

Here is a list of available $TOKENs for email notification templates:


Field Summary
protected static java.lang.String PROP_EMAIL_SUBJECT
           
static java.lang.String PROP_EMAIL_TEMPLATE
           
protected static java.lang.String PROP_ENABLED
           
protected static java.lang.String PROP_NOTIFY_SUBSTORE
           
protected static java.lang.String PROP_RECVR_EMAIL
           
protected static java.lang.String PROP_REQ_IN_Q_SUBSTORE
           
protected static java.lang.String PROP_SENDER_EMAIL
           
 
Constructor Summary
RequestInQListener()
          Constructor
 
Method Summary
 void accept(IRequest r)
          carries out the operation when the listener is triggered.
 void init(ISubsystem sub, IConfigStore config)
          initializes the listener from the configuration
 void set(java.lang.String name, java.lang.String val)
          sets the configurable parameters
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROP_ENABLED

protected static final java.lang.String PROP_ENABLED
See Also:
Constant Field Values

PROP_SENDER_EMAIL

protected static final java.lang.String PROP_SENDER_EMAIL
See Also:
Constant Field Values

PROP_RECVR_EMAIL

protected static final java.lang.String PROP_RECVR_EMAIL
See Also:
Constant Field Values

PROP_EMAIL_TEMPLATE

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

PROP_EMAIL_SUBJECT

protected static final java.lang.String PROP_EMAIL_SUBJECT
See Also:
Constant Field Values

PROP_NOTIFY_SUBSTORE

protected static final java.lang.String PROP_NOTIFY_SUBSTORE
See Also:
Constant Field Values

PROP_REQ_IN_Q_SUBSTORE

protected static final java.lang.String PROP_REQ_IN_Q_SUBSTORE
See Also:
Constant Field Values
Constructor Detail

RequestInQListener

public RequestInQListener()
Constructor

Method Detail

init

public void init(ISubsystem sub,
                 IConfigStore config)
          throws EListenersException,
                 EPropertyNotFound,
                 EBaseException
initializes the listener from the configuration

Specified by:
init in interface IRequestListener
Parameters:
sub - subsystem
config - configuration store
Throws:
EListenersException
EPropertyNotFound
EBaseException

accept

public void accept(IRequest r)
carries out the operation when the listener is triggered.

Specified by:
accept in interface IRequestListener
Parameters:
r - IRequest structure holding the request information
See Also:
IRequest

set

public void set(java.lang.String name,
                java.lang.String val)
sets the configurable parameters

Specified by:
set in interface IRequestListener
Parameters:
name - a String represents the name of the configuration parameter to be set
val - a String containing the value to be set for name