| IBM WebSphere Application ServerTM
Release 6 |
|||||||
PREV NEXT | FRAMES NO FRAMES |
Interface Summary | |
TaskActionIndex | This interface defines symbolic constants to be used as column index when accessing the array of available action flags - see . |
LocalHumanTaskManager | Local EJB interface for Enterprise Bean: HumanTaskManager |
LocalHumanTaskManagerHome | The home interface of the LocalHumanTaskManager session bean. |
HumanTaskManagerHome | The home interface of the HumanTaskManager session bean. |
HumanTaskManagerDelegate | HumanTaskManagerDelegate wraps the functions of the Human Task Manager API and hides the details of setting up the communication. |
ExecutableQuery | Interface for customizable queries. |
LocalHumanTaskManagerService | LocalHumanTaskManager defines the human task methods that can be called by a local client. |
ReplyHandler | This interface supports an asynchronous mode of operation. |
Escalation | Accesses the properties of an escalation instance. |
TaskModel | Wraps task instances and templates that are created spontaneously. |
HumanTaskManagerService | HumanTaskManagerService defines the human task methods that can be called by a local or remote client. |
HumanTaskManager | Remote EJB interface for Enterprise Bean: HumanTaskManager |
EscalationTemplate | Accesses the properties of an escalation template. |
TaskActions | This interface defines symbolic constants for all actions that can be performed on task instances. |
TaskTemplate | Accesses the properties of a task template. |
QueryResultSet | Provides the results of a query request. |
Task | Accesses the properties of a task instance. |
ApplicationComponent | Accesses the properties of an application component. |
QueryColumnType | This interface defines symbolic constants for all column types of a query result set. |
StoredQuery | Accesses the properties of a query stored persistently. |
CustomProperty | Describes a named custom property. |
WorkItem | Accesses the properties of a work item. |
ValidationProblem | Describes validation problems of task instances or templates that have been created spontaneously (ad hoc). |
StaffResultSet | Returns the persons or groups that are members of a specific role. |
PortalClientSetting | Interface for Portal client settings. |
JspLocation | Interface to retrieve JSP locations of a Web client setting. |
WebClientSetting | Interface for Web client settings. |
CustomClientSettings | Interface for all client and Web client settings. |
ClientSetting | Interface that supports the definition of user specific client settings. |
TKTID | Interface for a task template object identifier. |
TKIID | Interface for a task instance object identifier. |
ESTID | Interface for an escalation template object identifier. |
ESIID | Interface for an escalation instance object identifier. |
ACOID | Interface for an application component object identifier. |
Class Summary | |
ClientTaskFactory | Factory to create a ClientTaskFactory object. |
HumanTaskManagerDelegateFactory | Factory to create a HumanTaskManagerDelegate object. |
StoredQueryProperty | Describes a property of a stored query. |
BinaryCustomProperty | Describes a custom property that has a binary value. |
ReplyHandlerWrapper | Wraps the reply handler passed to the Human Task Manager. |
ClientObjectWrapper | Wraps messages passed between the caller and the Human Task Manager. |
ErrorTypeEnum | This enumeration class defines symbolic constants for error types that are found during validation of objects created on-the-flight. |
JspUsageEnum | This enumeration class defines symbolic constants for JSP usage patterns. |
JspApplicableRoleEnum | This enumeration class defines symbolic constants for JSP applicable role patterns. |
Exception Summary | |
TaskBusinessException | A TaskBusinessException wraps fault responses from tasks. |
FaultReplyException | A FaultReplyException states that a modelled fault is returned. |
WorkItemManagerException | A general non-recoverable exception that occured with Work Item Management functions. |
QueryUndefinedParameterException | Exception class for error message Api.QueryUndefinedParameter. |
ServiceNotUniqueException | Exception class for error message Api.ServiceNotUnique. |
EscalationNotAuthorizedException | Exception class for error message Api.EscalationNotAuthorized. |
IsNotInlineException | Exception class for error message Api.IsNotInline. |
InvalidParameterException | Exception class for error message Api.InvalidParameter. |
StaffServiceRuntimeException | Exception class for error message Api.StaffServiceRuntime. |
StateObserverError | Exception class for error message Api.StateObserver. |
SenderAddressInvalidException | Exception class for error message Api.SenderAddressInvalid. |
GenericTaskException | Exception class for error message Api.GenericTask. |
OutputMessageDefinitionDoesNotMatchException | Exception class for error message Api.OutputMessageDefinitionDoesNotMatch. |
WrongTaskTemplateStateException | Exception class for error message Api.WrongTaskTemplateState. |
TaskModelNotAuthorizedException | Exception class for error message Api.TaskModelNotAuthorized. |
WorkItemDoesNotExistException | Exception class for error message Api.WorkItemDoesNotExist. |
TaskTemplateDoesNotExistException | Exception class for error message Api.TaskTemplateDoesNotExist. |
ConflictingTypesException | Exception class for error message Api.ConflictingTypes. |
IsNotTopLevelTaskException | Exception class for error message Api.IsNotTopLevelTask. |
ApplicationVetoException | Exception class for error message Api.ApplicationVeto. |
CannotCreateWorkItemException | Exception class for error message Api.CannotCreateWorkItem. |
InvalidApplicationStateException | Exception class for error message Api.InvalidApplicationState. |
PropertyVetoException | Exception class for error message Api.PropertyVeto. |
RunningInstancesException | Exception class for error message Api.RunningInstances. |
WrongTaskTemplateKindException | Exception class for error message Api.WrongTaskTemplateKind. |
FollowOnTasksNotSupportedException | Exception class for error message Api.FollowOnTasksNotSupported. |
QueryUnknownTableException | Exception class for error message Api.QueryUnknownTable. |
WrongTaskKindException | Exception class for error message Api.WrongTaskKind. |
KeepOutputForCancelClaimNotSupportedException | Exception class for error message Api.KeepOutputForCancelClaimNotSupported. |
CoreOTaskServiceResultHasInvalidOutputMessageTypeException | Exception class for error message Core.OTaskServiceResultHasInvalidOutputMessageType. |
URLInvalidException | Exception class for error message Api.URLInvalid. |
SCAServiceAccessFailureException | Exception class for error message Api.SCAServiceAccessFailure. |
TaskIsWaitingForSubTaskException | Exception class for error message Api.TaskIsWaitingForSubTask. |
QueryInvalidOperandException | Exception class for error message Api.QueryInvalidOperand. |
IsAdHocException | Exception class for error message Api.IsAdHoc. |
IsInlineException | Exception class for error message Api.IsInline. |
QueryUnknownColumnException | Exception class for error message Api.QueryUnknownColumn. |
QueryUnknownOperatorException | Exception class for error message Api.QueryUnknownOperator. |
WrongKindException | Exception class for error message Api.WrongKind. |
IsNotAdHocException | Exception class for error message Api.IsNotAdHoc. |
QueryInvalidTimestampException | Exception class for error message Api.QueryInvalidTimestamp. |
MethodNotApplicableException | Exception class for error message Api.MethodNotApplicable. |
TaskTerminatedException | Exception class for error message Api.TaskTerminated. |
TaskExpiredException | Exception class for error message Api.TaskExpired. |
AdminActionException | Exception class for error message Api.AdminAction. |
TaskTemplateNotAuthorizedException | Exception class for error message Api.TaskTemplateNotAuthorized. |
UserDoesNotExistException | Exception class for error message Api.UserDoesNotExist. |
LastAdminWorkItemException | Exception class for error message Api.LastAdminWorkItem. |
TaskInstanceActiveException | Exception class for error message Api.TaskInstanceActive. |
CoreOTaskServiceInvalidResultException | Exception class for error message Core.OTaskServiceInvalidResult. |
InvalidAssignmentReasonException | Exception class for error message Api.InvalidAssignmentReason. |
EscalationTemplateNotAuthorizedException | Exception class for error message Api.EscalationTemplateNotAuthorized. |
SubTasksNotSupportedException | Exception class for error message Api.SubTasksNotSupported. |
CommunicationException | Exception class for error message Api.Communication. |
AdministeredObjectDoesNotExistException | Exception class for error message Api.AdministeredObjectDoesNotExist. |
IdWrongFormatException | Exception class for error message Api.IdWrongFormat. |
UserRegistryException | Exception class for error message Api.UserRegistry. |
StoredQueryNameNotUniqueException | Exception class for error message Api.StoredQueryNameNotUnique. |
InheritedAccessRightException | Exception class for error message Api.InheritedAccessRight. |
AdministratorCannotBeResolvedException | Exception class for error message Api.AdministratorCannotBeResolved. |
WrongEscalationStateException | Exception class for error message Api.WrongEscalationState. |
UnexpectedFailureException | Exception class for error message Api.UnexpectedFailure. |
WrongMessageTypeException | Exception class for error message Api.WrongMessageType. |
CoreOTaskServiceResultHasInvalidFaultMessageTypeException | Exception class for error message Core.OTaskServiceResultHasInvalidFaultMessageType. |
ParentTaskIsSuspendedException | Exception class for error message Api.ParentTaskIsSuspended. |
DataHandlingException | Exception class for error message Api.DataHandling. |
EscalationTemplateDoesNotExistException | Exception class for error message Api.EscalationTemplateDoesNotExist. |
UnknownAdminOperationException | Exception class for error message Api.UnknownAdminOperation. |
ApplicationComponentDoesNotExistException | Exception class for error message Api.ApplicationComponentDoesNotExist. |
EverybodyWorkItemException | Exception class for error message Api.EverybodyWorkItem. |
TaskDelegationNotSupportedException | Exception class for error message Api.TaskDelegationNotSupported. |
ChildTaskInstanceActiveException | Exception class for error message Api.ChildTaskInstanceActive. |
CoreOTaskServiceResultHasInvalidFaultMessageQNameException | Exception class for error message Core.OTaskServiceResultHasInvalidFaultMessageQName. |
TaskDoesNotExistException | Exception class for error message Api.TaskDoesNotExist. |
ConfigurationConnectionNotFoundException | Exception class for error message Configuration.ConnectionNotFound. |
IdWrongTypeException | Exception class for error message Api.IdWrongType. |
VMMEntityAttributeNotAvailableException | Exception class for error message Api.VMMEntityAttributeNotAvailable. |
RefreshTimeoutInvalidException | Exception class for error message Api.RefreshTimeoutInvalid. |
InvalidStoredQueryParametersException | Exception class for error message Api.InvalidStoredQueryParameters. |
TaskIsEscalatedException | Exception class for error message Api.TaskIsEscalated. |
SCAServiceResultErrorException | Exception class for error message Api.SCAServiceResultError. |
CoreOTaskServiceRuntimeExceptionReceivedException | Exception class for error message Core.OTaskServiceRuntimeExceptionReceived. |
CannotAccessVMMServiceException | Exception class for error message Api.CannotAccessVMMService. |
InvalidProtocolException | Exception class for error message Api.InvalidProtocol. |
InvalidLengthException | Exception class for error message Api.InvalidLength. |
ParameterNullException | Exception class for error message Api.ParameterNull. |
NotAuthorizedException | Exception class for error message Api.NotAuthorized. |
TaskNotAuthorizedException | Exception class for error message Api.TaskNotAuthorized. |
ObjectDoesNotExistException | Exception class for error message Api.ObjectDoesNotExist. |
EscalationDoesNotExistException | Exception class for error message Api.EscalationDoesNotExist. |
TaskTemplateNotStoppedException | Exception class for error message Api.TaskTemplateNotStopped. |
InvalidQNameException | Exception class for error message Api.InvalidQName. |
WrongStateException | Exception class for error message Api.WrongState. |
WrongTaskStateException | Exception class for error message Api.WrongTaskState. |
TaskIsSuspendedException | Exception class for error message Api.TaskIsSuspended. |
MessageDefinitionDoesNotMatchException | Exception class for error message Api.MessageDefinitionDoesNotMatch. |
FaultMessageDefinitionDoesNotMatchException | Exception class for error message Api.FaultMessageDefinitionDoesNotMatch. |
TimeIntervalInvalidException | Exception class for error message Api.TimeIntervalInvalid. |
TaskError | This class is the base class for all Human Task Manager runtime exceptions. |
TaskException | This is the base class for all exceptions thrown by the Human Task Manager. |
SystemFaultException | Defines an exception which is thrown when during the execution of a task the Human Task Manager itself runs into an error situation. |
Provides the application programming interface (API) for managing task-related objects in the ProcessChoreographer Human Task Manager. You can create application programs that use the API to manage information related to tasks. You can:
The API contains a stateless session bean HumanTaskManager for local and remote access. The HumanTaskManagerService interface describes the functions that can be called locally and remotely. It exposes the functions that can be called by an application program. The application program can be any Java program, including another EJB.
The application program accesses the HumanTaskManager session bean through the bean's home and remote or local interfaces. A reference must be added to your application deployment descriptor. For example, for client applications such as a J2EE client application add the reference to the application-client.xml, for a Web application to the web.xml, and for an EJB application to the ejb-jar.xml.
Add the reference to the remote interface as in the following example:
<ejb-ref> <ejb-ref-name>ejb/HumanTaskManagerHome</ejb-ref-name> <ejb-ref-type>Session</ejb-ref-type> <home>com.ibm.task.api.HumanTaskManagerHome</home> <remote>com.ibm.task.api.HumanTaskManager</remote> </ejb-ref>
Add the reference to the local interface as in the following example:
<ejb-local-ref> <ejb-ref-name>ejb/LocalHumanTaskManagerHome</ejb-ref-name> <ejb-ref-type>Session</ejb-ref-type> <local-home>com.ibm.task.api.LocalHumanTaskManagerHome</local-home> <local>com.ibm.task.api.LocalHumanTaskManager</local> </ejb-local-ref>
If you use WebSphere Integration Developer to add the EJB reference to the deployment descriptor, the binding for the EJB reference is automatically created when the application is deployed.
If your application runs on a different Java Virtual Machine (JVM) from the one where the TaskContainer application runs, complete the following actions:
The HumanTaskManager bean's local or remote home interface is then made available to the client through JNDI by the container where the HumanTaskManager session bean is deployed. To access the remote interface:
// Obtain the default initial JNDI context Context initialContext= new InitialContext(); // Lookup the remote home interface of the HumanTaskManager bean Object result= initialContext.lookup("java:comp/env/ejb/HumanTaskManagerHome"); // Convert the lookup result to the proper type HumanTaskManagerHome home= (HumanTaskManagerHome)javax.rmi.PortableRemoteObject.narrow(result,HumanTaskManagerHome.class);To access the local interface:
// Obtain the default initial JNDI context Context initialContext= new InitialContext(); // Lookup the local home interface of the HumanTaskManager bean LocalHumanTaskManagerHome home= (LocalHumanTaskManagerHome)initialContext.lookup("java:comp/env/ejb/LocalHumanTaskManagerHome");
The home interface contains a create method that returns the HumanTaskManager session bean's remote or local interface. For example, access the remote interface of the session bean:
HumanTaskManager manager= home.create();For example, access the local interface of the session bean:
LocalHumanTaskManager manager= home.create();
When the HumanTaskManager session bean is accessed, the application program can call any of the business functions exposed by the API. For example:
manager.claim(tkiid);
When an instance of the HumanTaskManager session bean is created, the container associates a context with the instance of the session bean. The context contains the caller's principal ID, a group membership list, and indicates whether the caller has one of the Human Task Manager J2EE roles, that is, whether the caller belongs to the group of Human Task Manager system administrators or monitors. The context is used by both the container and the Human Task Manager to check the caller's authorization for each call even when global security is not set. If global security is not set, the caller's principal ID has the value 'UNAUTHENTICATED'.
Calls from applications are run as transactions. A transaction is either established and ended explicitly by the application program, or established by the container when the application progam calls the task manager and ended by the container when the application program receives the result (the deployment descriptor specifies TX_REQUIRED). For example, the application program can establish and end a transaction as follows:
// Obtain user transaction interface UserTransaction transaction= (UserTransaction)intialContext.lookup("jta/usertransaction"); // Begin a transaction transaction.begin(); // Human Task Manager calls ... // On successful return, commit the transaction transaction.commit();Design your own transactions to prevent database deadlocks when multiple transaction instances are running concurrently. For example, avoid running statements similar to the following in parallel:
UserTransaction transaction= (UserTransaction)intialContext.lookup("jta/usertransaction"); transaction.begin(); manager.getTask(tkiid); // read-locks the task manager.claim(tkiid); // write-locks the task to update the state transaction.commit();
| IBM WebSphere Application ServerTM
Release 6 |
|||||||
PREV NEXT | FRAMES NO FRAMES |