com.infoengine.SAK
Class Task

java.lang.Object
  com.infoengine.SAK.Task

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Task
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

This class supports dynamic compilation, instantiation, and execution of Info*Engine tasks.

See Also:

Serialized Form

Field Summary

static java.lang.String	RESOURCE
static int	TYPE_CREDENTIALS_MAPPER
static int	TYPE_NORMAL

Constructor Summary

Task()
Constructs an instance that is initialized with no task URI.

Task(java.lang.String uri)
Constructs an instance that is initialized with a specified task URI.

Task(java.lang.String uri, java.lang.String processor)
Constructs an instance that causes a task to be executed on a remote task processor.

Task(java.lang.String uri, java.util.Vector processors)
Constructs an instance that causes a task to be executed on a remote task processor.

Method Summary

void	addGroup(Group group) Adds a group to the task's VDB.
void	addParam(java.lang.String name, java.lang.Object value) Adds a task parameter value.
void	addProcessor(java.lang.String name) Adds a name to the vector of remote task processor names.
void	compile() Compiles the task if it needs to be compiled.
static IeCollection	executeTask(java.lang.String uri, java.lang.String processor, Task task, IeCollection vdb, Group form) Executes a task specified by URI.
static IeCollection	executeTask(java.lang.String uri, Task task, java.lang.Boolean isCredentialsMapper) Executes a task specified by URI.
static IeCollection	executeTask(java.lang.String uri, java.util.Vector processors, Task task, IeCollection vdb, Group form) Executes a task specified by URI.
static void	executeTaskRemotely(java.lang.String uri, Task task, IeService service, IeMultipartInputStream is, java.io.OutputStream os, java.util.Vector processors) Executes a task in a remote task processor.
Group	getAuthMapGroup() Returns the group containing authentication mapping information.
Group	getCookieGroup() Returns the group containing attributes that serve as cookie information.
Group	getFormGroup() Returns the group containing attributes that serve as form variables.
Group	getGroup(java.lang.String name) Returns a group from the task's VDB.
java.util.Enumeration	getGroupNames() Returns the names of all groups in the task's VDB.
IeMultipartInputStream	getInputStream() Returns the input stream currently associated with the task.
com.infoengine.log.LogWriter	getLog() Returns the log writer currently associated with the object.
java.io.OutputStream	getOutputStream() Returns the output stream currently associated with this task object.
java.lang.Object	getParam(java.lang.String name) Returns the value of a task parameter.
java.util.Enumeration	getParamNames() Returns the names of all task parameters currently defined.
java.util.Vector	getProcessors() Returns the vector of remote task processor names.
Group	getServerGroup() Returns the group containing attributes that serve as server variables.
IeService	getService() Returns the server context currently associated with this task.
Tasklet	getTasklet() Returns the compiled tasklet associated with this task object.
int	getTaskType() Returns the task type currently associated with this task.
java.lang.String	getTaskURI() Returns the URI of the Info*Engine task currently associated with the object.
IeCollection	getVDB() Returns the VDB of the task.
void	initialize(Tasklet tasklet, java.lang.String uri) Initializes the task from an initialized tasklet (usually the parent tasklet of a new subtask).
void	invoke() Executes the compiled tasklet.
boolean	isInterruptable() Returns whether or not this task is intended to be interruptable accrossed VM boundaries.
void	recover() Recovers the saved state of a task.
void	removeAllParams() Removes all parameters from the set of task parameters that will be passed to the tasklet associated with this task.
void	removeParam(java.lang.String name) Removes a parameter from the set of task parameters that will be passed to the tasklet associated with this task.
void	setAuthMapGroup(Group group) Sets the group containing authentication mapping information.
void	setCheckpointProcessor(java.lang.String uniqueIdentifier, com.infoengine.SAK.CheckpointProcessor checkpointProcessor) Sets the checkpoint processor associated with the Task object.
void	setCookieGroup(Group group) Sets the group containing attributes that serve as cookie information.
void	setFormGroup(Group group) Sets the group containing attributes that serve as form variables.
void	setInputStream(IeMultipartInputStream is) Sets the input stream from which the task can read BLOB data.
void	setInputStream(java.io.InputStream is, java.lang.String contentType, java.lang.String name, java.lang.String filename) Sets the input stream from which the task can read BLOB data.
void	setInputStream(javax.servlet.ServletRequest request) Sets the input stream from which the task can read BLOB data.
void	setInterruptable(boolean interruptable) Sets the interruptable flag on this task.
void	setLog(com.infoengine.log.LogWriter log) Sets the log writer associated with the object.
void	setOutputStream(java.io.OutputStream os) Sets the output stream associated with this task object.
void	setOutputStream(java.io.Writer writer) Sets the output stream associated with this task object.
void	setParam(java.lang.String name, java.lang.Object value) Sets the value of a task parameter.
void	setProcessors(java.util.Vector processors) Sets the vector of remote task processor names associated with the task.
void	setRequest(javax.servlet.http.HttpServletRequest request) Associates an HTTP servlet request object with the task.
void	setServerAttribute(java.lang.String name, java.lang.String value) Sets an attribute in the server context group (@SERVER).
void	setServerGroup(Group group) Sets the group containing attributes that serve as server variables.
void	setService(IeService service) Sets the server context associated with this task.
void	setTaskType(int taskType) Sets the type of the task.
void	setTaskURI(java.lang.String taskURI) Sets the URI of the Info*Engine task to associate with the object.
void	setUsername(java.lang.String user) Sets the "auth-user" attribute value in the SERVER context group (@SERVER).
void	setUsername(java.lang.String user, java.lang.String signer) Sets the "auth-user" attribute value in the SERVER context group and also sets "auth-signer" and "auth-signature" attribute values that provide a digital signature for the username and the name of the signer.
void	setUsername(java.lang.String user, java.lang.String signer, java.security.PrivateKey key) Sets the "auth-user" attribute value in the SERVER context group and also sets "auth-signer" and "auth-signature" attribute values that provide a digital signature for the username and the name of the signer.
void	setUsername(java.lang.String user, java.lang.String signer, java.lang.String password, java.security.KeyStore keystore) Sets the "auth-user" attribute value in the SERVER context group and also sets "auth-signer" and "auth-signature" attribute values that provide a digital signature for the username and the name of the signer.
void	setVDB(IeCollection vdb) Sets the VDB of the task.
static void	signUsername(Task task, java.lang.String signer) Sets the "auth-signer" and "auth-signature" attribute values that provide a digital signature for the "auth-user" attribute of the SERVER context group of a specific task.
static void	signUsername(Task task, java.lang.String signer, java.security.PrivateKey key) Signs the auth-user attribute value in a SERVER context group using a specific signer's name and private key.
static void	signUsername(Task task, java.lang.String user, java.lang.String signer) Sets the "auth-user" attribute value in the SERVER context group of a specific task and also sets "auth-signer" and "auth-signature" attribute values that provide a digital signature for the username and the name of the signer.
static void	signUsername(Task task, java.lang.String user, java.lang.String signer, java.security.PrivateKey key) Sets a specific value for the auth-user attribute value in the SERVER context group of a specific task, and signs it using a specific signer's name and private key.
static void	signUsername(Task task, java.lang.String user, java.lang.String signer, java.lang.String password, java.security.KeyStore keystore) Sets the "auth-user" attribute value in the SERVER context group of a specific task and also sets "auth-signer" and "auth-signature" attribute values that provide a digital signature for the username and the name of the signer.
java.lang.String	toString() Returns a string containing the output currently associated with this task.
static boolean	verifyUsername(Task task) Verifies the authenticity of the auth-user attribute value in a SERVER context group based upon the auth-signer and auth-signature attribute values of the same group.
static boolean	verifyUsername(Task task, java.security.cert.Certificate certificate) Verifies the authenticity of the auth-user attribute value in a SERVER context group based upon the auth-signer and auth-signature attribute values of the same group.
static boolean	verifyUsername(Task task, java.security.KeyStore keystore) Verifies the authenticity of the auth-user attribute value in a SERVER context group based upon the auth-signer and auth-signature attribute values of the same group.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

