Package com.microstrategy.web.app.tasks

Class WebComponentTask

java.lang.Object

com.microstrategy.web.tasks.AbstractBaseTask

com.microstrategy.web.app.tasks.AbstractAppTask

com.microstrategy.web.app.tasks.WebComponentTask

All Implemented Interfaces:

Task

Direct Known Subclasses:

BeanTask, BlockLoaderTask, GetDIProjectSettingsTask, GetShortcutsList, GetVersionInfo

public class WebComponentTask
extends AbstractAppTask

This class implements the Task interface using a WebComponent to handle data collection. The definition of the task is provided through a single XML file.

Since:

MicroStrategy Web 9.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	FP_NAME_CONTENT_TYPE	The name of the formal parameter that defines the desired content type.
protected java.lang.String	initializationErrorMessage	If an error occurred at initialization time, then this field contains the message.

Fields inherited from class com.microstrategy.web.tasks.AbstractBaseTask

compressOutput, CONTENT_TYPE_BINARY, CONTENT_TYPE_HTML, CONTENT_TYPE_JSON, CONTENT_TYPE_JSON_ALL, CONTENT_TYPE_JSON_D, CONTENT_TYPE_JSON_P, CONTENT_TYPE_XML, CONTENT_TYPE_XML_ANF, DEFAULT_MAX_WAIT, DEFAULT_POLLING_FREQ, execFlagsParam, INDEFINITE_MAX_WAIT, maxWaitParam, metadata, mPrivileges, msgIDParam, objectIDParam, OTHER_CONTENT_KEY_LAYOUTS, PARAM_NAME_EXEC_FLAGS, PARAM_NAME_MAX_WAIT, PARAM_NAME_MESSAGE_ID, PARAM_NAME_OBJECT_ID, PARAM_NAME_POLLING_FREQ, PARAM_NAME_RESULT_FLAGS, PARAM_NAME_SESSION_ID, PARAM_NAME_SESSION_STATE, PARAM_NAME_STATE_ID, pollingFreqParam, PREFERENCE_DEFAULT_MAX_WAIT_IN_TASK, resultFlagsParam, sessionIDParam, sessionStateParam, stateIDParam

Constructor Summary

Constructors

Constructor	Description
WebComponentTask()	No args constructor for a WebComponentTask.

Method Summary

