Package com.microstrategy.web.beans

Class EventHandlersCatalog

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.utils.config.AbstractElementList

com.microstrategy.web.beans.EventHandlersCatalog

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, java.lang.Cloneable

public class EventHandlersCatalog
extends AbstractElementList

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.

Since:

MicroStrategy Web 9.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

AbstractConfigurationElement.FilteredList

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ATT_VERSION
static java.lang.String	EVENTS_XML_FILE
static java.lang.String	NODE_EVENT_HANDLERS

Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

ATT_CONFIG_SRC, ATT_DELETED, ATT_POSITION, ATT_PROTOTYPE, ATT_USE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
EventHandlersCatalog()	Default Constructor.

Method Summary

Modifier and Type	Method	Description
void	deleteEventHandler(int type)	Delete the event handler with the given type
EventHandlerInfo	getEventHandler(int handlerType)	Get the event handler with the specified type
protected java.lang.Class	getListClass()	Returns the Class items beloging to this list will be instance of.
protected java.lang.String	getListNodeName()	Returns the name of the node representing children of this list.
java.lang.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(java.lang.String version)	Sets the version of the configuration file

Methods inherited from class com.microstrategy.utils.config.AbstractElementList

clear, containsKey, get, get, getKeyAttribute, getList, isEmpty, put, put, size

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, getKey, getLineNumber, getList, getNextKey, getNodeName, getNodeValue, getNodeValue, getOrCreateElement, getParent, getPosition, getPrototype, getRegisteredClass, getSelfInitPath, getSource, getStrAttribute, getUseDefault, getXMLParserParameters, getXMLSerializerParameters, hashCode, hashCodeAtts, hashCodeElements, hashCodeNodeValues, hasRegisteredClass, initAttributesFromXML, initDefaultAttributes, initElementFromXML, initElementsFromXML, initFromFile, initFromResource, initFromXML, initFromXML, initNodeValueFromXML, initPrototype, isActive, isCustomized, isDeleted, isDirty, isInSource, isKeyAttribute, load, mergeChanges, newChildInstance, newSource, original, populate, printAttributes, printElements, printNodeValue, refreshLists, registerClass, registerElement, registerElement, registerElementList, reload, reloadPrototype, removeAttribute, removeDefaults, replaceList, restore, save, save, saveChangesAs, saveConfig, saveFlatXML, saveNode, saveSource, setAttribute, setBoolAttribute, setChildOriginals, setConfigSrc, setCustomized, setElement, setFileLoader, setIntAttribute, setKey, setLineNumber, setNodeName, setNodeValue, setPosition, setPrototype, setSelfInitPath, setStrAttribute, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useNodeValue, useValidation

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NODE_EVENT_HANDLERS

public static final java.lang.String NODE_EVENT_HANDLERS

See Also:

Constant Field Values

ATT_VERSION

public static final java.lang.String ATT_VERSION

See Also:

Constant Field Values

EVENTS_XML_FILE

public static final java.lang.String EVENTS_XML_FILE

See Also:

Constant Field Values

Constructor Detail

EventHandlersCatalog

public EventHandlersCatalog()

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

Method Detail

getListClass

protected java.lang.Class getListClass()

Description copied from class: AbstractElementList

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

Specified by:

getListClass in class AbstractElementList

getListNodeName

protected java.lang.String getListNodeName()

Description copied from class: AbstractElementList

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

Specified by:

getListNodeName in class AbstractElementList

getVersion

public java.lang.String getVersion()

Returns the version of the configuration file

Returns:

the version of the configuration file

setVersion

public void setVersion(java.lang.String version)

Sets the version of the configuration file

Parameters:

version - the version of the configuration file

getEventHandler

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

newEventHandler

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

deleteEventHandler

public void deleteEventHandler(int type)

Delete the event handler with the given type

Parameters:

type - The type of the event handler to be deleted