public static final java.lang.String RESOURCE

See Also:

Constant Field Values

TYPE_NORMAL

public static final int TYPE_NORMAL

See Also:

Constant Field Values

TYPE_CREDENTIALS_MAPPER

public static final int TYPE_CREDENTIALS_MAPPER

See Also:

Constant Field Values

Constructor Detail

Task

public Task()

Constructs an instance that is initialized with no task URI. Use setTaskURI to specify the URI of the Info*Engine task associated with this object.

Task

public Task(java.lang.String uri)

Constructs an instance that is initialized with a specified task URI.

Parameters:

uri - The URI of the Info*Engine task to associate with this object.

Task

public Task(java.lang.String uri,
            java.util.Vector processors)

Constructs an instance that causes a task to be executed on a remote task processor.

Parameters:

uri - The URI of the Info*Engine task to associate with this object.

processors - A vector of task processor names. Each of these processors has a copy of the specified task. The processors are tried in sequence until a connection can be created successfully to one of them.

Task

public Task(java.lang.String uri,
            java.lang.String processor)

Constructs an instance that causes a task to be executed on a remote task processor.

Parameters:

uri - The URI of the Info*Engine task to associate with this object.

processor - The name of the task processor on which to execute the task.

Method Detail

getTaskURI

public java.lang.String getTaskURI()

