| Package | Description |
|---|---|
| org.cristalise.kernel.common | |
| org.cristalise.kernel.entity |
The implementations of Items, and their core functionality.
|
| org.cristalise.kernel.entity.agent |
The implementation of Agents, and their Jobs.
|
| org.cristalise.kernel.entity.imports | |
| org.cristalise.kernel.entity.proxy |
The Proxy API is a major part of the client-side functionality of the
CRISTAL API, which provides client-side proxy objects that represent the
Items and Agents on the server.
|
| org.cristalise.kernel.lifecycle.instance | |
| org.cristalise.kernel.lifecycle.instance.predefined | |
| org.cristalise.kernel.lifecycle.instance.predefined.agent | |
| org.cristalise.kernel.lifecycle.instance.predefined.item | |
| org.cristalise.kernel.lifecycle.routingHelpers | |
| org.cristalise.kernel.persistency | |
| org.cristalise.kernel.persistency.outcome | |
| org.cristalise.kernel.process | |
| org.cristalise.kernel.process.module | |
| org.cristalise.kernel.utils | |
| org.cristalise.storage |
| Modifier and Type | Field and Description |
|---|---|
PersistencyException |
PersistencyExceptionHolder.value |
| Modifier and Type | Method and Description |
|---|---|
static PersistencyException |
PersistencyExceptionHelper.extract(Any a) |
static PersistencyException |
PersistencyExceptionHelper.read(InputStream istream) |
| Modifier and Type | Method and Description |
|---|---|
static void |
PersistencyExceptionHelper.insert(Any a,
PersistencyException that) |
static void |
PersistencyExceptionHelper.write(OutputStream ostream,
PersistencyException value) |
| Constructor and Description |
|---|
PersistencyExceptionHolder(PersistencyException initialValue) |
| Modifier and Type | Method and Description |
|---|---|
String |
_ItemStub.delegatedAction(SystemKey agentKey,
SystemKey delegateAgentKey,
String stepPath,
int transitionID,
String requestData) |
String |
_AgentStub.delegatedAction(SystemKey agentKey,
SystemKey delegateAgentKey,
String stepPath,
int transitionID,
String requestData) |
String |
ItemPOATie.delegatedAction(SystemKey agentKey,
SystemKey delegateAgentKey,
String stepPath,
int transitionID,
String requestData) |
String |
AgentPOATie.delegatedAction(SystemKey agentKey,
SystemKey delegateAgentKey,
String stepPath,
int transitionID,
String requestData) |
String |
ItemImplementation.delegatedAction(SystemKey agentId,
SystemKey delegateId,
String stepPath,
int transitionID,
String requestData) |
String |
TraceableEntity.delegatedAction(SystemKey agentId,
SystemKey delegateAgentId,
String stepPath,
int transitionID,
String requestData) |
String |
ItemOperations.delegatedAction(SystemKey agentKey,
SystemKey delegateAgentKey,
String stepPath,
int transitionID,
String requestData) |
void |
_ItemStub.initialise(SystemKey agentKey,
String itemProps,
String workflow,
String collections)
Initialises a new Item.
|
void |
_AgentStub.initialise(SystemKey agentKey,
String itemProps,
String workflow,
String collections)
Initialises a new Item.
|
void |
ItemPOATie.initialise(SystemKey agentKey,
String itemProps,
String workflow,
String collections)
Initialises a new Item.
|
void |
AgentPOATie.initialise(SystemKey agentKey,
String itemProps,
String workflow,
String collections)
Initialises a new Item.
|
void |
ItemImplementation.initialise(SystemKey agentId,
String propString,
String initWfString,
String initCollsString) |
void |
TraceableEntity.initialise(SystemKey agentId,
String propString,
String initWfString,
String initCollsString) |
void |
ItemOperations.initialise(SystemKey agentKey,
String itemProps,
String workflow,
String collections)
Initialises a new Item.
|
String |
_ItemStub.queryData(String path)
Returns a chunk of XML which may be a serialized C2KLocalObject, or in the case of Outcomes is merely a fragment of XML.
|
String |
_AgentStub.queryData(String path)
Returns a chunk of XML which may be a serialized C2KLocalObject, or in the case of Outcomes is merely a fragment of XML.
|
String |
ItemPOATie.queryData(String path)
Returns a chunk of XML which may be a serialized C2KLocalObject, or in the case of Outcomes is merely a fragment of XML.
|
String |
AgentPOATie.queryData(String path)
Returns a chunk of XML which may be a serialized C2KLocalObject, or in the case of Outcomes is merely a fragment of XML.
|
String |
ItemImplementation.queryData(String path) |
String |
TraceableEntity.queryData(String path) |
String |
ItemOperations.queryData(String path)
Returns a chunk of XML which may be a serialized C2KLocalObject, or in the case of Outcomes is merely a fragment of XML.
|
String |
_ItemStub.queryLifeCycle(SystemKey agentKey,
boolean filter)
Returns a set of Jobs for this Agent on this Item.
|
String |
_AgentStub.queryLifeCycle(SystemKey agentKey,
boolean filter)
Returns a set of Jobs for this Agent on this Item.
|
String |
ItemPOATie.queryLifeCycle(SystemKey agentKey,
boolean filter)
Returns a set of Jobs for this Agent on this Item.
|
String |
AgentPOATie.queryLifeCycle(SystemKey agentKey,
boolean filter)
Returns a set of Jobs for this Agent on this Item.
|
String |
ItemImplementation.queryLifeCycle(SystemKey agentId,
boolean filter) |
String |
TraceableEntity.queryLifeCycle(SystemKey agentId,
boolean filter) |
String |
ItemOperations.queryLifeCycle(SystemKey agentKey,
boolean filter)
Returns a set of Jobs for this Agent on this Item.
|
String |
_ItemStub.requestAction(SystemKey agentKey,
String stepPath,
int transitionID,
String requestData)
Requests a transition of an Activity in this Item's workflow.
|
String |
_AgentStub.requestAction(SystemKey agentKey,
String stepPath,
int transitionID,
String requestData)
Requests a transition of an Activity in this Item's workflow.
|
String |
ItemPOATie.requestAction(SystemKey agentKey,
String stepPath,
int transitionID,
String requestData)
Requests a transition of an Activity in this Item's workflow.
|
String |
AgentPOATie.requestAction(SystemKey agentKey,
String stepPath,
int transitionID,
String requestData)
Requests a transition of an Activity in this Item's workflow.
|
String |
ItemImplementation.requestAction(SystemKey agentId,
String stepPath,
int transitionID,
String requestData) |
String |
TraceableEntity.requestAction(SystemKey agentId,
String stepPath,
int transitionID,
String requestData) |
String |
ItemOperations.requestAction(SystemKey agentKey,
String stepPath,
int transitionID,
String requestData)
Requests a transition of an Activity in this Item's workflow.
|
| Modifier and Type | Method and Description |
|---|---|
String |
ActiveEntity.delegatedAction(SystemKey agentId,
SystemKey delegateAgentId,
String stepPath,
int transitionID,
String requestData) |
void |
ActiveEntity.initialise(SystemKey agentId,
String propString,
String initWfString,
String initCollsString) |
String |
ActiveEntity.queryData(String path) |
String |
ActiveEntity.queryLifeCycle(SystemKey agentId,
boolean filter) |
String |
ActiveEntity.requestAction(SystemKey agentID,
String stepPath,
int transitionID,
String requestData) |
| Modifier and Type | Method and Description |
|---|---|
Path |
ImportItem.create(AgentPath agentPath,
boolean reset) |
| Modifier and Type | Method and Description |
|---|---|
String |
AgentProxy.execute(ItemProxy item,
String predefStep,
C2KLocalObject obj) |
String |
AgentProxy.execute(ItemProxy item,
String predefStep,
String param)
Single parameter execution.
|
String |
AgentProxy.execute(ItemProxy item,
String predefStep,
String[] params)
Multi-parameter execution.
|
String |
AgentProxy.execute(Job job)
Standard execution of jobs.
|
String |
ItemProxy.executeQuery(Query query)
Executes the Query in the target database.
|
Job |
ItemProxy.getJobByName(String actName,
AgentProxy agent)
Finds the first finishing job with the given name for the given Agent in the workflow.
|
Job |
ItemProxy.getJobByTransitionName(String actName,
String transName,
AgentPath agentPath)
Finds the Job with the given Activity and Transition name for the Agent in the Items Workflow
|
Job |
ItemProxy.getJobByTransitionName(String actName,
String transName,
AgentProxy agent)
Finds the Job with the given Activity and Transition name for the Agent in the Items Workflow
|
ArrayList<Job> |
ItemProxy.getJobList(AgentProxy agent) |
void |
ItemProxy.initialise(AgentPath agentId,
PropertyArrayList itemProps,
CompositeActivity workflow,
CollectionArrayList colls) |
String |
ItemProxy.requestAction(Job thisJob) |
void |
ItemProxy.setProperty(AgentProxy agent,
String name,
String value) |
| Modifier and Type | Method and Description |
|---|---|
Object |
WfVertex.evaluateProperty(ItemPath itemPath,
String propName,
Object locker) |
Object |
WfVertex.evaluatePropertyValue(ItemPath itemPath,
Object propValue,
Object locker) |
String |
Activity.request(AgentPath agent,
AgentPath delegate,
ItemPath itemPath,
int transitionID,
String requestData,
Object locker) |
String |
CompositeActivity.request(AgentPath agent,
AgentPath delegator,
ItemPath itemPath,
int transitionID,
String requestData,
Object locker) |
String |
Workflow.requestAction(AgentPath agent,
AgentPath delegator,
String stepPath,
ItemPath itemPath,
int transitionID,
String requestData) |
protected String |
Activity.runActivityLogic(AgentPath agent,
ItemPath itemPath,
int transitionID,
String requestData,
Object locker)
Overridden in predefined steps
|
| Modifier and Type | Method and Description |
|---|---|
protected String |
AssignItemToSlot.runActivityLogic(AgentPath agent,
ItemPath item,
int transitionID,
String requestData,
Object locker)
Params:
0 - collection name
1 - slot number
2 - target entity key
|
protected String |
ReplaceDomainWorkflow.runActivityLogic(AgentPath agent,
ItemPath item,
int transitionID,
String requestData,
Object locker) |
protected String |
WriteViewpoint.runActivityLogic(AgentPath agent,
ItemPath item,
int transitionID,
String requestData,
Object locker)
SchemaName, name and event Id.
|
protected String |
AddC2KObject.runActivityLogic(AgentPath agent,
ItemPath item,
int transitionID,
String requestData,
Object locker) |
protected String |
AddMemberToCollection.runActivityLogic(AgentPath agent,
ItemPath item,
int transitionID,
String requestData,
Object locker)
Generates a new slot in a Dependency for the given item
Params:
0 - collection name
1 - target entity key
2 - slot properties
|
protected String |
RemoveC2KObject.runActivityLogic(AgentPath agent,
ItemPath item,
int transitionID,
String requestData,
Object locker) |
protected String |
CreateNewCollectionVersion.runActivityLogic(AgentPath agent,
ItemPath item,
int transitionID,
String requestData,
Object locker)
Generates a new snapshot of a collection from its current state.
|
protected String |
RemoveSlotFromCollection.runActivityLogic(AgentPath agent,
ItemPath item,
int transitionID,
String requestData,
Object locker)
Params:
0 - collection name
1 - slot number OR if -1:
2 - target entity key
|
protected String |
AddNewSlot.runActivityLogic(AgentPath agent,
ItemPath item,
int transitionID,
String requestData,
Object locker)
Creates a new slot in the given aggregation, that holds instances of the given item description
Params:
Collection name
Item Description key (optional)
Item Description version (optional)
|
protected String |
WriteProperty.runActivityLogic(AgentPath agent,
ItemPath item,
int transitionID,
String requestData,
Object locker) |
protected String |
ClearSlot.runActivityLogic(AgentPath agent,
ItemPath item,
int transitionID,
String requestData,
Object locker)
Params:
0 - collection name
1 - slot number
|
protected String |
Import.runActivityLogic(AgentPath agent,
ItemPath item,
int transitionID,
String requestData,
Object locker)
Params: Schemaname_version:Viewpoint (optional), Outcome, Timestamp (optional)
|
protected String |
AddNewCollectionDescription.runActivityLogic(AgentPath agent,
ItemPath item,
int transitionID,
String requestData,
Object locker)
Params: 0 - collection name 1 - collection type (Aggregation, Dependency)
|
protected String |
CreateAgentFromDescription.runActivityLogic(AgentPath agentPath,
ItemPath itemPath,
int transitionID,
String requestData,
Object locker)
Params:
New Agent name
Description version to use
Comma-delimited Role names to assign to the agent.
|
protected abstract String |
PredefinedStep.runActivityLogic(AgentPath agent,
ItemPath itemPath,
int transitionID,
String requestData,
Object locker)
All predefined steps must override this to implement their action
|
static void |
WriteViewpoint.write(ItemPath item,
String schemaName,
String viewName,
int eventId,
Object locker) |
static void |
WriteProperty.write(ItemPath item,
String name,
String value,
Object locker) |
| Modifier and Type | Method and Description |
|---|---|
protected String |
RemoveAgent.runActivityLogic(AgentPath agent,
ItemPath itemPath,
int transitionID,
String requestData,
Object locker) |
| Modifier and Type | Method and Description |
|---|---|
protected CollectionArrayList |
CreateItemFromDescription.instantiateCollections(ItemPath itemPath,
String descVer,
PropertyArrayList newProps,
Object locker)
Copies the CollectionDescriptions of the Item requesting this predefined step.
|
protected CompositeActivity |
CreateItemFromDescription.instantiateWorkflow(ItemPath itemPath,
String descVer,
Object locker)
Retrieve the Workflow dependency for the given description version, instantiate the loaded CompositeActivityDef
|
protected String |
Erase.runActivityLogic(AgentPath agent,
ItemPath item,
int transitionID,
String requestData,
Object locker) |
protected String |
CreateItemFromDescription.runActivityLogic(AgentPath agent,
ItemPath itemPath,
int transitionID,
String requestData,
Object locker)
requestdata is xmlstring
|
| Modifier and Type | Method and Description |
|---|---|
static Object |
DataHelperUtility.evaluateValue(ItemPath itemPath,
Object value,
String actContext,
Object locker)
If the
|
String |
PropertyDataHelper.get(ItemPath itemPath,
String actContext,
String dataPath,
Object locker)
Syntax of search: PropertyName
|
String |
ViewpointDataHelper.get(ItemPath itemPath,
String actContext,
String dataPath,
Object locker)
dataPath syntax is used for search : viewpoint:/xpath/to/field
|
String |
DataHelper.get(ItemPath itemPath,
String actContext,
String dataPath,
Object locker)
Data helpers are a mechanism that allows easy referencing of different types of data
within an Item, in order to use that data for process control or generating new data.
|
String |
ActivityDataHelper.get(ItemPath itemPath,
String actContext,
String dataPath,
Object locker)
Retrieves the Workflow of the given Item, searches the Activity using the activity path and
retrieves a single value based on XPath
|
| Modifier and Type | Method and Description |
|---|---|
abstract void |
ClusterStorage.close()
Shuts down the storage.
|
abstract void |
TransactionalClusterStorage.commit(Object locker) |
void |
ClusterStorageManager.commit(Object locker) |
abstract void |
ClusterStorage.delete(ItemPath itemPath,
String path)
Remove a CRISTAL local object from storage.
|
abstract void |
TransactionalClusterStorage.delete(ItemPath itemPath,
String path,
Object locker) |
abstract String |
ClusterStorage.executeQuery(Query query)
Executes an SQL/OQL/XQuery/XPath/etc query in the target database.
|
String |
ClusterStorageManager.executeQuery(Query query)
Executes the Query
|
String |
TransactionManager.executeQuery(Query query) |
abstract C2KLocalObject |
ClusterStorage.get(ItemPath itemPath,
String path)
Fetches a CRISTAL local object from storage by path
|
C2KLocalObject |
ClusterStorageManager.get(ItemPath itemPath,
String path)
Internal get method.
|
C2KLocalObject |
TransactionManager.get(ItemPath itemPath,
String path,
Object locker)
Public get method.
|
abstract String[] |
ClusterStorage.getClusterContents(ItemPath itemPath,
String path)
Queries the local path below the given root and returns the possible next
elements.
|
String[] |
ClusterStorageManager.getClusterContents(ItemPath itemPath,
String path)
Retrieves the ids of the next level of a cluster
Does not look in any currently open transactions.
|
String[] |
TransactionManager.getClusterContents(ItemPath itemPath,
String path) |
ArrayList<ClusterStorage> |
ClusterStorageManager.instantiateStores(String allClusters) |
abstract void |
ClusterStorage.open(Authenticator auth)
Connects to the storage.
|
abstract void |
ClusterStorage.put(ItemPath itemPath,
C2KLocalObject obj)
Stores a CRISTAL local object.
|
void |
ClusterStorageManager.put(ItemPath itemPath,
C2KLocalObject obj) |
abstract void |
TransactionalClusterStorage.put(ItemPath itemPath,
C2KLocalObject obj,
Object locker) |
void |
ClusterStorageManager.put(ItemPath itemPath,
C2KLocalObject obj,
Object locker)
Internal put method.
|
void |
TransactionManager.put(ItemPath itemPath,
C2KLocalObject obj,
Object locker) |
void |
ClusterStorageManager.remove(ItemPath itemPath,
String path) |
void |
ClusterStorageManager.remove(ItemPath itemPath,
String path,
Object locker)
Deletes a cluster from all writers
|
void |
TransactionManager.remove(ItemPath itemPath,
String path,
Object locker)
Uses the put method, with null as the object value.
|
void |
TransactionManager.removeCluster(ItemPath itemPath,
String path,
Object locker)
Removes all child objects from the given path
|
| Constructor and Description |
|---|
ClusterStorageManager(Authenticator auth)
Initialises all ClusterStorage handlers listed by class name in the property "ClusterStorages"
This property is usually process specific, and so should be in the server/client.conf and not the connect file.
|
TransactionManager(Authenticator auth) |
| Modifier and Type | Method and Description |
|---|---|
Event |
Viewpoint.getEvent() |
Outcome |
Viewpoint.getOutcome() |
Outcome |
Viewpoint.getOutcome(Object locker) |
protected void |
Outcome.setMetaDataFromPath(String path) |
| Constructor and Description |
|---|
Outcome(String path,
Document data)
The constructor derives all the meta data (ID and Schema) from the path
|
Outcome(String path,
String xml)
The constructor derives all the meta data (ID and Schema) from the path
|
| Modifier and Type | Method and Description |
|---|---|
static Authenticator |
Gateway.connect()
Connects to the LDAP server in an administrative context - using the admin username and
password given in the LDAP.user and LDAP.password props of the kernel properties.
|
static AgentProxy |
Gateway.connect(String agentName,
String agentPassword) |
static AgentProxy |
Gateway.connect(String agentName,
String agentPassword,
String resource)
Log in with the given username and password, and initialises the
Lookup, TransactionManager and ProxyManager. |
void |
UserCodeProcess.resume(Job thisJob,
String jobKey)
Method called to handle the Resume transition
|
void |
UserCodeProcess.runUserCodeLogic(Job job)
Override this mehod to implement application specific (business) logic
Default implementation - the agent execute any scripts, query or both defined
|
void |
UserCodeProcess.start(Job thisJob,
String jobKey)
Method called to handle the Start transition
|
void |
UserCodeProcess.suspend(Job thisJob,
String jobKey)
Method called to handle the Suspend transition
|
| Modifier and Type | Method and Description |
|---|---|
abstract Path |
ModuleImport.create(AgentPath agentPath,
boolean reset) |
| Modifier and Type | Method and Description |
|---|---|
Object |
CastorHashMap.evaluateProperty(ItemPath itemPath,
String propName,
String actContext,
Object locker) |
| Modifier and Type | Method and Description |
|---|---|
void |
ProxyLoader.close() |
void |
MemoryOnlyClusterStorage.close() |
void |
ProxyLoader.delete(ItemPath thisItem,
String path)
delete cluster not supported
|
void |
MemoryOnlyClusterStorage.delete(ItemPath thisItem,
String path) |
void |
XMLClusterStorage.delete(ItemPath itemPath,
String path) |
String |
ProxyLoader.executeQuery(Query query) |
String |
MemoryOnlyClusterStorage.executeQuery(Query query) |
String |
XMLClusterStorage.executeQuery(Query query) |
C2KLocalObject |
ProxyLoader.get(ItemPath thisItem,
String path)
retrieve object by path
|
C2KLocalObject |
MemoryOnlyClusterStorage.get(ItemPath thisItem,
String path) |
C2KLocalObject |
XMLClusterStorage.get(ItemPath itemPath,
String path) |
String[] |
ProxyLoader.getClusterContents(ItemPath thisItem,
String path)
Directory listing
|
String[] |
MemoryOnlyClusterStorage.getClusterContents(ItemPath thisItem,
String path) |
String[] |
XMLClusterStorage.getClusterContents(ItemPath itemPath,
String path) |
void |
ProxyLoader.open(Authenticator auth) |
void |
MemoryOnlyClusterStorage.open(Authenticator auth) |
void |
XMLClusterStorage.open(Authenticator auth) |
void |
ProxyLoader.put(ItemPath thisItem,
C2KLocalObject obj)
store object not supported
|
void |
MemoryOnlyClusterStorage.put(ItemPath thisItem,
C2KLocalObject obj) |
void |
XMLClusterStorage.put(ItemPath itemPath,
C2KLocalObject obj) |
Copyright © 1997–2017 CRISTAL-iSE. All rights reserved.