public class

SysEventHandler

extends GenericEventHandler
java.lang.Object
   ↳ com.microstrategy.web.beans.GenericEventHandler
     ↳ com.microstrategy.web.beans.SysEventHandler
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

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 (getEventHandlersCatalog()) and populates itself using the EventHandlerInfo for the corresponding handler-type.

Summary

Constants
String DEFAULT_CONFIG_PATH
[Expand]
Inherited Constants
From class com.microstrategy.web.beans.GenericEventHandler
From interface com.microstrategy.web.beans.WebEventTags
[Expand]
Inherited Fields
From class com.microstrategy.web.beans.GenericEventHandler
Public Constructors
SysEventHandler()
Public Methods
WebEvent getWebEvent(int eventID)
Returns the specified WebEvent instance which this event handler supports.
Enumeration getWebEvents()
Returns an enumeration over the WebEvent suppored by this event handler.
Protected Methods
EventHandlersCatalog getCatalog()
Returns the event-handlers catalog.
void initEvents()

This method is called to initialize the list of events available with this event-handler.

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.
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.
WebEvent newWebEvent(EventInfo info)
This method is called to create a new WebEvent and populated with the given EventInfo.
[Expand]
Inherited Methods
From class com.microstrategy.web.beans.GenericEventHandler
From class java.lang.Object
From interface com.microstrategy.web.beans.WebEventHandler

Constants

protected static final String DEFAULT_CONFIG_PATH

Constant Value: "/WEB-INF/xml/config/events.xml"

Public Constructors

public SysEventHandler ()

Public Methods

public WebEvent getWebEvent (int eventID)

Returns the specified WebEvent instance which this event handler supports.

Parameters
eventID the event id of the WebEvent.
Returns
  • the specified WebEvent; null if the event is not supported by this event handler.

public Enumeration getWebEvents ()

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

Returns
  • an Enumeration over the WebEvent supported.

Protected Methods

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

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(RequestKeys) and the getWebEvents() methods to ensure it's available. If the list has been initialized, it does nothing, if not it calls initEvents(int) passing this handler's type

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

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.