Returns the URI of the Info*Engine task currently associated with the object.

Returns:

The task URI currently associated with the object.

setTaskURI

public void setTaskURI(java.lang.String taskURI)

Sets the URI of the Info*Engine task to associate with the object.

Parameters:

taskURI - The new task URI.

getTasklet

public Tasklet getTasklet()

Returns the compiled tasklet associated with this task object.

Returns:

The tasklet associated with this task

setService

public void setService(IeService service)

Sets the server context associated with this task.

Parameters:

service - The new server context.

getService

public IeService getService()

Returns the server context currently associated with this task.

Returns:

The task's current server context.

setTaskType

public void setTaskType(int taskType)

Sets the type of the task. his is usually one of TYPE_NORMAL or TYPE_CREDENTIALS_MAPPER.

Parameters:

taskType - The new task type.

getTaskType

public int getTaskType()

Returns the task type currently associated with this task.

Returns:

The task's current type.

setLog

public void setLog(com.infoengine.log.LogWriter log)

Sets the log writer associated with the object. If a log writer is defined, the object will write informative messages to it.

Parameters:

log - The new log writer.

getLog

public com.infoengine.log.LogWriter getLog()

Returns the log writer currently associated with the object.

Returns:

The log writer currently associated with the object.

setCheckpointProcessor

public void setCheckpointProcessor(java.lang.String uniqueIdentifier,
                                   com.infoengine.SAK.CheckpointProcessor checkpointProcessor)

Sets the checkpoint processor associated with the Task object. The checkpoint processor is an object that is responsible for saving the state of the task such that it can be restored to restart the task after its execution is interrupted for some reason. Normally, this method is called by a task processor service that implements guaranteed task execution.

Parameters:

uniqueIdentifier - The unique identifier assigned to the task instance. This will be passed to the checkpoint processor object to aid it in associating saved state with a specific task instance over time.

checkpointProcessor - The object that can be called to save a task's state. If null, state information will not be saved for the task.

recover

public void recover()
             throws IEException

Recovers the saved state of a task. If no saved state exists, this method returns without error and without changing the state of the task instance. Before calling this method, setCheckpointProcessor must be called in order to establish a checkpoint processor and the unique identifier of the task to be recovered. The checkpoint processor is expected to throw the exception com.infoengine.exception.nonfatal.IENoSavedStateException when no saved state is available (usually because no state was previously saved).

Throws:

IEException - if state can not be recovered or queried successfully.

setProcessors

public void setProcessors(java.util.Vector processors)

Sets the vector of remote task processor names associated with the task. When the task is invoked, the task processors in the vector are tried one at a time in sequence until a connection is successfully made to one of them. A request to execute the remote task is then sent to the processor.

Parameters:

processors - The vector of remote task processor names.

getProcessors

public java.util.Vector getProcessors()

Returns the vector of remote task processor names.

Returns:

The vector of remote task processor names.

addProcessor

public void addProcessor(java.lang.String name)

Adds a name to the vector of remote task processor names.

Parameters:

name - The name of a remote task processor.

setInputStream

public void setInputStream(java.io.InputStream is,
                           java.lang.String contentType,
                           java.lang.String name,
                           java.lang.String filename)
                    throws java.io.IOException

Sets the input stream from which the task can read BLOB data.

Parameters:

is - The input stream.

contentType - The MIME content type associated with the stream.

name - The form variable name, if any, associated with the stream.

filename - The file name, if any, associated with the stream.

Throws:

java.io.IOException - if the input stream can not be set.

setInputStream

public void setInputStream(javax.servlet.ServletRequest request)
                    throws java.io.IOException

Sets the input stream from which the task can read BLOB data. The input stream is obtained from a servlet request object.

