Package com.microstrategy.web.app.beans

Class AppEventHandlerFactory

java.lang.Object

com.microstrategy.web.beans.AbstractEventHandlerFactory

com.microstrategy.web.app.beans.AppEventHandlerFactory

All Implemented Interfaces:

WebEventTags

public final class AppEventHandlerFactory
extends AbstractEventHandlerFactory

Deprecated.

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

This class is responsible for handing out instances of specific event handlers identified by the type (as defined in EnumSysBeanTypes).

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

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields inherited from interface com.microstrategy.web.beans.WebEventTags

ATT_ARGUMENT_ENUMERATOR, ATT_ARGUMENT_ID, ATT_ARGUMENT_INDEX, ATT_ARGUMENT_NAME, ATT_ARGUMENT_REQUIRED, ATT_ARGUMENT_TYPE, ATT_ARGUMENT_VALIDATOR, ATT_ARGUMENT_VALUE, ATT_EVENT_DEPRECATED, ATT_EVENT_ENUMERATOR, ATT_EVENT_HANDLER_ENUMERATOR, ATT_EVENT_HANDLER_NAME, ATT_EVENT_HANDLER_TYPE, ATT_EVENT_ID, ATT_EVENT_NAME, ATT_EVENT_TARGET, TAG_ARGUMENT, TAG_ARGUMENTS, TAG_EVENT, TAG_EVENT_HANDLER, TAG_EVENT_HANDLERS, TAG_EVENTS

Method Summary

Modifier and Type	Method	Description
static AppEventHandlerFactory	getInstance()	Deprecated. Returns an instance of the AppEventHandlerFactory object.
protected WebEventHandler	initEventHandler(int handlerType, org.w3c.dom.Element eventsNode)	Deprecated. Create an instance of WebEventHandler based on the handler type and initialize it with the event node sent in as argument
WebEventHandler	newEventHandler(int appBeanType)	Deprecated. Return a new instance of the specific event handler identified by the type.
WebEventHandler	newEventHandler(int eventHandlerType, boolean populate)	Deprecated. Return a new instance of the specific event handler identified by the type.

Methods inherited from class com.microstrategy.web.beans.AbstractEventHandlerFactory

addEventsToHandlers, addEventsToHandlers, destroy, getEventHandler, initEventHandlers, setEventHandler

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static AppEventHandlerFactory getInstance()

Deprecated.

Returns an instance of the AppEventHandlerFactory object. This is the only way to get the factory object and is the entry point to the various App Event Handlers.

Returns:

an AppEventHandlerFactory instance.

newEventHandler

public WebEventHandler newEventHandler(int appBeanType)

Deprecated.

Return a new instance of the specific event handler identified by the type. The instance returned is not populated with any events. It is the caller's responsiblity to later initialize the list of events.

Parameters:

appBeanType - element of the EnumSysBeanTypes enumeration identifying the type of app bean

Returns:

a WebEventHandler object for the bean requested

newEventHandler

public WebEventHandler newEventHandler(int eventHandlerType,
                                       boolean populate)

Deprecated.

Return a new instance of the specific event handler identified by the type.

Parameters:

eventHandlerType - element of the EnumSysBeanTypes enumeration identifying the type of app bean for which an event handler will be created

populate - boolean indicating if the instance will be populated with its list of events or not. If not, it is the caller's responsiblity to later do it.

Returns:

a WebEventHandler object for the bean requested

initEventHandler

protected WebEventHandler initEventHandler(int handlerType,
                                           org.w3c.dom.Element eventsNode)

Deprecated.

Create an instance of WebEventHandler based on the handler type and initialize it with the event node sent in as argument

Specified by:

initEventHandler in class AbstractEventHandlerFactory

Parameters:

handlerType - int value of the EnumSysBeanTypes enumeration indicating which type of event handler to create

eventsNode - Element instance with the event information to use for initializing the handler instance

Returns:

WebEventHandler instance initialized.