Modifier and Type	Method	Description
protected TransformInstance	addTransform(BeanTaskRequestContext btrContext)	Adds the specified Transform to the WebBean.
protected void	collectData(BeanTaskRequestContext btrContext)	This method calls the 'collectData' method on the WebBean instance.
protected WebComponent	createUntypedWebComponent(BeanTaskRequestContext btrContext)	This method creates an instance of an "untyped" Web Component.
protected WebComponent	createWebBean(BeanTaskRequestContext btrContext)	This method creates the WebComponent or WebBean from the specified bean type.
void	destroy()	Destroy any data structures created by the 'init' method.
protected boolean	generatesContent(BeanTaskRequestContext btrContext)	This method determines whether the Task is going to generate any content.
protected BeanInfo	getBeanInfo()	Returns the BeanInfo object associated with this BeanTask.
protected java.lang.String	getStyleName(BeanTaskRequestContext btrContext)
protected void	handleEvent(BeanTaskRequestContext btrContext)	This method instructs the WebBean to handle the event.
void	init(ContainerServices containerSvcs)	Handles the initialization of the task.
protected boolean	isSuccessfullyInitialized()	Returns whether the BeanTask was successfully initialized or not.
TaskRequestContext	newRequestContext()	Returns a BeanTaskRequestContext object to use for the duration of this request.
protected void	overrideActualParameters(BeanTaskRequestContext btrContext, TransformInstance instance)	Overrides any actual parameters specified in the Bean Task XML.
protected void	prepareArgumentRequestKeys(RequestKeys requestKeys)	This method prepares the RequestKeys by adding the necessary "event argument" parameters.
protected void	prepareArgumentRequestKeys(RequestKeys requestKeys, EventInfo[] events)
protected void	prepareBean(BeanTaskRequestContext btrContext)	This method prepares the WebBean for execution.
protected void	prepareEventOrderRequestKeys(RequestKeys requestKeys)	The method sets the request keys necessary for multiple events.
protected void	prepareEventOrderRequestKeys(RequestKeys requestKeys, EventInfo[] events)
protected void	prepareEventRequestKeys(RequestKeys requestKeys)	This method prepares the RequestKeys by adding the necessary keys for events.
protected void	prepareEventRequestKeys(RequestKeys requestKeys, EventInfo[] events)
protected void	prepareParameterRequestKeys(RequestKeys requestKeys)	This method prepares the RequestKeys by adding any default values for parameters.
protected void	prepareRequestKeys(BeanTaskRequestContext btrContext)	Prepares the RequestKeys for handling the event.
void	processRequest(TaskRequestContext context, TaskOutput taskOutput)	Process the incoming request.
protected void	registerParameterMetadata(TaskParameterMetadata parameterMetadata)	Registers a specific Task parameter metadata.
protected void	registerTaskMetadata(TaskMetadata sourceMetadata)	This method is used to register the task metadata.
protected boolean	requiresIServerSession()	Returns whether this Task requires an Intelligence Server session.
protected void	restoreBeanState(BeanTaskRequestContext btrContext)	Restores the state of a previously serialized WebBean.
protected void	serializeResult(BeanTaskRequestContext btrContext, TaskOutput taskOutput)	This method attempts to serialize the results to the supplied TaskOutput object.
protected void	setBeanContext(BeanTaskRequestContext btrContext)	Set the BeanContext associated with the Bean.
protected void	setBeanInfo(BeanInfo beanInfo)	Sets the BeanInfo object associated with this BeanTask.
protected void	setBeanName(BeanTaskRequestContext btrContext)	Sets the Bean's name.
protected void	setBeanProperties(BeanTaskRequestContext btrContext)	Set any properties on the Bean.
protected void	setBeanSession(BeanTaskRequestContext btrContext)	Set the WebIServerSession object to use with the WebBean.
protected void	setSuccessfullyInitialized(boolean successfullyInitialized)	Sets whether the BeanTask was successfully initialized or not.
void	setTaskID(java.lang.String taskID)	Sets the Task ID.
protected void	transformBean(BeanTaskRequestContext btrContext, TaskOutput taskOutput)	This method wraps a call to Transformable.transform().

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

getDescriptor

Methods inherited from class com.microstrategy.web.tasks.AbstractBaseTask

addExecFlagsParam, addJuilLayouts, addMaxWaitParam, addMaxWaitParam, addMessageIDParam, addObjectIDParam, addParameterMetadata, addParameterMetadata, addParameterMetadata, addPollingFrequencyParam, addPollingFrequencyParam, addResultFlagsParam, addSessionIDParam, addSessionStateParam, addStateIDParam, checkForRequiredParameters, getCompressOutput, getID, getMetadata, getPrivileges, getSysDefaultPreferenceValue, processRequest, retrieveUploadedFile, setCompressOutput, setDescription, setID, setMetadata, setPrivileges, validateContentType

Methods inherited from class java.lang.Object

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

Field Detail

FP_NAME_CONTENT_TYPE

public static final java.lang.String FP_NAME_CONTENT_TYPE

The name of the formal parameter that defines the desired content type. If found, the Task infrastructure will assign the value of the Task Content Type parameter to it. This allows transforms to be written that generate Block trees and the Task caller can decide how they are rendered.

See Also:

Constant Field Values

initializationErrorMessage

protected java.lang.String initializationErrorMessage

If an error occurred at initialization time, then this field contains the message.

Constructor Detail

WebComponentTask

public WebComponentTask()

No args constructor for a WebComponentTask.

Method Detail

init

public void init(ContainerServices containerSvcs)

Handles the initialization of the task. This involves parsing the XML file and retrieving all of the contents. This method calls registerTaskMetadata(TaskMetadata).

Specified by:

init in interface Task

Overrides:

init in class AbstractBaseTask

Parameters:

containerSvcs - The ContainerServices object that can be used to find more initialization parameters.

newRequestContext

public TaskRequestContext newRequestContext()

Returns a BeanTaskRequestContext object to use for the duration of this request.

Specified by:

newRequestContext in interface Task

Overrides:

newRequestContext in class AbstractAppTask

Returns:

The BeanTaskRequestContext object to use for the duration of this request.

processRequest

public void processRequest(TaskRequestContext context,
                           TaskOutput taskOutput)
                    throws TaskException

