Package com.ibm.bpe.api

Provides the application programming interface (API) for managing process-related objects in the Process Choreographer.

See:
          Description

Interface Summary
ActivityInstanceActions This interface defines symbolic constants for all actions that can be performed on activity instances.
ActivityInstanceData Accesses the properties of an activity instance.
ActivityServiceTemplateActions This interface defines symbolic constants for all actions that can be performed on activity service templates.
ActivityServiceTemplateData Accesses the properties of an activity service.
AIID Interface for an activity instance object identifier.
ATID Interface for an activity template object identifier.
BusinessProcess BusinessProcess is the stateless session bean that represents the remote interface.
BusinessProcessHome The home interface of the BusinessProcess session bean.
BusinessProcessService BusinessProcessService defines the business functions that can be called by a local or remote client.
ClientSetting Interface that supports the definition of user specific client settings.
CompensationBehaviour This interface defines symbolic constants that state how to deal with compensation.
CustomClientSettings CustomClientSettings defines the interface for all client and Web client settings that are associated with a process template, process instance, or activity instance.
JspLocation Interface to retrieve JSP locations of a Web client setting.
LocalBusinessProcess LocalBusinessProcess is the stateless session bean that represents the local interface.
LocalBusinessProcessHome The home interface of the LocalBusinessProcess session bean.
LocalBusinessProcessService LocalBusinessProcessService defines the business functions that can be called by a local client.
OID Interface for an object identifier.
PIID Interface for a process instance object identifier.
ProcessInstanceActions This interface defines symbolic constants for all actions that can be performed on process instances.
ProcessInstanceData Accesses the properties of a process instance.
ProcessTemplateActions This interface defines symbolic constants for all actions that can be performed on process templates.
ProcessTemplateData Accesses the properties of a process template.
PTID Interface for a process template object identifier.
QueryResultSet Provides the results of a query request.
ReplyContext This interface supports an asynchronous mode of operation.
StaffResultSet Provides the results of a query request for persons.
UserInput Deprecated.  
UserInputOption Deprecated.  
UTID Interface for an URI template object identifier.
VTID Interface for a service template object identifier.
WebClientSetting Interface for Web client settings.
WIID Interface for a work item object identifier.
WorkItemData Accesses the properties of a work item.
WorkListActions This interface defines symbolic constants for all actions that can be performed on work lists.
WorkListData Accesses the properties of a worklist.
 

Class Summary
ClientObjectWrapper Wraps messages and variables passed between the caller and the process engine.
JspUsageEnum This enumeration class defines symbolic constants for JSP usage patterns.
ProcessResponseWrapper Wraps the output message returned by a microflow and its associated custom client settings.
QueryColumnInfo Provides information on the columns of a query result set.
ReplyContextWrapper Wraps the reply context passed to the process engine.
 

