public class

SysEventHandler

extends GenericEventHandler

java.lang.Object
↳	com.microstrategy.web.beans.GenericEventHandler
	↳	com.microstrategy.web.beans.SysEventHandler

Known Direct Subclasses

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

Known Indirect Subclasses

AddDataSetObjectExplorerEventHandler, DatasetObjectExplorerEventHandler, DerivedElementsBrowserEventHandler, FolderObjectExplorerEventHandler, ImportDerivedElementsEventHandler, ViewReportObjectExplorerEventHandler, XDADataExplorerEventHandler

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(int type) It populates this event-handler with the list of events available for the given handler-type in the event-handlers catalog.
void	initEvents() This method is called to initialize the list of events available with this event-handler.
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

void	addEvent(WebEvent event) Adds a `WebEvent` instance into the current event handler.
void	addEvent(Element eventNode) This method is deprecated. The GenericEventHandler is not responsible to read the xml structure, therefore this method is not used anymore. Events should be added to an event handler using the Web Customization Editor
void	addEvents(Element node) This method is deprecated. The GenericEventHandler is not responsible to read the xml structure, therefore this method is not used anymore. Events should be added to an event handler using the Web Customization Editor
static void	addEventsFromRequestKeys(ArrayList eventList, RequestKeys keys, WebComponent component, SimpleList filterEventIDList)
void	addEventsFromXML(String eventsXML) This method is deprecated. The GenericEventHandler is not responsible to read the xml structure, therefore this method is not used anymore. Events should be added to an event handler using the Web Customization Editor
void	appendRemainingEvent(WebEvent event) Append an remaining event at the end of the remaining events' list.
Object	clone() Clone the current event handler instance.
boolean	delegateRequest(RequestKeys keys) The default implementation of this method simply delegates the event to the next source component specified in the static field `GenericWebEvent.URL_SOURCE_NAME`.
static int	getEventID(RequestKeys keys) Retrieves the event id passed in from the `RequestKeys`.
WebComponent	getEventTarget(RequestKeys keys)
int	getHandlerType() Returns the `type` of the current `WebEventHandle`.
String	getName() Returns the name of this event handler
String	getNextSourceName(RequestKeys keys) Returns the next component name in the event component path.
static String	getNextSourceName(String currentBeanPath, String eventFullPath) Returns the next source component which will handle the event.
static SimpleList	getOrderedEvents(RequestKeys keys, String errorDesc)
SimpleList	getPendingEvents() Returns the list of events that were not processed.
Class	getSupportedWebComponentType() Returns the `WebComponent` class by default.
WebComponent	getWebComponent() Returns the `WebComponent` object associated with the current event handler.
WebEvent	getWebEvent(RequestKeys keys) Decodes the `WebEvent` from the `RequestKeys`.
WebEvent	getWebEvent(int eventID, RequestKeys keys) This method should be used when the eventID passed in is different from the one that is included as a value in the keys parameter
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.
Enumeration	getWebEventsFromRequest(RequestKeys keys) Returns an enumeration over the `WebEvent` suppored by this event handler that are present in the request keys provided.
boolean	handleRequest(RequestKeys keys) Handles the `WebEvent` specified in the `RequestKeys` object.
boolean	isInitialized() Returns `true` after the `markInitailized()` has been called.
boolean	isMyEvent(RequestKeys keys)
void	markInitailized() Call this method to mark this event-handler instance as initialized.
void	processExtraEvents()
static void	processMultipleEvents(String flatState, MultipleEventHandler handler, String componentPath) Processes multiple events encoded via the `FlatStateSerializer`.
static void	processMultipleEvents(String flatState, MultipleEventHandler handler) This method is deprecated. Use `processMultipleEvents(String, MultipleEventHandler, String)`
boolean	processRequest(RequestKeys keys) Logic to process the event.
void	setHandlerType(int type) Sets the `type` of the current event handler.
void	setName(String name) Sets the name to this event handler
void	setWebComponent(WebComponent component) Sets a `WebComponent` instance on this event handler.
void	validateRequiredArgument(String argName, String argValue) A helper method which ensures that the `argValue` corresponding to `argName` is not null and not empty.

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 (int type)

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

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 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.

Interfaces

Classes

Exceptions

SysEventHandler

Class Overview

Summary

Constants

protected static final String DEFAULT_CONFIG_PATH

Public Constructors

public SysEventHandler ()

Public Methods

public WebEvent getWebEvent (int eventID)

Parameters

Returns

public Enumeration getWebEvents ()

Returns

Protected Methods

protected EventHandlersCatalog getCatalog ()

protected void initEvents (int type)

protected void initEvents ()

protected WebEvent newDefaultEventInstance ()

protected WebEvent newWebEvent (EventInfo info)