Process the incoming request. This method proceeds through the following sequence:

1. Check for all required parameters. (calls AbstractBaseTask.checkForRequiredParameters(RequestKeys))
2. Prepare the RequestKeys for use. (calls prepareRequestKeys(BeanTaskRequestContext))
3. Prepare the WebBean for use. (calls prepareBean(BeanTaskRequestContext))
4. Handle the event. (calls handleEvent(BeanTaskRequestContext))
5. Collect data for the request. (calls collectData(BeanTaskRequestContext))
6. Serialize the results into the supplied TaskOutput. (calls serializeResult(BeanTaskRequestContext, TaskOutput))

Specified by:

processRequest in interface Task

Overrides:

processRequest in class AbstractBaseTask

Parameters:

context - The TaskRequestContext object that contains information specific to this request.

taskOutput - The TaskOutput object to serialize the results into.

Throws:

TaskException - If anything fails in the process of servicing the request.

TaskConfigurationException - If the task is not properly configured.

See Also:

Task.processRequest(TaskRequestContext, TaskOutput)

destroy

public void destroy()

Destroy any data structures created by the 'init' method.

Specified by:

destroy in interface Task

Overrides:

destroy in class AbstractBaseTask

setTaskID

public void setTaskID(java.lang.String taskID)

Sets the Task ID.

Parameters:

taskID - The Task ID.

registerTaskMetadata

protected void registerTaskMetadata(TaskMetadata sourceMetadata)

This method is used to register the task metadata. It is a method invoked by the init(ContainerServices) method. This method in turn calls registerParameterMetadata(TaskParameterMetadata) for each task parameter.

Parameters:

sourceMetadata - The TaskMetadata object being registered.

registerParameterMetadata

protected void registerParameterMetadata(TaskParameterMetadata parameterMetadata)

Registers a specific Task parameter metadata. This method is called by registerTaskMetadata(TaskMetadata). It is helpful to override in a Task so that a specific TaskParameterMetadata may be saved for later use.

Parameters:

parameterMetadata - The TaskParameterMetadata object being saved.

prepareRequestKeys

protected void prepareRequestKeys(BeanTaskRequestContext btrContext)

Prepares the RequestKeys for handling the event. This method is called inside processRequest(TaskRequestContext, TaskOutput). This method, in turn, calls:

1. prepareParameterRequestKeys(RequestKeys)
2. prepareEventRequestKeys(RequestKeys)

Parameters:

btrContext - The BeanTaskRequestContext object.

prepareParameterRequestKeys

protected void prepareParameterRequestKeys(RequestKeys requestKeys)

This method prepares the RequestKeys by adding any default values for parameters.

Parameters:

requestKeys - The RequestKeys instance to add the default values to.

prepareEventRequestKeys

protected void prepareEventRequestKeys(RequestKeys requestKeys)

This method prepares the RequestKeys by adding the necessary keys for events. If there is only one event, then the GenericWebEvent.URL_EVENT_NAME key is added. Otherwise, the prepareEventOrderRequestKeys(RequestKeys) method is called. Next, it calls the prepareArgumentRequestKeys(RequestKeys) method to add any keys defined for Event Arguments in the Bean Task XML.

Parameters:

requestKeys - The RequestKeys object to add keys to.

prepareEventRequestKeys

protected void prepareEventRequestKeys(RequestKeys requestKeys,
                                       EventInfo[] events)

prepareEventOrderRequestKeys

protected void prepareEventOrderRequestKeys(RequestKeys requestKeys)

The method sets the request keys necessary for multiple events. This method is called in the prepareEventRequestKeys(RequestKeys) method.

Parameters:

requestKeys - The RequestKeys instance to add keys to.

prepareEventOrderRequestKeys

protected void prepareEventOrderRequestKeys(RequestKeys requestKeys,
                                            EventInfo[] events)

prepareArgumentRequestKeys

protected void prepareArgumentRequestKeys(RequestKeys requestKeys)

This method prepares the RequestKeys by adding the necessary "event argument" parameters. This method is called in the prepareEventRequestKeys(RequestKeys) method.

Parameters:

requestKeys - The RequestKeys object to add keys to.

prepareArgumentRequestKeys

protected void prepareArgumentRequestKeys(RequestKeys requestKeys,
                                          EventInfo[] events)

prepareBean