Exception Summary
ActivityNameNotUniqueException Exception class for error message Api.ActivityNameNotUnique.
ApplicationFaultException An ApplicationFaultException wraps fault responses from invoke, throw, or script activities.
BpelException Super class for all navigation related exceptions that can occur during the execution of BPEL processes.
CannotAccessObjectException Exception class for error message Api.CannotAccessObject.
CannotDeleteNamespaceException Exception class for error message Api.CannotDeleteNamespace.
CannotSendExceptionException Exception class for error message Api.CannotSendException.
CannotSendPIIDException Exception class for error message Api.CannotSendPIID.
CannotSendProcessResultException Exception class for error message Api.CannotSendProcessResult.
CannotSendVoidReplyException Exception class for error message Api.CannotSendVoidReply.
ConfigurationConnectionNotFoundException Exception class for error message Configuration.ConnectionNotFound.
ConfigurationDataSourceNotFoundException Exception class for error message Configuration.DataSourceNotFound.
ConfigurationGenericErrorException Exception class for error message Configuration.GenericError.
CouldNotCreateWSIFPort_ProcessException Exception class for error message Api.CouldNotCreateWSIFPort_Process.
CreateFailedException Exception class for error message Api.CreateFailed.
DatabaseException Exception class for error message Api.Database.
DataHandlingException Exception class for error message Api.DataHandling.
EngineActivityDoesNotExistException Exception class for error message Engine.ActivityDoesNotExist.
EngineActivityStoppedException Exception class for error message Engine.ActivityStopped.
EngineAdministratorCannotBeResolvedException Exception class for error message Engine.AdministratorCannotBeResolved.
EngineAssignmentFailureExceptionException Exception class for error message Engine.AssignmentFailureException.
EngineAuthorizationPluginException Exception class for error message Engine.AuthorizationPlugin.
EngineCalendarNotFoundException Exception class for error message Engine.CalendarNotFound.
EngineCannotCreateWorkItemException Exception class for error message Engine.CannotCreateWorkItem.
EngineCannotDeleteProcessException Exception class for error message Engine.CannotDeleteProcess.
EngineCannotDeserializeReplyContextException Exception class for error message Engine.CannotDeserializeReplyContext.
EngineCannotInitializePluginException Exception class for error message Engine.CannotInitializePlugin.
EngineCannotInitializeVariableException Exception class for error message Engine.CannotInitializeVariable.
EngineCannotInitializeWorkItemManagerException Exception class for error message Engine.CannotInitializeWorkItemManager.
EngineCannotOpenCompensationSphereException Exception class for error message Engine.CannotOpenCompensationSphere.
EngineCannotRunInAtomicSphereException Exception class for error message Engine.CannotRunInAtomicSphere.
EngineCannotRunInterruptibleException Exception class for error message Engine.CannotRunInterruptible.
EngineCannotRunSynchronousException Exception class for error message Engine.CannotRunSynchronous.
EngineCannotUnwrapReplyContextException Exception class for error message Engine.CannotUnwrapReplyContext.
EngineCompensationNotSupportedException Exception class for error message Engine.CompensationNotSupported.
EngineCompensationSphereNotCompletedError Exception class for error message Engine.CompensationSphereNotCompleted.
EngineCompensationSphereRequiredException Exception class for error message Engine.CompensationSphereRequired.
EngineCompensationSphereStateUnknownError Exception class for error message Engine.CompensationSphereStateUnknown.
EngineConditionEvaluationException Exception class for error message Engine.ConditionEvaluation.
EngineCustomAttributeAccessViolationException Exception class for error message Engine.CustomAttributeAccessViolation.
EngineDataMappingException Exception class for error message Engine.DataMapping.
EngineDataPluginException Exception class for error message Engine.DataPlugin.
EngineDuplicateAwaitedEventException Exception class for error message Engine.DuplicateAwaitedEvent.
EngineDurationFormatException Exception class for error message Engine.DurationFormat.
EngineErrorInDescriptionResolutionException Exception class for error message Engine.ErrorInDescriptionResolution.
EngineEventNotKnownException Exception class for error message Engine.EventNotKnown.
EngineEverybodyWorkItemException Exception class for error message Engine.EverybodyWorkItem.
EngineExitConditionEvaluationException Exception class for error message Engine.ExitConditionEvaluation.
EngineExitConditionFailedException Exception class for error message Engine.ExitConditionFailed.
EngineFaultHasBeenNavigatedException Exception class for error message Engine.FaultHasBeenNavigated.
EngineFaultTerminalMessageIsNullException Exception class for error message Engine.FaultTerminalMessageIsNull.
EngineFaultTerminalNotConnectedException Exception class for error message Engine.FaultTerminalNotConnected.
EngineGenericErrorException Exception class for error message Engine.GenericError.
EngineImplementationDoesNotExistException Exception class for error message Engine.ImplementationDoesNotExist.
EngineImplementationInvocationException Exception class for error message Engine.ImplementationInvocation.
EngineIncompatibleTypesException Exception class for error message Engine.IncompatibleTypes.
EngineIncompleteUserInputException Exception class for error message Engine.IncompleteUserInput.
EngineInvalidCompensationSphereDescriptorException Exception class for error message Engine.InvalidCompensationSphereDescriptor.
EngineInvalidDurationException Exception class for error message Engine.InvalidDuration.
EngineInvalidFaultTerminalException Exception class for error message Engine.InvalidFaultTerminal.
EngineInvalidNamespaceURIException Exception class for error message Engine.InvalidNamespaceURI.
EngineInvalidReplacementVariableException Exception class for error message Engine.InvalidReplacementVariable.
EngineJmsApiContextException Exception class for error message Engine.JmsApiContext.
EngineJoinConditionEvaluationException Exception class for error message Engine.JoinConditionEvaluation.
EngineLastAdminWorkItemException Exception class for error message Engine.LastAdminWorkItem.
EngineLinkConditionEvaluationException Exception class for error message Engine.LinkConditionEvaluation.
EngineLookupProcessBeanError Exception class for error message Engine.LookupProcessBean.
EngineLoopConditionEvaluationException Exception class for error message Engine.LoopConditionEvaluation.
EngineLoopDefaultMappingException Exception class for error message Engine.LoopDefaultMapping.
EngineLoopMappingException Exception class for error message Engine.LoopMapping.
EngineMaxNumberLoopIterationsExceededException Exception class for error message Engine.MaxNumberLoopIterationsExceeded.
EngineMaxNumberRetryExceededException Exception class for error message Engine.MaxNumberRetryExceeded.
EngineMissingReceiveException An EngineMisssingReceiveException is thrown when a message has been received and stored by Process Choreographer and when that message has not been processed before the completion of the process instance for which it was received.
EngineMissingReplyException An EngineMisssingReplyException is thrown when the process instance ends and when there is a reply missing for a receive or pick activity that implements a two-way operation.
EngineNoInitialReceiveException Exception class for error message Engine.NoInitialReceive.
EngineNotAuthorizedException Exception class for error message Engine.NotAuthorized.
EngineParameterNullException Exception class for error message Engine.ParameterNull.
EngineParentProcessContextException Exception class for error message Engine.ParentProcessContext.
EngineProcessCompensatedException Exception class for error message Engine.ProcessCompensated.
EngineProcessDoesNotExistException Exception class for error message Engine.ProcessDoesNotExist.
EngineProcessInstanceNameNotUniqueException Exception class for error message Engine.ProcessInstanceNameNotUnique.
EngineProcessModelDoesNotExistException Exception class for error message Engine.ProcessModelDoesNotExist.
EngineProcessModelStoppedException Exception class for error message Engine.ProcessModelStopped.
EngineProcessReaderWorkItemException Exception class for error message Engine.ProcessReaderWorkItem.
EngineProcessStarterDeletedException Exception class for error message Engine.ProcessStarterDeleted.
EngineRollbackOnlyError Exception class for error message Engine.RollbackOnly.
EngineSchedulerException Exception class for error message Engine.Scheduler.
EngineSchedulerNotFoundException Exception class for error message Engine.SchedulerNotFound.
EngineSelectionFailureExceptionException Exception class for error message Engine.SelectionFailureException.
EngineStateObserverEventError Exception class for error message Engine.StateObserverEvent.
EngineSubProcessHasNoMatchingEventException Exception class for error message Engine.SubProcessHasNoMatchingEvent.
EngineTimeoutExpressionEvaluationException Exception class for error message Engine.TimeoutExpressionEvaluation.
EngineTransitionConditionEvaluationException Exception class for error message Engine.TransitionConditionEvaluation.
EngineUncaughtExceptionInActivityException Exception class for error message Engine.UncaughtExceptionInActivity.
EngineUncaughtExceptionInProcessException Exception class for error message Engine.UncaughtExceptionInProcess.
EngineVariableDoesNotExistException Exception class for error message Engine.VariableDoesNotExist.
EngineWrongKindException Exception class for error message Engine.WrongKind.
EngineWrongMessageTypeException Exception class for error message Engine.WrongMessageType.
EngineWrongStateException Exception class for error message Engine.WrongState.
ExecuteInputOnlyOperation_NotSupportedException Exception class for error message Api.ExecuteInputOnlyOperation_NotSupported.
FaultReplyException A FaultReplyException states that a fault is returned.
GenericErrorException Exception class for error message Api.GenericError.
IdAndCorrelationSetMismatchException Exception class for error message Api.IdAndCorrelationSetMismatch.
IdWrongFormatException Exception class for error message Api.IdWrongFormat.
IdWrongTypeException Exception class for error message Api.IdWrongType.
ImplementationNotFoundException Exception class for error message Api.ImplementationNotFound.
InvalidLengthException Exception class for error message Api.InvalidLength.
InvalidObjectNameException Exception class for error message Api.InvalidObjectName.
InvalidParameterValueException Exception class for error message Api.InvalidParameterValue.
JmsApiEventNameMissingException Exception class for error message Api.JmsApiEventNameMissing.
JmsApiInvalidPayloadException Exception class for error message Api.JmsApiInvalidPayload.
JmsApiInvalidVerbException Exception class for error message Api.JmsApiInvalidVerb.
JmsApiProcessInstanceMissingException Exception class for error message Api.JmsApiProcessInstanceMissing.
JmsApiRequestFailedException Exception class for error message Api.JmsApiRequestFailed.
JmsApiRetryLimitExceededException Exception class for error message Api.JmsApiRetryLimitExceeded.
JMSReplyToNotQueueException Exception class for error message Api.JMSReplyToNotQueue.
MethodNotApplicableException Exception class for error message Api.MethodNotApplicable.
MissingPartsException Exception class for error message Api.MissingParts.
NoMacroFlowException Exception class for error message Api.NoMacroFlow.
NotSerializableException NotSerializableException is basically a placeholder for nested exceptions that serialization fails.
ObjectDoesNotExistException Exception class for error message Api.ObjectDoesNotExist.
PluginsGenericErrorException Exception class for error message Plugins.GenericError.
ProcessBindingMissingFormatTypeException Exception class for error message Api.ProcessBindingMissingFormatType.
ProcessBindingMissingTypeMappingException Exception class for error message Api.ProcessBindingMissingTypeMapping.
ProcessError This is the base class for all runtime exceptions.
ProcessException This is the base class for all exceptions thrown by Process Choreographer.
ProcessFaultException Represents the exception that is passed to a user or a process activity when a non-interruptible process ends with a process fault.
ProcessInputTypeNameNullException Exception class for error message Api.ProcessInputTypeNameNull.
ProcessInputTypeSystemNullException Exception class for error message Api.ProcessInputTypeSystemNull.
ProcessInputUnknownTypeSystemException Exception class for error message Api.ProcessInputUnknownTypeSystem.
ProcessInstanceNotUniqueException Exception class for error message Api.ProcessInstanceNotUnique.
ProcessOperationCannotFindModelException Exception class for error message Api.ProcessOperationCannotFindModel.
ProcessOperationCannotInvokeException Exception class for error message Api.ProcessOperationCannotInvoke.
ProcessOperationFailedException Exception class for error message Api.ProcessOperationFailed.
ProcessOperationFaultNameNotSetException Exception class for error message Api.ProcessOperationFaultNameNotSet.
ProcessOperationMissingFaultMessageException Exception class for error message Api.ProcessOperationMissingFaultMessage.
ProcessOperationNoOutputMessageException Exception class for error message Api.ProcessOperationNoOutputMessage.
ProcessOperationNotKnownByPortException Exception class for error message Api.ProcessOperationNotKnownByPort.
ProcessOperationUnknownFaultMessageTypeException Exception class for error message Api.ProcessOperationUnknownFaultMessageType.
ProcessTemplateInstallOnDemandFailedException Exception class for error message Api.ProcessTemplateInstallOnDemandFailed.
ProcessTemplateInstallOnDemandFailedFileNotFoundException Exception class for error message Api.ProcessTemplateInstallOnDemandFailedFileNotFound.
ProcessTemplateNotFoundException Exception class for error message Api.ProcessTemplateNotFound.
QueryInvalidOperandException Exception class for error message Api.QueryInvalidOperand.
QueryInvalidTimestampException Exception class for error message Api.QueryInvalidTimestamp.
QueryUndefinedParameterException Exception class for error message Api.QueryUndefinedParameter.
QueryUnknownColumnException Exception class for error message Api.QueryUnknownColumn.
QueryUnknownOperatorException Exception class for error message Api.QueryUnknownOperator.
QueryUnknownTableException Exception class for error message Api.QueryUnknownTable.
RuntimeFaultException RuntimeFaultException wraps all runtime failures that can happen during the execution of BPEL processes, for example, when executing a script activity or when evaluating a transition condition.
SendReplyErrorException Represents the exception that is thrown by ReplyContext methods if sending the reply generates an error.
ServiceNotUniqueException Exception class for error message Api.ServiceNotUnique.
SpecificFaultReplyException A SpecificFaultReplyException states that a fault is returned.
StandardFaultException Super class for all BPEL standard faults such as bpws:forceTermination.
SystemFaultException Defines an exception which is thrown when during the execution of an activity or the invocation of a plug-in (except the observer plug-in), Process Choreographer itself runs into an error situation.
TemplateInUseException Exception class for error message Api.TemplateInUse.
UnexpectedFailureException Exception class for error message Api.UnexpectedFailure.
UserInputInitException Exception class for error message Api.UserInputInit.
WorkItemManagerException A general non-recoverable exception that occured with Work Item Management functions.
 

