com.webmethods.portal.mech.task.impl

Class CustomTaskChangeHandler

java.lang.Object

com.webmethods.portal.mech.task.impl.CustomTaskChangeHandler

All Implemented Interfaces:

com.webmethods.portal.event.IPortalEvent.IListener, ITaskChangedEvent.IListener, com.webmethods.portal.system.init.IInitializable

public class CustomTaskChangeHandler
extends Object
implements ITaskChangedEvent.IListener, com.webmethods.portal.event.IPortalEvent.IListener, com.webmethods.portal.system.init.IInitializable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CustomTaskChangeHandler.ICustomTaskEventSubscriber Interface to be implemented for listening to TaskChangeEvents using a custom listener.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CUSTOM_TASK_CHANGED_EVENTS_QUEUEID
static String	TASK_LWQ_CONFIG
static boolean	TASK_RETRY_LOOKUP_PRINCIPAL
static long	TASK_RETRY_LOOKUP_PRINCIPAL_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
CustomTaskChangeHandler(com.webmethods.portal.mech.task.impl.TaskMechanics taskMechanics)

Method Summary

Modifier and Type	Method and Description
static void	addSubscriber(CustomTaskChangeHandler.ICustomTaskEventSubscriber subscriber) A custom subscriber must be added here first in order to receive events.
static CustomTaskChangeHandler.ICustomTaskEventSubscriber[]	getSubscribers() Returns all the active custom subscribers receiving the TaskChangeEvents.
void	init(com.webmethods.portal.system.IComponentData data, String phase) This component should initialize now.
void	onEvent(com.webmethods.portal.event.IPortalEvent ev)
void	onEvent(ITaskChangedEvent event)
void	processTaskChangedEvent(ITaskChangedEvent event)
void	queueTaskChangeEvent(ITaskChangedEvent event)
static void	removeSubscriber(CustomTaskChangeHandler.ICustomTaskEventSubscriber subscriber) An added custom subscriber can be removed using this method.
void	shutdown() This object is being uninitialized.

Methods inherited from class java.lang.Object

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

Field Detail

CUSTOM_TASK_CHANGED_EVENTS_QUEUEID

public static final String CUSTOM_TASK_CHANGED_EVENTS_QUEUEID

See Also:

Constant Field Values

TASK_LWQ_CONFIG

public static final String TASK_LWQ_CONFIG

See Also:

Constant Field Values

TASK_RETRY_LOOKUP_PRINCIPAL

public static final boolean TASK_RETRY_LOOKUP_PRINCIPAL

TASK_RETRY_LOOKUP_PRINCIPAL_TIMEOUT

public static final long TASK_RETRY_LOOKUP_PRINCIPAL_TIMEOUT

Constructor Detail

CustomTaskChangeHandler

public CustomTaskChangeHandler(com.webmethods.portal.mech.task.impl.TaskMechanics taskMechanics)

Method Detail

queueTaskChangeEvent

public void queueTaskChangeEvent(ITaskChangedEvent event)

init

public void init(com.webmethods.portal.system.IComponentData data,
                 String phase)
          throws com.webmethods.portal.system.init.InitializationException

This component should initialize now. If this is implemented by IComponentProvider then it should initialize all of its IComponents.

Specified by:

init in interface com.webmethods.portal.system.init.IInitializable

Parameters:

phase - the name of the current phase

data - the IComponentData

Throws:

com.webmethods.portal.system.init.InitializationException

See Also:

InitializationException.RECOVERABLE_ERROR, InitializationException.NON_RECOVERABLE_ERROR

shutdown

public void shutdown()

This object is being uninitialized. Shutdown and free resources as necessary.

Specified by:

shutdown in interface com.webmethods.portal.system.init.IInitializable

See Also:

IInitializable.shutdown()

onEvent

public void onEvent(com.webmethods.portal.event.IPortalEvent ev)

Specified by:

onEvent in interface com.webmethods.portal.event.IPortalEvent.IListener

onEvent

public void onEvent(ITaskChangedEvent event)

Specified by:

onEvent in interface ITaskChangedEvent.IListener

processTaskChangedEvent

public void processTaskChangedEvent(ITaskChangedEvent event)

addSubscriber

public static void addSubscriber(CustomTaskChangeHandler.ICustomTaskEventSubscriber subscriber)

A custom subscriber must be added here first in order to receive events.

Parameters:

subscriber - an instance of ICustomTaskEventSubscriber.

removeSubscriber

public static void removeSubscriber(CustomTaskChangeHandler.ICustomTaskEventSubscriber subscriber)

An added custom subscriber can be removed using this method.

Parameters:

subscriber - an instance of ICustomTaskEventSubscriber.

getSubscribers

public static CustomTaskChangeHandler.ICustomTaskEventSubscriber[] getSubscribers()

Returns all the active custom subscribers receiving the TaskChangeEvents.

Returns:

ICustomTaskEventSubscriber[] containing all the subscribers.