Skip navigation links

com.collaxa.cube.engine.ext
Class BaseBPELXExecLet

java.lang.Object
com.collaxa.cube.engine.ext.BaseBPELXExecLet

public abstract class BaseBPELXExecLet

extends java.lang.Object

Constructor Summary

BaseBPELXExecLet()

Method Summary

protected abstract void	addAuditTrailEntry(java.lang.String message) Add an log entry into the audit trail.
protected abstract void	addAuditTrailEntry(java.lang.String message, java.lang.Object detail) Add an log entry into the audit trail.
protected abstract void	addAuditTrailEntry(java.lang.Throwable t) Add an exception log entry into the audit trail.
protected abstract void	checkpoint() Create a hydration point by marking the current work-item to be non-idempotent.
abstract void	execute() This method is to be implemented by the bpel programer through the exention bpelx:exec node.
protected abstract java.io.File	getContentFile(java.lang.String path) Returns a File object with the specified path.
protected abstract java.lang.String	getConversationId() Get the converstion id of the current instance.
protected abstract java.lang.String	getCreator() Get the creator of the instance.
protected abstract java.lang.Object	getFromEnvironment(java.lang.String name) Returns the object that's bound to the cube context environment.
protected abstract java.lang.String	getIndex(int i) Get value of the custom index.
protected abstract long	getInstanceId() Returns the current instance id.
protected abstract Locator	getLocator() Get the Locator.
protected abstract java.lang.String	getMetadata() Get the custom meta data of the instance.
protected abstract java.lang.String	getParentId() Get the the id of the instance that started this instance.
protected abstract java.lang.String	getPreference(java.lang.String key) Returns the preference definition of the specified property.
protected abstract int	getPriority() Get the custom priority of the instance.
protected abstract java.lang.String	getRootId() Returns root id of the instance.
protected abstract java.lang.String	getStatus() Get the current custom status of the instance.
protected abstract java.lang.String	getTitle() Get the title of this instance.
protected abstract java.lang.Object	getVariableData(java.lang.String name) Get the value of the bpel variable of the specified name.
protected abstract java.lang.Object	getVariableData(java.lang.String name, java.lang.String partOrQuery) Get partial value of specified variable using a query string.
protected abstract java.lang.Object	getVariableData(java.lang.String name, java.lang.String part, java.lang.String query) Get partial value of a BPEL variable part using a query string.
protected abstract java.lang.Object	lookup(java.lang.String name) Lookup an object that's bound to the cube execution context or the JDNI context.
protected abstract java.lang.Object	lookup(java.lang.String jndiFile, java.lang.String name) Look an object that's bound to the cube execution context or the JDNI context.
protected abstract java.lang.Object	lookupService(java.lang.String name) Look up a service.
protected abstract void	setConversationId(java.lang.String conversationId) Set the conversation id of the current instance.
protected abstract void	setCreator(java.lang.String creator) Set the creator of the instance.
protected abstract void	setIndex(int i, java.lang.String value) Set value of the custom index.
protected abstract void	setMetadata(java.lang.String metadata) Set the custom meta data of the instance.
protected abstract void	setPriority(int priority) Set the custom prority of the instance.
protected abstract void	setRootId(java.lang.String rootId) Set root id of the instance.
protected abstract java.lang.String	setTitle(java.lang.String title) Set the title of the instance.
protected abstract void	setVariableData(java.lang.String name, java.lang.Object value) Set value of a bpel variable.
protected abstract void	setVariableData(java.lang.String name, java.lang.Object value, boolean clone) Set value of a bpel variable.
protected abstract void	setVariableData(java.lang.String name, java.lang.String partOrQuery, java.lang.Object value) If the BPEL variable is a Element variable, use the query to set the partial value.
protected abstract void	setVariableData(java.lang.String name, java.lang.String partOrQuery, java.lang.Object value, boolean clone) If the BPEL variable is a Element variable, use the query to set the partial value.
protected abstract void	setVariableData(java.lang.String name, java.lang.String part, java.lang.String query, java.lang.Object value) Set partial value of a part of a bpel variable.
protected abstract void	setVariableData(java.lang.String name, java.lang.String part, java.lang.String query, java.lang.Object value, boolean clone) Set partial value of a part of a bpel variable.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseBPELXExecLet

public BaseBPELXExecLet()

Method Detail

execute

public abstract void execute()
                      throws BPELFault

This method is to be implemented by the bpel programer through the exention bpelx:exec node.

Throws:

BPELFault

lookup

protected abstract java.lang.Object lookup(java.lang.String name)
                                    throws javax.naming.NamingException

Lookup an object that's bound to the cube execution context or the JDNI context.

Parameters:

name -

Returns:

Object bound to the cube context or the JNDI context

Throws:

javax.naming.NamingException

lookup

protected abstract java.lang.Object lookup(java.lang.String jndiFile,
                                           java.lang.String name)
                                    throws javax.naming.NamingException

Look an object that's bound to the cube execution context or the JDNI context. If it's not found. Try to use the jndi property file to create an initial context using those properties and then retry.

Parameters:

jndiFile -

name -

Returns:

Throws:

javax.naming.NamingException

checkpoint

protected abstract void checkpoint()

Create a hydration point by marking the current work-item to be non-idempotent.

getFromEnvironment

protected abstract java.lang.Object getFromEnvironment(java.lang.String name)

Returns the object that's bound to the cube context environment.

Parameters:

name -

Returns:

getLocator

protected abstract Locator getLocator()

Get the Locator.

Returns:

Locator

getInstanceId

protected abstract long getInstanceId()

Returns the current instance id.

Returns:

instance id

getRootId

protected abstract java.lang.String getRootId()

Returns root id of the instance. A rood id is a string that identifies an invocation tree. This value is available in the cube_instance table.

Returns:

root id

setRootId

protected abstract void setRootId(java.lang.String rootId)

Set root id of the instance. All the BPEL instances started by this instance will have the root id that's set here. This value is avalable in the cube_instance table.

Parameters:

rootId -

getParentId

protected abstract java.lang.String getParentId()

Get the the id of the instance that started this instance. This value will be set in the cube_instance table.

Returns:

parent id

setTitle

protected abstract java.lang.String setTitle(java.lang.String title)

Set the title of the instance. This value will be set in the cube_instance table.

Parameters:

title -

Returns:

getTitle

protected abstract java.lang.String getTitle()

Get the title of this instance. This value is also available in the cube_instance table.

Returns:

title

getStatus

protected abstract java.lang.String getStatus()

Get the current custom status of the instance. This value is also available in the cube_instance table.

Returns:

getIndex

protected abstract java.lang.String getIndex(int i)
                                      throws BPELFault

Get value of the custom index. This value is available in the ci_indexes table.

Parameters:

i - The count of the column. It should not be bigger than the number of columns in the ci_indexes table.

Returns:

custom index value

Throws:

BPELFault

setIndex

protected abstract void setIndex(int i,
                                 java.lang.String value)
                          throws BPELFault

Set value of the custom index. This value is set in the ci_instance table.

Parameters:

i - The count of the colmn. It should not be bigger than the number of columns in the ci_indexes table.

value -

Throws:

BPELFault

getPriority

protected abstract int getPriority()

Get the custom priority of the instance. The value is also available in the cube_instance table.

Returns:

priority

setPriority

protected abstract void setPriority(int priority)

Set the custom prority of the instance. This value will be set in the cube_instance table.

Parameters:

priority -

getCreator

protected abstract java.lang.String getCreator()

Get the creator of the instance. This value is also available in the cube_instance table.

Returns:

creator

setCreator

protected abstract void setCreator(java.lang.String creator)

Set the creator of the instance. The value will be set in the cube_instance table.

Parameters:

creator -

getConversationId

protected abstract java.lang.String getConversationId()

Get the converstion id of the current instance. The value is also available in the cube_instance table.

Returns:

conversation id

setConversationId

protected abstract void setConversationId(java.lang.String conversationId)

Set the conversation id of the current instance. The value will be set in the cube_instance table.

Parameters:

conversation - id

getMetadata

protected abstract java.lang.String getMetadata()

Get the custom meta data of the instance. This value is also available in the cube_instance table.

Returns:

meta data

setMetadata

protected abstract void setMetadata(java.lang.String metadata)

Set the custom meta data of the instance. This value is set in the cube_instance table.

Parameters:

metadata -