Package com.ibm.bpe.api Description

Provides the application programming interface (API) for managing process-related objects in the Process Choreographer. You can create application programs that use the API to manage runtime information related to processes. You can:

The API contains a stateless session bean BusinessProcess for remote access and a stateless session bean LocalBusinessProcess for local access. The BusinessProcessService interface is the common interface for these session beans. 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 BusinessProcess session bean or the LocalBusinessProcess 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/BusinessProcessHome</ejb-ref-name>
     <ejb-ref-type>Session<ejb-ref-type>
     <home>com.ibm.bpe.api.BusinessProcessHome</home>
     <remote>com.ibm.bpe.api.BusinessProcess</remote>
   </ejb-ref>

Add the reference to the local interface as in the following example:

   <ejb-local-ref>
     <ejb-ref-name>ejb/LocalBusinessProcessHome</ejb-ref-name>
     <ejb-ref-type>Session<ejb-ref-type>
     <local-home>com.ibm.bpe.api.LocalBusinessProcessHome</local-home>
     <local>com.ibm.bpe.api.LocalBusinessProcess</local>
   </ejb-local-ref>

If you are using the remote interface, then the generated API stubs must be packaged with your application:

The BusinessProcess or the LocalBusinessProcess home interface is then made available to the client through JNDI by the container where the BusinessProcess or LocalBusinessProcess session bean is deployed. To access the remote interface:

   // Obtain the default initial JNDI context
   Context initialContext= new InitialContext();

   // Lookup the home interface of the BusinessProcess bean
   Object result= initialContext.lookup("java:comp/env/ejb/BusinessProcessHome");

   // Convert the lookup result to the proper type
   BusinessProcessHome processHome= (BusinessProcessHome)javax.rmi.PortableRemoteObject.narrow(result,BusinessProcessHome.class);
