public class

EventHandlersCatalog

extends AbstractElementList
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.utils.config.AbstractElementList
       ↳ com.microstrategy.web.beans.EventHandlersCatalog

Class Overview

This class is used to configure Microstrategy Web's event-handlers. The event-handlers use this catalog to populate their events list and arguments. It includes for each event-handler, what are the events, and for each event, what are the argument and the name of the arguments used. This EventHandlersCatalog is typically configured through the "/WEB-INF/xml/config/events.xml" file.

Summary

Constants
String ATT_VERSION
String EVENTS_XML_FILE
String NODE_EVENT_HANDLERS
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
EventHandlersCatalog()
Default Constructor.
Public Methods
void deleteEventHandler(int type)
Delete the event handler with the given type
EventHandlerInfo getEventHandler(int handlerType)
Get the event handler with the specified type
String getVersion()
Returns the version of the configuration file
EventHandlerInfo newEventHandler(int type)
Create a new event handler and add it to the event handler list
void setVersion(String version)
Sets the version of the configuration file
Protected Methods
Class getListClass()
Returns the Class items beloging to this list will be instance of.
String getListNodeName()
Returns the name of the node representing children of this list.
[Expand]
Inherited Methods
From class com.microstrategy.utils.config.AbstractElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
From class java.lang.Object
From interface com.microstrategy.utils.config.ConfigurationElement
From interface com.microstrategy.utils.config.ConfigurationFile

Constants

public static final String ATT_VERSION

Constant Value: "version"

public static final String EVENTS_XML_FILE

Constant Value: "mdBeanEvents.xml"

public static final String NODE_EVENT_HANDLERS

Constant Value: "eventHandlers"

Public Constructors

public EventHandlersCatalog ()

Default Constructor. Set the name of the node as defined in the xml.

Public Methods

public void deleteEventHandler (int type)

Delete the event handler with the given type

Parameters
type The type of the event handler to be deleted

public EventHandlerInfo getEventHandler (int handlerType)

Get the event handler with the specified type

Parameters
handlerType The "type" of the event handler to be fetched from the list
Returns
  • The event handler with the given type

public String getVersion ()

Returns the version of the configuration file

Returns
  • the version of the configuration file

public EventHandlerInfo newEventHandler (int type)

Create a new event handler and add it to the event handler list

Parameters
type The type (key) for the new event handler to be created
Returns
  • The new event handler created and added to the list with the given type

public void setVersion (String version)

Sets the version of the configuration file

Parameters
version the version of the configuration file

Protected Methods

protected Class getListClass ()

Returns the Class items beloging to this list will be instance of.

protected String getListNodeName ()

Returns the name of the node representing children of this list.