public class

WebEventHandlerFactory

extends AbstractEventHandlerFactory
implements EnumEventHandlerTypes
java.lang.Object
   ↳ com.microstrategy.web.beans.AbstractEventHandlerFactory
     ↳ com.microstrategy.web.beans.WebEventHandlerFactory

This class is deprecated.
This factory is not used. The bean itself now is responsible to define and create instances of its default event-handler.

Class Overview

This class represents a factory for instantiating various WebEventHandler objects. The type of event-handlers is retrieved from the EnumEventHandlerTypes

This class has been deprecated. It's not used by the application anymore. In the new framework, beans are responsible to create their own event-handler instance. The bean defines what the default event-hanlder is by implementing the newDefaultEventHandler().

Event definitions can be retrieved through the EventHandlersCatalog. This class is cached by the application in the ConfigurationFilesCache. The following sample code shows how to access it:

 EventHandlersCatalog defns = (EventHandlersCatalog) ConfigurationFilesCache.getConfiguration("/WEB-INF/xml/config/events.xml", EventHandlersCatalog.class);
 
Those EventHandlers that would like to automatically be initialized using this configuration file, should extend SysEventHandler.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.beans.EnumEventHandlerTypes
From interface com.microstrategy.web.beans.WebEventTags
Public Methods
synchronized static WebEventHandlerFactory getInstance()
Returns a singleton of this factory.
WebEventHandler newEventHandler(int eventHandlerType, boolean populate)
Instantiates a type specific WebEventHandler based on the specified type.
WebEventHandler newEventHandler(int eventHandlerType)
Instantiates a type specific WebEventHandler based on the specified type.
GenericMultipleEvents newMultipleEventHelper()
Instantiates a GenericMultipleEvents object to assist handling multiple events.
Protected Methods
WebEventHandler initEventHandler(int handlerType, Element eventsNode)
Initialize a WebEventHandler based on the specified type and XML representation for this factory.
[Expand]
Inherited Methods
From class com.microstrategy.web.beans.AbstractEventHandlerFactory
From class java.lang.Object

Public Methods

public static synchronized WebEventHandlerFactory getInstance ()

Returns a singleton of this factory. This is entry point to gain access to various WebEventHandler.

Returns
  • a singleton of WebEventHandlerFactory.

public WebEventHandler newEventHandler (int eventHandlerType, boolean populate)

Instantiates a type specific WebEventHandler based on the specified type. The boolean parameter populate decides \ Whether to populated the new event handler with the default events defined in the SDK level or not.

Parameters
eventHandlerType the type of an event handler.
populate true if the event handler is populated with the default SDK events.
Returns
  • a type specific WebEventHandler

public WebEventHandler newEventHandler (int eventHandlerType)

Instantiates a type specific WebEventHandler based on the specified type. The newly created event handler is populated with the default events defined in the SDK level.

Parameters
eventHandlerType the type of an event handler.
Returns
  • a type specific WebEventHandler

public GenericMultipleEvents newMultipleEventHelper ()

Instantiates a GenericMultipleEvents object to assist handling multiple events. The newly created helper object has a generic event handler of type HANDLER_TYPE_GENERIC associated with it.

Returns

Protected Methods

protected WebEventHandler initEventHandler (int handlerType, Element eventsNode)

Initialize a WebEventHandler based on the specified type and XML representation for this factory.

Parameters
handlerType an event handler type
eventsNode a org.w3c.dom.Element object representing an event handler.
Returns
  • a new type specific WebEventHandler instance