To access the local interface:
   // Obtain the default initial JNDI context
   Context initialContext= new InitialContext();

   // Access the home interface of the LocalBusinessProcess bean
   LocalBusinessProcessHome processHome= (LocalBusinessProcessHome)initialContext.lookup("java:comp/env/ejb/LocalBusinessProcessHome");

The BusinessProcess session bean's home interface respectively the LocalBusinessProcess session bean's home interface contains a create method for session objects. The create method returns the BusinessProcess session bean's remote interface respectively the LocalBusinessProcess session bean's local interface. For example, access the remote interface of the BusinessProcess bean:

   BusinessProcess process= processHome.create();
For example, access the local interface of the LocalBusinessProcess bean:
   LocalBusinessProcess process= processHome.create();

When the BusinessProcess- or the LocalBusinessProcess session bean is accessed, the application program can call any of the business functions exposed by the API. For example:

   process.initiate("MyProcessModel",input);

Note:
Access to the BusinessProcess or LocalBusinessProcess session bean does not guarantee that all functions can be executed; the caller must also be authorized to perform the functions. When an instance of the BusinessProcess or LocalBusinessProcess session bean is created, the container associates a session context with the instance of the session bean. The session context contains the caller's principal. This is used by both the container and the process engine to check the caller's authorization for each call.

Calls are executed 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 process engine 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();

      // Process calls ...

   // On successful return, commit the transaction
   transaction.commit();