atg.service.event
Class GenericHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.service.event.GenericHandler

All Implemented Interfaces:

NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, EventChannelListener, java.util.EventListener

Direct Known Subclasses:

ConfigurableActionHandler

public class GenericHandler
extends GenericService
implements EventChannelListener

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected java.lang.String[]	mChannels List of channels this handler listens to at startup.
protected long	mEventCount Number of events received by this handler.

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

GenericHandler()
Empty constructor.

Method Summary

java.lang.String[]	getChannels() List of channels this handler listens to at startup.
long	getEventCount() The number of events that have been sent to this event topic.
java.lang.String	getHandlerName() Returns the name of the handler.
boolean	isRegisterAtStartup() Returns property RegisterAtStartup
void	sendEvent(java.lang.Object pEvent) Submits an event for handling.
void	setChannels(java.lang.String[] pValue) List of channels this handler listens to at startup.
void	setRegisterAtStartup(boolean pRegisterAtStartup) Sets property RegisterAtStartup

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mEventCount

protected long mEventCount

Number of events received by this handler.

mChannels

protected java.lang.String[] mChannels

List of channels this handler listens to at startup.

Constructor Detail

GenericHandler

public GenericHandler()

Empty constructor.

Method Detail

setRegisterAtStartup

public void setRegisterAtStartup(boolean pRegisterAtStartup)

Sets property RegisterAtStartup

isRegisterAtStartup

public boolean isRegisterAtStartup()

Returns property RegisterAtStartup

getHandlerName

public java.lang.String getHandlerName()

Returns the name of the handler. For our purposes, the handler name is the Nucleus component name.

Specified by:

getHandlerName in interface EventChannelListener

setChannels

public void setChannels(java.lang.String[] pValue)

List of channels this handler listens to at startup.

getChannels

public java.lang.String[] getChannels()

List of channels this handler listens to at startup.

getEventCount

public long getEventCount()

The number of events that have been sent to this event topic.

sendEvent

public void sendEvent(java.lang.Object pEvent)

Submits an event for handling.

Specified by:

sendEvent in interface EventChannelListener