Parameters:

request - The servlet request object from which the input stream will be obtained.

Throws:

java.io.IOException - if the input stream can not be set.

setInputStream

public void setInputStream(IeMultipartInputStream is)

Sets the input stream from which the task can read BLOB data.

Parameters:

is - The Info*Engine multipart input stream from which the task can read BLOB data.

getInputStream

public IeMultipartInputStream getInputStream()

Returns the input stream currently associated with the task.

Returns:

The input stream currently associated with the task.

setOutputStream

public void setOutputStream(java.io.OutputStream os)

Sets the output stream associated with this task object.

Parameters:

os - The new output stream.

setOutputStream

public void setOutputStream(java.io.Writer writer)

Sets the output stream associated with this task object. This method uses the WriterOutputStream class to wrap a writer so that it can be used as the output stream of the task.

Parameters:

writer - The writer to be wrapped in an output stream.

getOutputStream

public java.io.OutputStream getOutputStream()

Returns the output stream currently associated with this task object.

Returns:

The task's current output stream.

setParam

public void setParam(java.lang.String name,
                     java.lang.Object value)

Sets the value of a task parameter. These parameters are passed to the tasklet associated with this task when it is invoked via the invoke method. The getParam method of the tasklet can be used by the tasklet to query these parameters.

Parameters:

name - The name of the parameter to set.

value - The value to associate with the name.

addParam

public void addParam(java.lang.String name,
                     java.lang.Object value)

Adds a task parameter value. These parameters are passed to the tasklet associated with this task when it is invoked via the invoke method. The getParam method of the tasklet can be used by the tasklet to query these parameters.

Parameters:

name - The name of the parameter to add.

value - The value to associate with the name.

getParam

public java.lang.Object getParam(java.lang.String name)

Returns the value of a task parameter.

Parameters:

name - The name of the parameter to return.

Returns:

The value of the parameter, or null if the parameter is unknown.

getParamNames

public java.util.Enumeration getParamNames()

Returns the names of all task parameters currently defined.

Returns:

The names of all currently defined task parameters.

removeParam

public void removeParam(java.lang.String name)

Removes a parameter from the set of task parameters that will be passed to the tasklet associated with this task.

Parameters:

name - The name of the parameter to remove.

removeAllParams

public void removeAllParams()

Removes all parameters from the set of task parameters that will be passed to the tasklet associated with this task.

setAuthMapGroup

public void setAuthMapGroup(Group group)

Sets the group containing authentication mapping information.

Parameters:

group - The new group containing authentication mapping information.

getAuthMapGroup

public Group getAuthMapGroup()

Returns the group containing authentication mapping information.

Returns:

The task's current authentication mapping group.

setFormGroup

public void setFormGroup(Group group)

Sets the group containing attributes that serve as form variables. The attributes of this group can be accessed within tasks using the group name @FORM.

Parameters:

group - The new group containing form variables.

getFormGroup

public Group getFormGroup()

Returns the group containing attributes that serve as form variables.

Returns:

The task's current form group.

setInterruptable

public void setInterruptable(boolean interruptable)

Sets the interruptable flag on this task. If true and the task is bound for an external task processor then the current Thread can be interrupted and the corresponding thread in the task processor VM will also be interrupted.

Parameters:

interruptable - Whether or not to allow interruption accrossed VM boundaries.

isInterruptable

public boolean isInterruptable()

Returns whether or not this task is intended to be interruptable accrossed VM boundaries.

setServerGroup

public void setServerGroup(Group group)

Sets the group containing attributes that serve as server variables. The attributes of this group can be accessed within tasks using the group name @SERVER.

Parameters:

group - The new group containing server variables.

getServerGroup

public Group getServerGroup()

Returns the group containing attributes that serve as server variables.

Returns:

The task's current server group.

setServerAttribute

public void setServerAttribute(java.lang.String name,
                               java.lang.String value)

Sets an attribute in the server context group (@SERVER).

Parameters:

name - The name of the attribute to set.

value - The value of the attribute.

setUsername

public void setUsername(java.lang.String user)

Sets the "auth-user" attribute value in the SERVER context group (@SERVER).

Parameters:

user - The username to set.

setUsername

public void setUsername(java.lang.String user,
                        java.lang.String signer)
                 throws IEException