getPreference

protected abstract java.lang.String getPreference(java.lang.String key)

Returns the preference definition of the specified property. The value is defined in the preferences section of the deployment descriptor.

Parameters:

key - of the property

Returns:

addAuditTrailEntry

protected abstract void addAuditTrailEntry(java.lang.String message,
                                           java.lang.Object detail)

Add an log entry into the audit trail.

Parameters:

message -

detail -

addAuditTrailEntry

protected abstract void addAuditTrailEntry(java.lang.String message)

Add an log entry into the audit trail.

Parameters:

message -

addAuditTrailEntry

protected abstract void addAuditTrailEntry(java.lang.Throwable t)

Add an exception log entry into the audit trail.

Parameters:

t -

getContentFile

protected abstract java.io.File getContentFile(java.lang.String path)
                                        throws BPELFault

Returns a File object with the specified path.

Parameters:

path - The path to the file

Returns:

Throws:

BPELFault

getVariableData

protected abstract java.lang.Object getVariableData(java.lang.String name)
                                             throws BPELFault

Get the value of the bpel variable of the specified name.

Parameters:

name -

Returns:

Throws:

BPELFault

getVariableData

protected abstract java.lang.Object getVariableData(java.lang.String name,
                                                    java.lang.String partOrQuery)
                                             throws BPELFault

Get partial value of specified variable using a query string.

Parameters:

name -

partOrQuery -

Returns:

Throws:

BPELFault

getVariableData

protected abstract java.lang.Object getVariableData(java.lang.String name,
                                                    java.lang.String part,
                                                    java.lang.String query)
                                             throws BPELFault

Get partial value of a BPEL variable part using a query string.

Parameters:

name -

part -

query -

Returns:

Throws:

BPELFault

setVariableData

protected abstract void setVariableData(java.lang.String name,
                                        java.lang.Object value)
                                 throws BPELFault

Set value of a bpel variable.

This method will clone the Object value parameter.

Parameters:

name -

value -

Throws:

BPELFault

setVariableData

protected abstract void setVariableData(java.lang.String name,
                                        java.lang.Object value,
                                        boolean clone)
                                 throws BPELFault

Set value of a bpel variable.

The clone boolean parameter determines whether the Object value parameter will be cloned.

Parameters:

name -

value -

clone -

Throws:

BPELFault

setVariableData

protected abstract void setVariableData(java.lang.String name,
                                        java.lang.String partOrQuery,
                                        java.lang.Object value)
                                 throws BPELFault

If the BPEL variable is a Element variable, use the query to set the partial value. If the BPEL variable is a MesssageType variable, set value to the given part.

This method will clone the Object value parameter.

Parameters:

name -

partOrQuery - The part name or the query, depending on the type of the BPEL variabel

value -

Throws:

BPELFault

setVariableData

protected abstract void setVariableData(java.lang.String name,
                                        java.lang.String partOrQuery,
                                        java.lang.Object value,
                                        boolean clone)
                                 throws BPELFault

If the BPEL variable is a Element variable, use the query to set the partial value. If the BPEL variable is a MesssageType variable, set value to the given part.

The clone boolean parameter determines whether the Object value parameter will be cloned.

Parameters:

name -

partOrQuery - The part name or the query, depending on the type of the BPEL variabel

value -

clone -

Throws:

BPELFault

setVariableData

protected abstract void setVariableData(java.lang.String name,
                                        java.lang.String part,
                                        java.lang.String query,
                                        java.lang.Object value)
                                 throws BPELFault

Set partial value of a part of a bpel variable.

This method will clone the Object value parameter.

Parameters:

name -

part -

query -

value -

Throws:

BPELFault

setVariableData

protected abstract void setVariableData(java.lang.String name,
                                        java.lang.String part,
                                        java.lang.String query,
                                        java.lang.Object value,
                                        boolean clone)
                                 throws BPELFault

Set partial value of a part of a bpel variable.

The clone boolean parameter determines whether the Object value parameter will be cloned.

Parameters:

name -

part -

query -

value -

clone -

Throws:

BPELFault

lookupService

protected abstract java.lang.Object lookupService(java.lang.String name)

Look up a service. For example, the work list service.

Parameters:

name -

Returns:

Skip navigation links