|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface LocalAdministrationService
Provides administration services for the CARNOT runtime environment.
The functionality includes the following tasks:
An administration service always operates against an audit trail database.
The administration service requires that the user performing tasks has been assigned to the predefined role Administrator.
| Method Summary | |
|---|---|
ProcessInstance |
abortProcessInstance(long oid)
Aborts a process instance disregarding any activities which were or are performed by the process instance. |
void |
cleanupRuntime(boolean keepUsers)
Removes all records from the runtime environment making up the audit trail database. |
void |
cleanupRuntime(boolean keepUsers,
boolean keepBO)
Removes all records from the runtime environment making up the audit trail database. |
void |
cleanupRuntimeAndModels()
Removes all records from the runtime environment making up the audit trail database. |
Department |
createDepartment(String id,
String name,
String description,
DepartmentInfo parent,
OrganizationInfo organization)
Creates a new department. |
ProcessInstanceLinkType |
createProcessInstanceLinkType(String id,
String description)
Creates a new type of link between process instances. |
DeploymentInfo |
deleteModel(long modelOID)
Deletes the specified model. |
void |
deleteProcesses(List piOids)
Deletes process instances from the audit trail. |
void |
deleteRuntimeArtifact(long oid)
Deleted a deployed artifact by oid. |
List<DeploymentInfo> |
deployModel(List deploymentElements,
DeploymentOptions options)
Deploys a group of models. |
DeploymentInfo |
deployModel(String model,
int predecessorOID)
Deprecated. since 6.0, predecessorOID is ignored. |
DeploymentInfo |
deployModel(String model,
String configuration,
int predecessorOID,
Date validFrom,
Date validTo,
String comment,
boolean disabled,
boolean ignoreWarnings)
Deprecated. since 6.0, configuration, validTo and disabled are ignored. |
DeployedRuntimeArtifact |
deployRuntimeArtifact(RuntimeArtifact runtimeArtifact)
Deploys a new artifact with a new oid. |
void |
flushCaches()
Flushes all internal caches, effectively returning the engine to a state just like after it has started. |
ActivityInstance |
forceCompletion(long activityInstanceOID,
Map accessPoints)
Forces the completion of a non-interactive activity instance. |
ActivityInstance |
forceSuspendToDefaultPerformer(long activityInstanceOID)
Forces an activity instance to be suspended. |
List<Daemon> |
getAllDaemons(boolean acknowledge)
Retrieves a list of all the available daemons. |
AuditTrailHealthReport |
getAuditTrailHealthReport()
Determines key indicators of audit trail health. |
AuditTrailHealthReport |
getAuditTrailHealthReport(boolean countOnly)
Determines key indicators of audit trail health. |
ConfigurationVariables |
getConfigurationVariables(byte[] model)
Retrieves configuration variables from the given model (without Password type). |
List<ConfigurationVariables> |
getConfigurationVariables(List modelIds)
Retrieves merged configuration variables from all models matching the specified modelIds (without Password type). |
ConfigurationVariables |
getConfigurationVariables(String modelId)
Retrieves merged configuration variables from all models matching the specified modelId (without Password type). |
ConfigurationVariables |
getConfigurationVariables(String modelId,
boolean all)
Retrieves merged configuration variables from all models matching the specified modelId. |
Daemon |
getDaemon(String daemonType,
boolean acknowledge)
Retrieves the specified daemon. |
Department |
getDepartment(long oid)
Retrieves the department with the given oid. |
RuntimePermissions |
getGlobalPermissions()
Retrieves permissions that are globally set. |
PasswordRules |
getPasswordRules()
Returns the password rules. |
List<Permission> |
getPermissions()
Retrieves all permissions the current user has on this service plus the global permissions. |
Preferences |
getPreferences(PreferenceScope scope,
String moduleId,
String preferencesId)
Retrieves preferences from the given scope. |
Map<String,?> |
getProfile(ProfileScope scope)
Retrieves the profile for the specified scope. |
RuntimeArtifact |
getRuntimeArtifact(long oid)
Retrieves the artifact by the unique oid. |
List<ArtifactType> |
getSupportedRuntimeArtifactTypes()
Returns a list of supported artifact types. |
User |
getUser()
Retrieves information on the current user. |
void |
login(String userId,
String password)
|
void |
login(String userId,
String password,
Map properties)
|
void |
logout()
|
Department |
modifyDepartment(long oid,
String name,
String description)
Change the description of a department. |
DeploymentInfo |
overwriteModel(DeploymentElement deploymentElement,
int modelOID,
DeploymentOptions options)
Overwrites the specified model. |
DeploymentInfo |
overwriteModel(String model,
int modelOID)
Deprecated. since 6.0 |
DeploymentInfo |
overwriteModel(String model,
String configuration,
int modelOID,
Date validFrom,
Date validTo,
String comment,
boolean disabled,
boolean ignoreWarnings)
Deprecated. since 6.0, configuration, validFrom, validTo and disabled are ignored. |
DeployedRuntimeArtifact |
overwriteRuntimeArtifact(long oid,
RuntimeArtifact runtimeArtifact)
Overwrites only content of a specified already deployed artifact. |
ProcessInstance |
recoverProcessInstance(long oid)
Recovers the process instance identified by the given OID and all of its subprocess instances, executed in a separate transaction. |
void |
recoverProcessInstances(List oids)
Recovers the process instances identified by the given list of OIDs and all associated subprocess instances.Executed in a separate transaction. |
void |
recoverRuntimeEnvironment()
Recovers the complete CARNOT runtime environment.Executed in a separate transaction. |
void |
removeDepartment(long oid)
Removes the department having the specified oid, all his children and all user grants associated with the department. |
List<ModelReconfigurationInfo> |
saveConfigurationVariables(ConfigurationVariables configurationVariables,
boolean force)
Saves changes to configuration variables values. |
void |
savePreferences(List preferences)
Saves a complete list of preferences to the preference store. |
void |
savePreferences(Preferences preferences)
Saves the changed preferences to the preference store. |
void |
setGlobalPermissions(RuntimePermissions permissions)
Saves the changed Permissions. |
void |
setPasswordRules(PasswordRules rules)
Set password rule. |
DeploymentInfo |
setPrimaryImplementation(long interfaceModelOid,
String processId,
String implementationModelId,
org.eclipse.stardust.engine.api.runtime.LinkingOptions options)
Specifies which implementation alternative ( identified by implementationModelId) will be considered the primary implementation of the process interface declared by a specific process definition (identified by interfaceModelOid and processId). |
ProcessInstance |
setProcessInstancePriority(long oid,
int priority)
Changes the process instance priority. |
ProcessInstance |
setProcessInstancePriority(long oid,
int priority,
boolean propagateToSubProcesses)
Changes the process instance priority. |
void |
setProfile(ProfileScope scope,
Map profile)
Sets the profile for the specified scope. |
Daemon |
startDaemon(String daemonType,
boolean acknowledge)
Starts the specified daemon. |
ProcessInstance |
startProcess(long modelOID,
String id,
Map data,
boolean synchronously)
Starts a process from a specified model.The startProcess method is executed asynchronously if the synchronously parameter is set to false.However, even if the synchronously parameter is true, the execution of activities is performed in the calling thread only up to the first transition marked with "Fork on Traversal", from that point on execution is asynchronous. |
Daemon |
stopDaemon(String daemonType,
boolean acknowledge)
Stops the specified daemon. |
void |
writeLogEntry(LogType logType,
ContextKind contextType,
long contextOid,
String message,
Throwable throwable)
Logs an audit trail event of type LogCode.ADMINISTRATION. |
| Methods inherited from interface javax.ejb.EJBLocalObject |
|---|
getEJBLocalHome, getPrimaryKey, isIdentical, remove |
| Method Detail |
|---|
void setPasswordRules(PasswordRules rules)
throws org.eclipse.stardust.common.error.WorkflowException
rules - The rules or null.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.setPasswordRules(
org.eclipse.stardust.engine.api.runtime.PasswordRules rules)
PasswordRules getPasswordRules()
throws org.eclipse.stardust.common.error.WorkflowException
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.getPasswordRules()
DeploymentInfo deployModel(String model,
int predecessorOID)
throws org.eclipse.stardust.common.error.WorkflowException
model - the XML representation of the model to deploy.predecessorOID - the predecessor of the model in the priority list. A value
of 0 indicates an absent predecessor.
DeploymentException - Instances of DeploymentException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.deployModel(
java.lang.String model, int predecessorOID)
DeploymentInfo overwriteModel(String model,
int modelOID)
throws org.eclipse.stardust.common.error.WorkflowException
model - the XML representation of the model to deploy.modelOID - the model to be overwritten.
DeploymentException - Instances of DeploymentException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.overwriteModel(
java.lang.String model, int modelOID)
DeploymentInfo deployModel(String model,
String configuration,
int predecessorOID,
Date validFrom,
Date validTo,
String comment,
boolean disabled,
boolean ignoreWarnings)
throws org.eclipse.stardust.common.error.WorkflowException
model - the XML representation of the model to deploy.configuration - reserved for internal use (can be null).predecessorOID - the predecessor of the model in the priority list. A value
of 0 indicates an absent predecessor.validFrom - validity start time for the model or null if unlimited.validTo - validity end time for the model or null if unlimited.comment - deployment comment.disabled - specifies if the model should disabled after deployment.ignoreWarnings - specifies that the deployment should continue if only warnings were
issued.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.deployModel(
java.lang.String model, java.lang.String configuration, int predecessorOID,
java.util.Date validFrom, java.util.Date validTo, java.lang.String comment, boolean
disabled, boolean ignoreWarnings)
DeploymentInfo overwriteModel(String model,
String configuration,
int modelOID,
Date validFrom,
Date validTo,
String comment,
boolean disabled,
boolean ignoreWarnings)
throws org.eclipse.stardust.common.error.WorkflowException
model - the XML representation of the model to deploy.configuration - reserved for internal use (can be null).modelOID - the model to be overwritten.validFrom - validity start time for the model or null if unlimited.validTo - validity end time for the model or null if unlimited.comment - deployment comment.disabled - specifies if the model should disabled after deployment.ignoreWarnings - specifies that the deployment should continue if only warnings were
issued.
DeploymentException - Instances of DeploymentException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.overwriteModel(
java.lang.String model, java.lang.String configuration, int modelOID, java.util.Date
validFrom, java.util.Date validTo, java.lang.String comment, boolean disabled, boolean
ignoreWarnings)
DeploymentInfo overwriteModel(DeploymentElement deploymentElement,
int modelOID,
DeploymentOptions options)
throws org.eclipse.stardust.common.error.WorkflowException
deploymentElement - The model to be overwritten.modelOID - The modelOID of the model to be overwritten.options - The deployment options. Can be null, in which case default deployment
options will be used.
DeploymentException - Exception if the overwrite
operation could not be performed.
Instances of DeploymentException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.overwriteModel(
org.eclipse.stardust.engine.api.runtime.DeploymentElement deploymentElement, int
modelOID, org.eclipse.stardust.engine.api.runtime.DeploymentOptions options)
List<DeploymentInfo> deployModel(List deploymentElements,
DeploymentOptions options)
throws org.eclipse.stardust.common.error.WorkflowException
deploymentElements - The models to be deployed. Each model in the set must have a unique
ID.options - The deployment options. Can be null, in which case default
deployment options will be used.
DeploymentException - if the deployment operation
could not be performed.
Instances of DeploymentException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidArgumentException - if the deploymentElements
argument is null.
Instances of InvalidArgumentException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ConcurrencyException - if the multiple transactions
trying to deploy models at the same time.
Instances of ConcurrencyException will be
wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.deployModel(
java.util.List deploymentElements,
org.eclipse.stardust.engine.api.runtime.DeploymentOptions options)
DeploymentInfo setPrimaryImplementation(long interfaceModelOid,
String processId,
String implementationModelId,
org.eclipse.stardust.engine.api.runtime.LinkingOptions options)
throws org.eclipse.stardust.common.error.WorkflowException
Precondition:
If implementationModelId is null the default implementation will
be reset
to the process definition declaring the process interface (
the default implementation).
interfaceModelOid - The OID of the model defining the process interface.processId - The ID of the process definition declaring the process interface.implementationModelId - The ID of the model providing the implementation.options - The linking comments.
DeploymentException - if the linking operation
could not be performed.
Instances of DeploymentException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.setPrimaryImplementation(
long interfaceModelOid, java.lang.String processId, java.lang.String
implementationModelId, org.eclipse.stardust.engine.api.runtime.LinkingOptions options)
DeploymentInfo deleteModel(long modelOID)
throws org.eclipse.stardust.common.error.WorkflowException
modelOID - the model to be deleted.
DeploymentException - Instances of DeploymentException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.deleteModel(
long modelOID)
void deleteProcesses(List piOids)
throws org.eclipse.stardust.common.error.WorkflowException
piOids - A list with OIDs of the root process instance to be deleted.
IllegalOperationException - Raised if non-root or
non-terminated process
instances are to be deleted.
Instances of IllegalOperationException will be wrapped
inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.deleteProcesses(
java.util.List piOids)
void cleanupRuntime(boolean keepUsers,
boolean keepBO)
throws org.eclipse.stardust.common.error.WorkflowException
keepUsers - a flag to specify if the users should be deleted or not.keepBO - a flag to specify if the BO should be deleted or not.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.cleanupRuntime(
boolean keepUsers, boolean keepBO)
void cleanupRuntime(boolean keepUsers)
throws org.eclipse.stardust.common.error.WorkflowException
keepUsers - a flag to specify if the users should be deleted or not.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.cleanupRuntime(
boolean keepUsers)
void cleanupRuntimeAndModels()
throws org.eclipse.stardust.common.error.WorkflowException
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.cleanupRuntimeAndModels()
ProcessInstance setProcessInstancePriority(long oid,
int priority)
throws org.eclipse.stardust.common.error.WorkflowException
oid - the OID of the process instance the priority should be changed of.priority - the new priority of the process instance.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process
instance with the specified oid.
Instances of ObjectNotFoundException will
be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.setProcessInstancePriority(
long oid, int priority)
ProcessInstance setProcessInstancePriority(long oid,
int priority,
boolean propagateToSubProcesses)
throws org.eclipse.stardust.common.error.WorkflowException
oid - the OID of the process instance the priority should be changed of.priority - the new priority of the process instance.propagateToSubProcesses - if true, the priority will be propagated to all subprocesses.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process
instance with the specified oid.
Instances of ObjectNotFoundException will
be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.setProcessInstancePriority(
long oid, int priority, boolean propagateToSubProcesses)
ProcessInstance abortProcessInstance(long oid)
throws org.eclipse.stardust.common.error.WorkflowException
State changes:
oid - the OID of the process instance to be aborted.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process
instance with the specified oid.
Instances of ObjectNotFoundException will
be wrapped inside WorkflowException.
IllegalOperationException - if the oid references
a case process instance.
Instances of IllegalOperationException will be wrapped
inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsWorkflowService.abortActivityInstance(long),
AdministrationService.abortProcessInstance(
long oid)
ProcessInstance recoverProcessInstance(long oid)
throws org.eclipse.stardust.common.error.WorkflowException
This includes crashes during non-interactive application execution and crashes of the CARNOT runtime engine itself.
oid - the OID of the process instance to be recovered.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process
instance with the specified oid.
Instances of ObjectNotFoundException will
be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.recoverProcessInstance(
long oid)
void recoverProcessInstances(List oids)
throws org.eclipse.stardust.common.error.WorkflowException
This includes crashes during non-interactive application execution and crashes of the CARNOT runtime engine itself.
oids - the list of OID of the process instance to be recovered.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process
instance for one of the specified oids.
Instances of ObjectNotFoundException will
be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.recoverProcessInstances(
java.util.List oids)
Daemon getDaemon(String daemonType,
boolean acknowledge)
throws org.eclipse.stardust.common.error.WorkflowException
mail.trigger for the mail trigger daemon
timer.trigger for the timer trigger daemon
event.daemon for the event daemon
system.daemon for the notification daemon.criticality.daemon for the prioritization daemon.benchmark.daemon for the benchmark daemon.reporting.daemon for the reporting daemon.business_calendar.daemon for the business calendar daemon.
daemonType - the type of the daemon.acknowledge - whether to acknowledge the daemon information
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no daemon with
the specified type.
Instances of ObjectNotFoundException will
be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.getDaemon(
java.lang.String daemonType, boolean acknowledge)
Daemon stopDaemon(String daemonType,
boolean acknowledge)
throws org.eclipse.stardust.common.error.WorkflowException
getDaemon(String, boolean) for a list
of daemon types.The stop daemon operation is inherently asynchronous, regardless of the
acknowledge flag.
The stop operation only marks the daemon for stopping. The daemon will stop
asynchronously at the first opportunity.
If the acknowledge parameter is set to true then the method will wait for a
predetermined (configurable)
amount of time for the asynchronous daemon to confirm the execution of the operation.
If acknowledge is false then the method will return immediately,
without status updates to the returned object.
Otherwise it will wait for the executor thread to confirm the action.
The acknowledge flag allows to wait for the executor to confirm the actual stop of the
daemon.
The status object is not influenced by this flag.
daemonType - the type of the daemon to be stopped.acknowledge - whether to acknowledge the stop operation.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no daemon with
the specified type.
Instances of ObjectNotFoundException will
be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.stopDaemon(
java.lang.String daemonType, boolean acknowledge)
Daemon startDaemon(String daemonType,
boolean acknowledge)
throws org.eclipse.stardust.common.error.WorkflowException
getDaemon(String, boolean) for a list
of daemon types.
The start daemon operation is inherently asynchronous, regardless of the acknowledge
flag.
The start operation schedules a timer for the daemon execution which will be performed
asynchronously.
If the acknowledge parameter is set to true then the method will wait for a
predetermined (configurable)
amount of time for the asynchronous daemon to confirm the execution of the operation.
If acknowledge is false then the method will return immediately, without status updates
to the returned object.
Otherwise it will wait for the executor thread to confirm the action.
The acknowledge flag allows to wait for the executor to confirm the actual start of the
daemon.
The status object is not influenced by this flag.
daemonType - the type of the daemon to be started.acknowledge - whether to acknowledge the start operation
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no daemon with
the specified type.
Instances of ObjectNotFoundException will
be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.startDaemon(
java.lang.String daemonType, boolean acknowledge)
List<Daemon> getAllDaemons(boolean acknowledge)
throws org.eclipse.stardust.common.error.WorkflowException
acknowledge - whether to acknowledge the daemon information
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.getAllDaemons(
boolean acknowledge)
AuditTrailHealthReport getAuditTrailHealthReport()
throws org.eclipse.stardust.common.error.WorkflowException
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.getAuditTrailHealthReport(
)
AuditTrailHealthReport getAuditTrailHealthReport(boolean countOnly)
throws org.eclipse.stardust.common.error.WorkflowException
countOnly - Determines if report should include the process instances oids or just the
total count of oids. If countOnly is set to true the total count of
process instances will be included in report. If countOnly is set to false
a list containing the process instances oids will be included in report.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.getAuditTrailHealthReport(
boolean countOnly)
void recoverRuntimeEnvironment()
throws org.eclipse.stardust.common.error.WorkflowException
This reanimates dead activity threads from an application server crash. Additionally previously interrupted processes are reanimated.
It is equivalent with recovering all the process instances which are in the states active or interrupted.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.recoverRuntimeEnvironment(
)
ProcessInstance startProcess(long modelOID,
String id,
Map data,
boolean synchronously)
throws org.eclipse.stardust.common.error.WorkflowException
State changes:
modelOID - the model where the process is defined.id - the ID of the process to start.data - contains data IDs as keyset and corresponding data values to
be set as values.synchronously - determines whether the process will be started synchronously
or asynchronously.
ProcessInstance that was started.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process with
the specified ID in the
specified model or if the model does not exist.
Instances of ObjectNotFoundException will
be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.startProcess(
long modelOID, java.lang.String id, java.util.Map data, boolean synchronously)
ActivityInstance forceCompletion(long activityInstanceOID,
Map accessPoints)
throws org.eclipse.stardust.common.error.WorkflowException
State changes:
If the process hierarchy is halted:
activityInstanceOID - - the OID of the non-interactive activity to be completed.accessPoints - - an optional map with access points to perform data mappings,
can be null
ActivityInstance.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity with
the specified OID.
Instances of ObjectNotFoundException will
be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ConcurrencyException - if the activity instance is
exclusively locked by another thread.
Instances of ConcurrencyException will be
wrapped inside WorkflowException.
IllegalStateChangeException - if the activity is
already completed or aborted.
Instances of IllegalStateChangeException will be wrapped
inside WorkflowException.
org.eclipse.stardust.common.error.InvalidValueException - if one of the
outData values to
be written is invalid, most probably as of a type conflict in case of
statically typed data.
Instances of InvalidValueException will
be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user is not
an administrator.
Instances of AccessForbiddenException
will be wrapped inside WorkflowException.
IllegalOperationException - if the activity
instance is interactive.
Instances of IllegalOperationException will be wrapped
inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsforceSuspendToDefaultPerformer(long),
AdministrationService.forceCompletion(
long activityInstanceOID, java.util.Map accessPoints)
ActivityInstance forceSuspendToDefaultPerformer(long activityInstanceOID)
throws org.eclipse.stardust.common.error.WorkflowException
State changes:
If the process hierarchy is halted:
activityInstanceOID - the OID of the activity to be suspended.
ActivityInstance that was
suspended.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity
instance with the specified OID.
Instances of ObjectNotFoundException will
be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ConcurrencyException - if the activity instance is
exclusively locked by another thread.
Instances of ConcurrencyException will be
wrapped inside WorkflowException.
IllegalStateChangeException - if the activity is
already completed or aborted.
Instances of IllegalStateChangeException will be wrapped
inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user does not
have the required privilege.
Instances of AccessForbiddenException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsforceCompletion(long, java.util.Map),
AdministrationService.forceSuspendToDefaultPerformer(
long activityInstanceOID)
User getUser()
throws org.eclipse.stardust.common.error.WorkflowException
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.getUser()
void flushCaches()
throws org.eclipse.stardust.common.error.WorkflowException
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.flushCaches()
List<Permission> getPermissions()
throws org.eclipse.stardust.common.error.WorkflowException
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.getPermissions()
Map<String,?> getProfile(ProfileScope scope)
throws org.eclipse.stardust.common.error.WorkflowException
scope -
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.getProfile(
org.eclipse.stardust.engine.api.model.ProfileScope scope)
void setProfile(ProfileScope scope,
Map profile)
throws org.eclipse.stardust.common.error.WorkflowException
scope - the scope.profile - the profile.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.setProfile(
org.eclipse.stardust.engine.api.model.ProfileScope scope, java.util.Map profile)
void writeLogEntry(LogType logType,
ContextKind contextType,
long contextOid,
String message,
Throwable throwable)
throws org.eclipse.stardust.common.error.WorkflowException
LogCode.ADMINISTRATION.
logType - Set the type of log (
info, warn, error etc.). Whereas the Unknown type is mapped to a warning.contextType - Set the context scope of the eventcontextOid - Oid of the runtime object (
only used if context type is set to ProcessInstance or ActivityInstance)message - any message that should be loggedthrowable - any exception (or null) that should be appended to the message
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no runtime object
with the specified OID
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.writeLogEntry(
org.eclipse.stardust.engine.api.runtime.LogType logType,
org.eclipse.stardust.engine.api.dto.ContextKind contextType, long contextOid,
java.lang.String message, java.lang.Throwable throwable)
Department createDepartment(String id,
String name,
String description,
DepartmentInfo parent,
OrganizationInfo organization)
throws org.eclipse.stardust.common.error.WorkflowException
id - the id of the department. Must not be null or empty and it must be unique in the
parent scope.name - the name of the department. Must not be null or empty.description - the description of the department.parent - the parent scope. Can be null if the department will be a top level department.organization - the organization to which this department is assigned. Must not be null.
DepartmentExistsException - if a department with the same id already exists in the parent scope.
Instances of DepartmentExistsException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if either the parent or the organization could not be resolved.
Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidArgumentException - InvalidArgumentException
will be wrapped inside WorkflowException.
IllegalOperationException - - if the user was
external authentified
Instances of IllegalOperationException will be wrapped
inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.createDepartment(
java.lang.String id, java.lang.String name, java.lang.String description,
org.eclipse.stardust.engine.api.runtime.DepartmentInfo parent,
org.eclipse.stardust.engine.api.model.OrganizationInfo organization)
Department getDepartment(long oid)
throws org.eclipse.stardust.common.error.WorkflowException
oid - the unique identifier of the department.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no department with the specified oid.
Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.getDepartment(long oid)
Department modifyDepartment(long oid,
String name,
String description)
throws org.eclipse.stardust.common.error.WorkflowException
oid - the unique identifier of the department.name - the new name of the department.description - the new description.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no department with the specified oid.
Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidArgumentException - if the name is null or an empty string
Instances of InvalidArgumentException will be wrapped inside WorkflowException.
IllegalOperationException - - if the user was
external authentified
Instances of IllegalOperationException will be wrapped
inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.modifyDepartment(
long oid, java.lang.String name, java.lang.String description)
void removeDepartment(long oid)
throws org.eclipse.stardust.common.error.WorkflowException
oid - the unique identifier of the department.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no department with the specified oid.
Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidArgumentException - if there are work items currently associated with the department or any child of the
f the department.
Instances of InvalidArgumentException will be wrapped inside WorkflowException.
IllegalOperationException - - if the user was
external authentified
Instances of IllegalOperationException will be wrapped
inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.removeDepartment(
long oid)
Preferences getPreferences(PreferenceScope scope,
String moduleId,
String preferencesId)
throws org.eclipse.stardust.common.error.WorkflowException
scope - the scope from which the preferences are to be retrieved frommoduleId - the moduleId of the preferencespreferencesId - the id of the preferences
org.eclipse.stardust.common.error.PublicException - if scope is null.
Instances of PublicException will be
wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.getPreferences(
org.eclipse.stardust.engine.core.preferences.PreferenceScope scope, java.lang.String
moduleId, java.lang.String preferencesId)
void savePreferences(Preferences preferences)
throws org.eclipse.stardust.common.error.WorkflowException
preferences - an preferences object to be saved.
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user does not
have the required privilege.
Instances of AccessForbiddenException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidArgumentException - if preferences is
null.
Instances of InvalidArgumentException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidArgumentException - if preferences property
preferences is null.
Instances of InvalidArgumentException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidArgumentException - if preferences property
moduleId is null or empty.
Instances of InvalidArgumentException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidArgumentException - if preferences property
preferencesId is null or empty.
Instances of InvalidArgumentException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.savePreferences(
org.eclipse.stardust.engine.core.preferences.Preferences preferences)
void savePreferences(List preferences)
throws org.eclipse.stardust.common.error.WorkflowException
preferences - a list of preferences to be saved.
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user does not
have the required privilege.
Instances of AccessForbiddenException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidArgumentException - if preferences is
null.
Instances of InvalidArgumentException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidArgumentException - if preferences property
moduleId is null or empty.
Instances of InvalidArgumentException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidArgumentException - if preferences property
preferencesId is null or empty.
Instances of InvalidArgumentException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.savePreferences(
java.util.List preferences)
ConfigurationVariables getConfigurationVariables(String modelId)
throws org.eclipse.stardust.common.error.WorkflowException
modelId - The modelId of the model(s) to retrieve the configuration variables from.
org.eclipse.stardust.common.error.InvalidArgumentException - if modelId is null
or empty.
Instances of InvalidArgumentException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.getConfigurationVariables(
java.lang.String modelId)
ConfigurationVariables getConfigurationVariables(String modelId,
boolean all)
throws org.eclipse.stardust.common.error.WorkflowException
modelId - The modelId of the model(s) to retrieve the configuration variables from.all - Indicates if to fetch all configuration variables, including Password type.
org.eclipse.stardust.common.error.InvalidArgumentException - if modelId is null
or empty.
Instances of InvalidArgumentException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.getConfigurationVariables(
java.lang.String modelId, boolean all)
List<ConfigurationVariables> getConfigurationVariables(List modelIds)
throws org.eclipse.stardust.common.error.WorkflowException
modelIds - The modelId of the model(s) to retrieve the configuration variables from.
org.eclipse.stardust.common.error.InvalidArgumentException - if modelIds is null
or contains an modelId which is null or empty.
Instances of InvalidArgumentException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.getConfigurationVariables(
java.util.List modelIds)
ConfigurationVariables getConfigurationVariables(byte[] model)
throws org.eclipse.stardust.common.error.WorkflowException
model - The model xml representation in byte array form.
org.eclipse.stardust.common.error.InvalidArgumentException - if model is null.
Instances of InvalidArgumentException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.getConfigurationVariables(
byte[] model)
List<ModelReconfigurationInfo> saveConfigurationVariables(ConfigurationVariables configurationVariables,
boolean force)
throws org.eclipse.stardust.common.error.WorkflowException
configurationVariables - The configuration variables containing changed values.force - Option to ignore validation warnings.
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user does not
have the required privilege.
Instances of AccessForbiddenException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidArgumentException - if
configurationVariables is null.
Instances of InvalidArgumentException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.saveConfigurationVariables(
org.eclipse.stardust.engine.core.preferences.configurationvariables.ConfigurationVariables
configurationVariables, boolean force)
RuntimePermissions getGlobalPermissions()
throws org.eclipse.stardust.common.error.WorkflowException
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.getGlobalPermissions()
void setGlobalPermissions(RuntimePermissions permissions)
throws org.eclipse.stardust.common.error.WorkflowException
getGlobalPermissions to retrieve currently valid global permissions
first.
Permissions with null or empty lists set as grants will be reset to their internal
default.
Changed grants are validated against the currently active model for existing model
participants.
permissions - the modified permissions
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user does not
have the required privilege.
Instances of AccessForbiddenException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidArgumentException - if permissions is
null.
Instances of InvalidArgumentException
will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ValidationException - if changed grants are not valid
in the active model.
Instances of ValidationException will be
wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.setGlobalPermissions(
org.eclipse.stardust.engine.api.runtime.RuntimePermissions permissions)
DeployedRuntimeArtifact deployRuntimeArtifact(RuntimeArtifact runtimeArtifact)
throws org.eclipse.stardust.common.error.WorkflowException
If an artifact with the same validFrom date already exists, the newly deployed artifact takes priority when querying for active artifacts.
runtimeArtifact - The new artifact.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.deployRuntimeArtifact(
org.eclipse.stardust.engine.api.runtime.RuntimeArtifact runtimeArtifact)
DeployedRuntimeArtifact overwriteRuntimeArtifact(long oid,
RuntimeArtifact runtimeArtifact)
throws org.eclipse.stardust.common.error.WorkflowException
oid - The oid of the artifact.runtimeArtifact - The new artifact.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no runtime
artifact with the specified oid.
Instances of ObjectNotFoundException will
be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.overwriteRuntimeArtifact(
long oid, org.eclipse.stardust.engine.api.runtime.RuntimeArtifact runtimeArtifact)
void deleteRuntimeArtifact(long oid)
throws org.eclipse.stardust.common.error.WorkflowException
oid - The oid of the artifact
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no runtime
artifact with the specified oid.
Instances of ObjectNotFoundException will
be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.deleteRuntimeArtifact(
long oid)
RuntimeArtifact getRuntimeArtifact(long oid)
throws org.eclipse.stardust.common.error.WorkflowException
oid - The oid of the artifact.
null if it does not exist.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.getRuntimeArtifact(
long oid)
List<ArtifactType> getSupportedRuntimeArtifactTypes()
throws org.eclipse.stardust.common.error.WorkflowException
The ArtifactType.getId()
is used to identify the ArtifactType for a
RuntimeArtifact.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.getSupportedRuntimeArtifactTypes(
)
ProcessInstanceLinkType createProcessInstanceLinkType(String id,
String description)
throws org.eclipse.stardust.common.error.WorkflowException
id - the id of the link type.description - the description of the link type.
org.eclipse.stardust.common.error.ObjectExistsException - if another link type with the
same id already exists.
Instances of ObjectExistsException will
be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptionsAdministrationService.createProcessInstanceLinkType(
java.lang.String id, java.lang.String description)
void login(String userId,
String password)
throws org.eclipse.stardust.common.error.WorkflowException
org.eclipse.stardust.common.error.WorkflowException
void login(String userId,
String password,
Map properties)
throws org.eclipse.stardust.common.error.WorkflowException
org.eclipse.stardust.common.error.WorkflowExceptionvoid logout()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||