Sets the "auth-user" attribute value in the SERVER context group and also sets "auth-signer" and "auth-signature" attribute values that provide a digital signature for the username and the name of the signer. The file system pathname of the keystore, the keystore type, the keystore password, and the password used in obtaining the signer's private key are obtained from configuration properties serviceName.keystore.path, serviceName.keystore.type, serviceName.keystore.password, and serviceName.keystore.signer.password.

Parameters:

user - The username to set. Usually, this is a user's LDAP directory distinguished name.

signer - The alias of the signer. This is the alias that selects a private key from the keystore. The alias is conveyed to the verifier in the auth-signer attribute, so it must be known to the verifier because the verifier will use it to select a public certificate from its keystore.

Throws:

IEException - if the signer's private key can not be obtained from the keystore or the key can not be used successfully in creating the signature.

See Also:

Signature

setUsername

public void setUsername(java.lang.String user,
                        java.lang.String signer,
                        java.lang.String password,
                        java.security.KeyStore keystore)
                 throws IEException

Sets the "auth-user" attribute value in the SERVER context group and also sets "auth-signer" and "auth-signature" attribute values that provide a digital signature for the username and the name of the signer.

Parameters:

user - The username to set. Usually, this is a user's LDAP directory distinguished name.

signer - The alias of the signer. This is the alias that selects a private key from the keystore. The alias is conveyed to the verifier in the auth-signer attribute, so it must be known to the verifier because the verifier will use it to select a public certificate from its keystore.

password - The password to use in recovering the signer's private key from the keystore.

keystore - The keystore object containing the private key of the signer.

Throws:

IEException

See Also:

Signature

setUsername

public void setUsername(java.lang.String user,
                        java.lang.String signer,
                        java.security.PrivateKey key)
                 throws IEException

Sets the "auth-user" attribute value in the SERVER context group and also sets "auth-signer" and "auth-signature" attribute values that provide a digital signature for the username and the name of the signer.

Parameters:

user - The username to set. Usually, this is a user's LDAP directory distinguished name.

signer - The alias of the signer. This is the alias that selects a private key from the keystore. The alias is conveyed to the verifier in the auth-signer attribute, so it must be known to the verifier because the verifier will use it to select a public certificate from its keystore.

key - The private key to use in generating the signed authorization.

Throws:

IEException

See Also:

Signature

signUsername

public static void signUsername(Task task,
                                java.lang.String signer)
                         throws IEException

Sets the "auth-signer" and "auth-signature" attribute values that provide a digital signature for the "auth-user" attribute of the SERVER context group of a specific task. The file system pathname of the keystore, the keystore type, the keystore password, and the password used in obtaining the signer's private key are obtained from configuration properties serviceName.keystore.path, serviceName.keystore.type, serviceName.keystore.password, and serviceName.keystore.signer.password.

Parameters:

task - The com.infoengine.object.factory.Task instance containing the SERVER context group.

signer - The alias of the signer. This is the alias that selects a private key from the keystore. The alias is conveyed to the verifier in the auth-signer attribute, so it must be known to the verifier because the verifier will use it to select a public certificate from its keystore.

Throws:

IEException - if the signer's private key can not be obtained from the keystore or the key can not be used successfully in creating the signature.

See Also:

Signature

signUsername

public static void signUsername(Task task,
                                java.lang.String user,
                                java.lang.String signer)
                         throws IEException

Sets the "auth-user" attribute value in the SERVER context group of a specific task and also sets "auth-signer" and "auth-signature" attribute values that provide a digital signature for the username and the name of the signer. The file system pathname of the keystore, the keystore type, the keystore password, and the password used in obtaining the signer's private key are obtained from configuration properties serviceName.keystore.path, serviceName.keystore.type, serviceName.keystore.password, and serviceName.keystore.signer.password.

Parameters:

task - The com.infoengine.object.factory.Task instance containing the SERVER context group.

user - The username to set. Usually, this is a user's LDAP directory distinguished name.

signer - The alias of the signer. This is the alias that selects a private key from the keystore. The alias is conveyed to the verifier in the auth-signer attribute, so it must be known to the verifier because the verifier will use it to select a public certificate from its keystore.

Throws:

IEException - if the signer's private key can not be obtained from the keystore or the key can not be used successfully in creating the signature.

See Also:

Signature

signUsername

public static void signUsername(Task task,
                                java.lang.String user,
                                java.lang.String signer,
                                java.lang.String password,
                                java.security.KeyStore keystore)
                         throws IEException

