Package com.microstrategy.web.beans

Class SysEventHandler

java.lang.Object

com.microstrategy.web.beans.GenericEventHandler

com.microstrategy.web.beans.SysEventHandler

All Implemented Interfaces:

WebEventHandler, WebEventTags, java.lang.Cloneable

Direct Known Subclasses:

AbstractObjectExplorerEventHandler, AccordionTabManagerEventHandler, AdminBeanEventHandler, AdminServletEventHandler, AttributeEventHandler, DerivedElementEventHandler, DiagnosticsBeanEventHandler, ExpressionPromptEventHandlerImpl, FilterEventHandler, FolderFrameEventHandler, PageSetupHTMLEditorEventHandler, ProjectBrowserEventHandler, RibbonEventHandlerImpl, RWGraphDropZonesEditorEventHandlerImpl, SecurityFilterEventHandler, SecurityRoleEventHandler, ViewFilterElementPanelEventHandler

public class SysEventHandler
extends GenericEventHandler

The SysEventHandler is the base class for all those event-handlers that can be configured through an external events.xml.

This class retrieves the event-handlers catalog from the bean context (BeanContext.getEventHandlersCatalog()) and populates itself using the EventHandlerInfo for the corresponding handler-type.

Since:

MicroStrategy Web 9.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.beans.GenericEventHandler

GenericEventHandler.GenericEventKeys

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	DEFAULT_CONFIG_PATH

Fields inherited from class com.microstrategy.web.beans.GenericEventHandler

_extraEvents, layerOfHandleRequest, MULTIPLE_EVENT_SOURCE_SUFFIX, NO_EVENT_ID

Fields inherited from interface com.microstrategy.web.beans.WebEventTags

ATT_ARGUMENT_ENUMERATOR, ATT_ARGUMENT_ID, ATT_ARGUMENT_INDEX, ATT_ARGUMENT_NAME, ATT_ARGUMENT_REQUIRED, ATT_ARGUMENT_TYPE, ATT_ARGUMENT_VALIDATOR, ATT_ARGUMENT_VALUE, ATT_EVENT_DEPRECATED, ATT_EVENT_ENUMERATOR, ATT_EVENT_HANDLER_ENUMERATOR, ATT_EVENT_HANDLER_NAME, ATT_EVENT_HANDLER_TYPE, ATT_EVENT_ID, ATT_EVENT_NAME, ATT_EVENT_TARGET, TAG_ARGUMENT, TAG_ARGUMENTS, TAG_EVENT, TAG_EVENT_HANDLER, TAG_EVENT_HANDLERS, TAG_EVENTS

Constructor Summary

Constructors

Constructor	Description
SysEventHandler()

Method Summary

Modifier and Type	Method	Description
protected EventHandlersCatalog	getCatalog()	Returns the event-handlers catalog.
WebEvent	getWebEvent(int eventID)	Returns the specified WebEvent instance which this event handler supports.
java.util.Enumeration	getWebEvents()	Returns an enumeration over the WebEvent suppored by this event handler.
protected void	initEvents()	This method is called to initialize the list of events available with this event-handler.
protected void	initEvents(int type)	It populates this event-handler with the list of events available for the given handler-type in the event-handlers catalog.
protected WebEvent	newDefaultEventInstance()	This method is called to create a concrete new instance of a WebEvent when the event-class has not specified in the EventInfo.
protected WebEvent	newWebEvent(EventInfo info)	This method is called to create a new WebEvent and populated with the given EventInfo.

Methods inherited from class com.microstrategy.web.beans.GenericEventHandler

addEvent, addEvent, addEvents, addEventsFromRequestKeys, addEventsFromXML, appendRemainingEvent, clone, delegateRequest, getEventID, getEventTarget, getHandlerType, getName, getNextSourceName, getNextSourceName, getOrderedEvents, getPendingEvents, getSupportedWebComponentType, getWebComponent, getWebEvent, getWebEvent, getWebEventsFromRequest, handleRequest, isInitialized, isMyEvent, markInitailized, processExtraEvents, processMultipleEvents, processMultipleEvents, processRequest, setHandlerType, setName, setWebComponent, validateRequiredArgument

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONFIG_PATH

protected static final java.lang.String DEFAULT_CONFIG_PATH

See Also:

Constant Field Values

Constructor Detail

SysEventHandler

public SysEventHandler()

Method Detail

getWebEvent

public WebEvent getWebEvent(int eventID)

Description copied from class: GenericEventHandler

Returns the specified WebEvent instance which this event handler supports.

Specified by:

getWebEvent in interface WebEventHandler

Overrides:

getWebEvent in class GenericEventHandler

Parameters:

eventID - the event id of the WebEvent.

Returns:

the specified WebEvent; null if the event is not supported by this event handler.

getWebEvents

public java.util.Enumeration getWebEvents()

Description copied from class: GenericEventHandler

Returns an enumeration over the WebEvent suppored by this event handler. The WebEvent are returned in no particular order.

Specified by:

getWebEvents in interface WebEventHandler

Overrides:

getWebEvents in class GenericEventHandler

Returns:

an Enumeration over the WebEvent supported.

initEvents

protected void initEvents()

This method is called to initialize the list of events available with this event-handler. Since this class uses lazy initialization for its event list; this method will be always called by the getWebEvent(int) and the getWebEvents() methods to ensure it's available. If the list has been initialized, it does nothing, if not it calls initEvents(int type) passing this handler's type

Those event-handler that support more than one handler-type can extend this method and call initEvents(int type) with all the types they support.

initEvents

protected void initEvents(int type)

It populates this event-handler with the list of events available for the given handler-type in the event-handlers catalog.

getCatalog

protected EventHandlersCatalog getCatalog()

Returns the event-handlers catalog. If the WebComponent has been associated, it obtains the catalog from the BeanContext, otherwise it obtains the catalog directly from the ConfigurationFilesCache

newWebEvent

protected WebEvent newWebEvent(EventInfo info)

This method is called to create a new WebEvent and populated with the given EventInfo.

newDefaultEventInstance

protected WebEvent newDefaultEventInstance()

This method is called to create a concrete new instance of a WebEvent when the event-class has not specified in the EventInfo.