protected void prepareBean(BeanTaskRequestContext btrContext)
                    throws TaskException

This method prepares the WebBean for execution. It is called by the processRequest(TaskRequestContext, TaskOutput) method. It performs the following actions:

1. Creates a new WebBean instance and adds it to the context. (calls createWebBean(BeanTaskRequestContext))
2. Sets any bean properties. (calls setBeanProperties(BeanTaskRequestContext))
3. Restores any bean state. (calls restoreBeanState(BeanTaskRequestContext))

Parameters:

btrContext - The BeanTaskRequestContext to use.

Throws:

TaskException - If anything fails along the way.

handleEvent

protected void handleEvent(BeanTaskRequestContext btrContext)
                    throws TaskException

This method instructs the WebBean to handle the event. It is called from processRequest(TaskRequestContext, TaskOutput).

Parameters:

btrContext - The BeanTaskRequestContext that contains the WebBean instance.

Throws:

TaskException - If something fails in the process of handling the event.

TaskRequestMalformedException - If there was an exception raised while handling the event.

collectData

protected void collectData(BeanTaskRequestContext btrContext)
                    throws TaskException

This method calls the 'collectData' method on the WebBean instance. This method is called by processRequest(TaskRequestContext, TaskOutput).

Parameters:

btrContext - The BeanTaskRequestContext object.

Throws:

TaskException - If there is a failure while trying to collect data for the Web Bean.

generatesContent

protected boolean generatesContent(BeanTaskRequestContext btrContext)
                            throws TaskException

This method determines whether the Task is going to generate any content. Some tasks are "write only" in nature: they send data to the backend, but return nothing (other than a status).

Parameters:

btrContext - The BeanTaskRequestContext object.

Returns:

true if we can determine that content could be generated by this Task; false, otherwise.

Throws:

TaskException - if the style parameter is not correctly specified.

serializeResult

protected void serializeResult(BeanTaskRequestContext btrContext,
                               TaskOutput taskOutput)
                        throws TaskException

This method attempts to serialize the results to the supplied TaskOutput object. This method is called by processRequest(TaskRequestContext, TaskOutput) and in turn does the following:

1. Add the Transform. If there is no transform specified, an empty MarkupOutput is returned. (calls addTransform(BeanTaskRequestContext))
2. Override any actual parameters specified in the Bean Task XML. (calls overrideActualParameters(BeanTaskRequestContext, TransformInstance))
3. Transforms the WebBean using the Transform. (calls transformBean(BeanTaskRequestContext, TaskOutput))

Parameters:

btrContext - The BeanTaskRequestContext object.

taskOutput - The TaskOutput object to populate.

Throws:

TaskException - If something fails along the way.

addTransform

protected TransformInstance addTransform(BeanTaskRequestContext btrContext)
                                  throws TaskConfigurationException,
                                         TaskRequestMalformedException

Adds the specified Transform to the WebBean. This method is called by serializeResult(BeanTaskRequestContext, TaskOutput) and performs the following actions:

1. Retrieves the name of the style to use.
2. Adds the Transform by looking up the style.

Parameters:

btrContext - The BeanTaskRequestContext to use.

Returns:

The TransformInstance that was created, if any.

Throws:

TaskConfigurationException - If the static style name does not exist in the StyleCatalog.

TaskRequestMalformedException - If the dynamic style name does not exist in the Style Catalog.

getStyleName

protected java.lang.String getStyleName(BeanTaskRequestContext btrContext)
                                 throws TaskRequestMalformedException

Throws:

TaskRequestMalformedException

overrideActualParameters

protected void overrideActualParameters(BeanTaskRequestContext btrContext,
                                        TransformInstance instance)
                                 throws TaskRequestMalformedException

Overrides any actual parameters specified in the Bean Task XML. This method is called by the serializeResult(BeanTaskRequestContext, TaskOutput) method.

Parameters:

btrContext - The BeanTaskRequestContext to use.

instance - The TransformInstance to operate on.

Throws:

TaskRequestMalformedException

transformBean

protected void transformBean(BeanTaskRequestContext btrContext,
                             TaskOutput taskOutput)
                      throws TaskConfigurationException

This method wraps a call to Transformable.transform(). It is called by the serializeResult(BeanTaskRequestContext, TaskOutput) method and simply calls the 'transform' method.

Parameters:

btrContext - The BeanTaskRequestContext object.

taskOutput - The TaskOutput instance to generate into.

Throws:

TaskConfigurationException - If the Transform does not exist.

createWebBean

protected WebComponent createWebBean(BeanTaskRequestContext btrContext)
                              throws TaskConfigurationException

This method creates the WebComponent or WebBean from the specified bean type. If no type is specified, then an "untyped" WebComponent is created using the createUntypedWebComponent(BeanTaskRequestContext) method.

Parameters:

btrContext - The BeanTaskRequestContext object.

Returns:

The WebComponent instance created of the specified type.

Throws:

TaskConfigurationException - If we are unable to create a WebBean or WebComponent of the specified type

See Also:

createUntypedWebComponent(BeanTaskRequestContext)

createUntypedWebComponent

protected WebComponent createUntypedWebComponent(BeanTaskRequestContext btrContext)
                                          throws TaskConfigurationException

This method creates an instance of an "untyped" Web Component. This component implements the Transformable interface and can be used with any Transform. It provides no specialized data access methods.

Parameters:

btrContext - The BeanTaskRequestContext object.

Returns:

An instance of a WebComponent to use when no bean type has been specified.

Throws:

TaskConfigurationException - If we are unable to create an instance.

See Also:

createWebBean(BeanTaskRequestContext)

setBeanProperties

protected void setBeanProperties(BeanTaskRequestContext btrContext)
                          throws TaskException

Set any properties on the Bean. This method is called by the prepareBean(BeanTaskRequestContext) method and performs the following actions:

1. Sets the Bean Name. (calls setBeanName(BeanTaskRequestContext))
2. Sets the Bean Session. (calls setBeanSession(BeanTaskRequestContext))
3. Sets the Bean Context. (calls setBeanContext(BeanTaskRequestContext))

Parameters:

btrContext - The BeanTaskRequestContext object to use.

Throws:

TaskException - If any of the subordinate methods raise an exception while setting a specific property of the Bean.

restoreBeanState

protected void restoreBeanState(BeanTaskRequestContext btrContext)

Restores the state of a previously serialized WebBean. This method is called by prepareBean(BeanTaskRequestContext) and calls the RequestPersistable.restoreStateFromRequest(RequestKeys) method on the WebBean.

Parameters:

btrContext - The BeanTaskRequestContext object to use.

setBeanName

protected void setBeanName(BeanTaskRequestContext btrContext)

Sets the Bean's name. This method is called by setBeanProperties(BeanTaskRequestContext).

Parameters:

btrContext - The BeanTaskRequestContext object to use.

setBeanSession

protected void setBeanSession(BeanTaskRequestContext btrContext)
                       throws TaskException

Set the WebIServerSession object to use with the WebBean. This method is called by the setBeanProperties(BeanTaskRequestContext) method.

Parameters:

btrContext - The BeanTaskRequestContext object to use.

Throws:

TaskException - If there is not enough information to create a WebIServerSession instance.

requiresIServerSession

protected boolean requiresIServerSession()

Returns whether this Task requires an Intelligence Server session.

Returns:

True if this Task requires an Intelligence Server session; otherwise, false. The base implementation simply checks whether the session state parameter is defined for this Task.

setBeanContext

protected void setBeanContext(BeanTaskRequestContext btrContext)

Set the BeanContext associated with the Bean. This method is called by the setBeanProperties(BeanTaskRequestContext) method.

Parameters:

btrContext - The BeanTaskRequestContext object to use.

getBeanInfo

protected BeanInfo getBeanInfo()

Returns the BeanInfo object associated with this BeanTask.

Returns:

The BeanInfo object associated with this BeanTask.

setBeanInfo

protected void setBeanInfo(BeanInfo beanInfo)

Sets the BeanInfo object associated with this BeanTask.

Parameters:

beanInfo - The BeanInfo object associated with this BeanTask.

isSuccessfullyInitialized

protected boolean isSuccessfullyInitialized()

Returns whether the BeanTask was successfully initialized or not.

Returns:

Whether the BeanTask was successfully initialized or not.

setSuccessfullyInitialized

protected void setSuccessfullyInitialized(boolean successfullyInitialized)

Sets whether the BeanTask was successfully initialized or not.

Parameters:

successfullyInitialized - Whether the BeanTask was successfully initialized or not.