Sets the "auth-user" attribute value in the SERVER context group of a specific task and also sets "auth-signer" and "auth-signature" attribute values that provide a digital signature for the username and the name of the signer.

Parameters:

task - The com.infoengine.object.factory.Task instance containing the SERVER context group.

user - The username to set. Usually, this is a user's LDAP directory distinguished name.

signer - The alias of the signer. This is the alias that selects a private key from the keystore. The alias is conveyed to the verifier in the auth-signer attribute, so it must be known to the verifier because the verifier will use it to select a public certificate from its keystore.

password - The password to use in recovering the signer's private key from the keystore.

keystore - The keystore object containing the private key of the signer.

Throws:

IEException - if an exception prevents the auth-user value from being signed.

See Also:

Signature

signUsername

public static void signUsername(Task task,
                                java.lang.String user,
                                java.lang.String signer,
                                java.security.PrivateKey key)
                         throws IEException

Sets a specific value for the auth-user attribute value in the SERVER context group of a specific task, and signs it using a specific signer's name and private key.

Parameters:

task - The com.infoengine.object.factory.Task instance containing the SERVER context group.

user - The value to set for the auth-user attribute of the SERVER context group.

signer - The signer's name. This name will be used by the receiving system to look up the signer's public key.

key - The signer's private key.

Throws:

IEException - if an exception prevents the auth-user value from being signed.

signUsername

public static void signUsername(Task task,
                                java.lang.String signer,
                                java.security.PrivateKey key)
                         throws IEException

Signs the auth-user attribute value in a SERVER context group using a specific signer's name and private key. If the SERVER context group does not contain an auth-user attribute, no signature is generated.

Parameters:

task - The com.infoengine.object.factory.Task instance containing the SERVER context group with the auth-user attribute to be signed.

signer - The signer's name. This name will be used by the receiving system to look up the signer's public key.

key - The signer's private key.

Throws:

IEException - if an exception prevents the auth-user value from being signed.

verifyUsername

public static boolean verifyUsername(Task task)
                              throws IEException

Verifies the authenticity of the auth-user attribute value in a SERVER context group based upon the auth-signer and auth-signature attribute values of the same group.

Parameters:

task - The com.infoengine.object.factory.Task instance containing the SERVER context group with the attributes to be verified.

Returns:

true if digital signature information is present and the auth-user value is verified successfully.

Throws:

IEException - if an exception prevents the auth-user value from being verified.

verifyUsername

public static boolean verifyUsername(Task task,
                                     java.security.KeyStore keystore)
                              throws IEException

Verifies the authenticity of the auth-user attribute value in a SERVER context group based upon the auth-signer and auth-signature attribute values of the same group.

Parameters:

task - The com.infoengine.object.factory.Task instance containing the SERVER context group with the attributes to be verified.

keystore - The keystore from which to obtain the signer's public certificate.

Returns:

true if digital signature information is present and the auth-user value is verified successfully.

Throws:

IEException - if an exception prevents the auth-user value from being verified.

verifyUsername

public static boolean verifyUsername(Task task,
                                     java.security.cert.Certificate certificate)
                              throws IEException

Verifies the authenticity of the auth-user attribute value in a SERVER context group based upon the auth-signer and auth-signature attribute values of the same group.

Parameters:

task - The com.infoengine.object.factory.Task instance containing the SERVER context group with the attributes to be verified.

certificate - The signer's public certificate.

Returns:

true if digital signature information is present and the auth-user value is verified successfully.

Throws:

IEException - if an exception prevents the auth-user value from being verified.

setCookieGroup

public void setCookieGroup(Group group)

Sets the group containing attributes that serve as cookie information. The attributes of this group can be accessed within tasks using the group name @COOKIE.

Parameters:

group - The new group containing cookie information.

getCookieGroup

public Group getCookieGroup()

Returns the group containing attributes that serve as cookie information.

Returns:

The task's current cookie group.

setVDB

public void setVDB(IeCollection vdb)

Sets the VDB of the task.

Parameters:

vdb - The new VDB

getVDB

public IeCollection getVDB()

Returns the VDB of the task.

Returns:

The VDB collection of the task.

addGroup

public void addGroup(Group group)

Adds a group to the task's VDB.

Parameters:

group - the group to be added

getGroup

public Group getGroup(java.lang.String name)

Returns a group from the task's VDB.

Parameters:

name - the name of the group to be returned

Returns:

the group, or null if the group does not exist

getGroupNames

public java.util.Enumeration getGroupNames()

Returns the names of all groups in the task's VDB.

Returns:

The names of all groups in the VDB.

initialize

public void initialize(Tasklet tasklet,
                       java.lang.String uri)
                throws IEException

Initializes the task from an initialized tasklet (usually the parent tasklet of a new subtask).

Parameters:

tasklet - the reference tasklet from which to initialize this task

uri - the URI of the source for this task

Throws:

IEException

setRequest

public void setRequest(javax.servlet.http.HttpServletRequest request)
                throws java.io.IOException

Associates an HTTP servlet request object with the task. HTTP protocol headers are read to establish the server context group, form and query string variables are read to establish the form context group, and HTTP request input stream is associated as the input stream of the task.

Parameters:

request - The HTTP servlet request object.

Throws:

java.io.IOException

invoke

public void invoke()
            throws IEException,
                   java.io.IOException

Executes the compiled tasklet.

Throws:

IEException - if an error other than an I/O error occurs.

java.io.IOException - if an I/O error occurs.

compile

public void compile()
             throws IEException,
                    java.io.IOException

Compiles the task if it needs to be compiled.

Throws:

IEException - if an error other than an I/O error occurs.

java.io.IOException - if an I/O error occurs.

executeTask

public static IeCollection executeTask(java.lang.String uri,
                                       Task task,
                                       java.lang.Boolean isCredentialsMapper)
                                throws IEException

Executes a task specified by URI. The server context group of the task is derived from a specified task. Other context groups are left empty.

Parameters:

uri - The URI of the task to execute.

task - The task from which to derive the server context group for the task.

isCredentialsMapper - Indicates whether the task to be executed is a credentials mapper task.

Returns:

The VDB produced by the task.

Throws:

IEException - if the task is not executed successfully.

executeTask

public static IeCollection executeTask(java.lang.String uri,
                                       java.lang.String processor,
                                       Task task,
                                       IeCollection vdb,
                                       Group form)
                                throws IEException

Executes a task specified by URI. The VDB collection of the task is initialized from a specified collection. The context groups of the task are derived from a specified task.

Parameters:

uri - The URI of the task to execute.

processor - The name of the remote task processor on which to execute the task, null if the task should be executed locally.

task - The task from which to derive the context groups and input and output streams for the task.

vdb - The VDB collection with which to initialize the task.

form - The FORM context group for the task.

Returns:

The VDB produced by the task.

Throws:

IEException - if the task is not executed successfully.

executeTask

public static IeCollection executeTask(java.lang.String uri,
                                       java.util.Vector processors,
                                       Task task,
                                       IeCollection vdb,
                                       Group form)
                                throws IEException

Executes a task specified by URI. The VDB collection of the task is initialized from a specified collection. The context groups of the task are derived from a specified task.

Parameters:

uri - The URI of the task to execute.

processors - A vector containing the names of the remote task processors on which the task can be executed, null if the task should be executed locally.

task - The task from which to derive the context groups and input and output streams for the task.

vdb - The VDB collection with which to initialize the task.

form - The FORM context group for the task.

Returns:

The VDB produced by the task.

Throws:

IEException - if the task is not executed successfully.

executeTaskRemotely

public static void executeTaskRemotely(java.lang.String uri,
                                       Task task,
                                       IeService service,
                                       IeMultipartInputStream is,
                                       java.io.OutputStream os,
                                       java.util.Vector processors)
                                throws IEException,
                                       java.io.IOException

Executes a task in a remote task processor. The caller supplies a task URI, a Task object providing context groups, a service object providing a VDB, and a vector of task processor names. An attempt is made to connect to each task processor, one at a time, until a connection is made successfully. Then, a request object is sent and the result is incorporated into the local VDB.

Parameters:

uri - The URI of the task to be executed.

task - The task from which to derive the context groups for the remote task.

service - The service object containing a VDB.

is - The input stream of the task.

os - The output stream of the task.

processors - The vector of task processor names.

Throws:

IEException - if an error other than an I/O error occurs during execution of the tasklet.

java.io.IOException - if an I/O error occurs.

toString

public java.lang.String toString()

Returns a string containing the output currently associated with this task. Usually, the output is generated as a result of calling the invoke method.

Overrides:

toString in class java.lang.Object

Returns:

A String containing the output associated with the task.