Package com.microstrategy.web.app.tasks

Class BeanTaskFactory

java.lang.Object

com.microstrategy.web.app.tasks.AppTaskFactory

com.microstrategy.web.app.tasks.BeanTaskFactory

All Implemented Interfaces:

TaskFactory

Direct Known Subclasses:

FilteredBeanTaskFactory

public class BeanTaskFactory
extends AppTaskFactory

This class is the factory for creating Task instances from "bean task configuration files". It reads files from the directory specified by an init parameter in the web.xml file.

Since:

MicroStrategy Web 8.1.0

See Also:

INIT_PARAM_BEAN_TASK_DIR, INIT_PARAM_SERVER_CONFIG_FILES_DEFAULT_LOCATION

Nested Class Summary

Nested classes/interfaces inherited from interface com.microstrategy.web.tasks.TaskFactory

TaskFactory.TaskCategory

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	INIT_PARAM_BEAN_TASK_DIR	The init parameter that defines where to look for bean task configuration files.
static java.lang.String	INIT_PARAM_SERVER_CONFIG_FILES_DEFAULT_LOCATION	The init parameter that defines where to look server configuration files.

Constructor Summary

Constructors

Constructor	Description
BeanTaskFactory()

Method Summary

Modifier and Type	Method	Description
void	destroy()	Instructs the factory to destroy any persistent data structures.
java.util.List<java.lang.String>	getRegisteredTaskIDList(TaskFactory.TaskCategory taskCat)	Returns a List of registered task IDs in the specified task category.
java.util.Iterator<java.lang.String>	getRegisteredTaskIDs(TaskFactory.TaskCategory taskCat)	Returns an Iterator of registered task IDs in the specified task category.
void	init(ContainerServices cntrSvcs)	Initializes the MicroStrategy Web environment.
void	init(ContainerServices cntrSvcs, TaskFactoryInfo config)	Instructs the factory to initialize itself using the associated ContainerServices and task factory configuration objects.
Task	newTask(java.lang.String id)	Create a new instance of the Task whose identifier is 'id'.
protected boolean	shouldAdd(BeanTaskInfo bti)

Methods inherited from class com.microstrategy.web.app.tasks.AppTaskFactory

getMSTRWebController, getStyleCatalog, initializeBlockFactory

Methods inherited from class java.lang.Object

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

Field Detail

INIT_PARAM_BEAN_TASK_DIR

public static final java.lang.String INIT_PARAM_BEAN_TASK_DIR

The init parameter that defines where to look for bean task configuration files.

See Also:

Constant Field Values

INIT_PARAM_SERVER_CONFIG_FILES_DEFAULT_LOCATION

public static final java.lang.String INIT_PARAM_SERVER_CONFIG_FILES_DEFAULT_LOCATION

The init parameter that defines where to look server configuration files.

See Also:

Constant Field Values

Constructor Detail

BeanTaskFactory

public BeanTaskFactory()

Method Detail

init

public void init(ContainerServices cntrSvcs)

Description copied from class: AppTaskFactory

Initializes the MicroStrategy Web environment.

Specified by:

init in interface TaskFactory

Overrides:

init in class AppTaskFactory

Parameters:

cntrSvcs - A ContainerServices instance to use for creation.

init

public void init(ContainerServices cntrSvcs,
                 TaskFactoryInfo config)

Description copied from interface: TaskFactory

Instructs the factory to initialize itself using the associated ContainerServices and task factory configuration objects.

Parameters:

cntrSvcs - The ContainerServices object.

config - The task factory configuration object

newTask

public Task newTask(java.lang.String id)
             throws TaskException

Description copied from interface: TaskFactory

Create a new instance of the Task whose identifier is 'id'.

Parameters:

id - The identifier of the Task to instantiate.

Returns:

A new instance of the Task whose ID is given.

Throws:

TaskException - If something fails in the creation of the task.

getRegisteredTaskIDs

public java.util.Iterator<java.lang.String> getRegisteredTaskIDs(TaskFactory.TaskCategory taskCat)

Description copied from interface: TaskFactory

Returns an Iterator of registered task IDs in the specified task category.

Parameters:

taskCat - The TaskFactory.TaskCategory in which task IDs are being requested.

Returns:

An Iterator of all registered task names.

getRegisteredTaskIDList

public java.util.List<java.lang.String> getRegisteredTaskIDList(TaskFactory.TaskCategory taskCat)

Description copied from interface: TaskFactory

Returns a List of registered task IDs in the specified task category.

Parameters:

taskCat - The TaskFactory.TaskCategory in which task IDs are being requested.

Returns:

An List of all registered task names. They are sorted alphabetically.

Since:

MicroStrategy Web 9.0.0

destroy

public void destroy()

Description copied from interface: TaskFactory

Instructs the factory to destroy any persistent data structures.

shouldAdd

protected boolean shouldAdd(BeanTaskInfo bti)