RemoteAdministrationService (carnot-engine)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.stardust.engine.api.ejb2
Interface RemoteAdministrationService

All Superinterfaces:: javax.ejb.EJBObject, Remote

public interface RemoteAdministrationService
extends javax.ejb.EJBObject
extends javax.ejb.EJBObject

Provides administration services for the CARNOT runtime environment.

The functionality includes the following tasks:

manage the workflow models (deploy, modify or delete)
recover the runtime environment or single workflow objects
terminate running process instances
manage the life cycle management of CARNOT daemons

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.

Version:: 68817
Author:: ubirkemeyer

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`	`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.
`DeploymentInfo`	`deleteModel(long modelOID)` Deletes the specified model.
`void`	`deleteProcesses(List piOids)` Deletes process instances from the audit trail.
`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.
`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.
`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.
`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.EJBObject
`getEJBHome, getHandle, getPrimaryKey, isIdentical, remove`

Method Detail

setPasswordRules

void setPasswordRules(PasswordRules rules)
                      throws WorkflowException,
                             RemoteException

Set password rule.

Parameters:: The - rules or null.
Throws:: WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.setPasswordRules( org.eclipse.stardust.engine.api.runtime.PasswordRules rules)

getPasswordRules

PasswordRules getPasswordRules()
                               throws WorkflowException,
                                      RemoteException

Returns the password rules.

Returns:: The password rules or null.
Throws:: WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.getPasswordRules()

deployModel

DeploymentInfo deployModel(String model,
                           int predecessorOID)
                           throws WorkflowException,
                                  RemoteException

Deprecated. since 6.0, predecessorOID is ignored.

Deploys a new model.

Parameters:: 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.
Returns:: deployment information, including possible errors or warnings.
Throws:: DeploymentException - Instances of DeploymentException will be wrapped inside WorkflowException.; WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.deployModel( java.lang.String model, int predecessorOID)

overwriteModel

DeploymentInfo overwriteModel(String model,
                              int modelOID)
                              throws WorkflowException,
                                     RemoteException

Deprecated. since 6.0

Overwrites the specified model.

Parameters:: model - the XML representation of the model to deploy.; modelOID - the model to be overwritten.
Returns:: deployment information, including possible errors or warnings.
Throws:: DeploymentException - Instances of DeploymentException will be wrapped inside WorkflowException.; WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.overwriteModel( java.lang.String model, int modelOID)

deployModel

DeploymentInfo deployModel(String model,
                           String configuration,
                           int predecessorOID,
                           Date validFrom,
                           Date validTo,
                           String comment,
                           boolean disabled,
                           boolean ignoreWarnings)
                           throws WorkflowException,
                                  RemoteException

Deprecated. since 6.0, configuration, validTo and disabled are ignored.

Deploys a new model.

Parameters:: 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.
Returns:: deployment information, including possible errors or warnings.
Throws:: WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.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)

overwriteModel

DeploymentInfo overwriteModel(String model,
                              String configuration,
                              int modelOID,
                              Date validFrom,
                              Date validTo,
                              String comment,
                              boolean disabled,
                              boolean ignoreWarnings)
                              throws WorkflowException,
                                     RemoteException

Deprecated. since 6.0, configuration, validFrom, validTo and disabled are ignored.

Overwrites the specified model.

Parameters:: 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.
Returns:: deployment information, including possible errors or warnings.
Throws:: DeploymentException - Instances of DeploymentException will be wrapped inside WorkflowException.; WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.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)

overwriteModel

DeploymentInfo overwriteModel(DeploymentElement deploymentElement,
                              int modelOID,
                              DeploymentOptions options)
                              throws WorkflowException,
                                     RemoteException

Overwrites the specified model.

Parameters:: 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.
Returns:: depoymentInfo Deployment information information, including possible errors or warning
Throws:: DeploymentException - Exception if the overwrite operation could not be performed. Instances of DeploymentException will be wrapped inside WorkflowException.; WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.overwriteModel( org.eclipse.stardust.engine.api.runtime.DeploymentElement deploymentElement, int modelOID, org.eclipse.stardust.engine.api.runtime.DeploymentOptions options)

deployModel

List<DeploymentInfo> deployModel(List deploymentElements,
                                 DeploymentOptions options)
                                 throws WorkflowException,
                                        RemoteException

Deploys a group of models. The deployment operation is transactional, that means either all models in the group are deployed or none of them. Model references will be resolved first within the group, and only if there is no corresponding model in the group the already deployed models will be considered.

Parameters:: 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.
Returns:: Deployment information, including possible errors or warnings, one DeploymentInfo per DeploymentElement.
Throws:: DeploymentException - if the deployment operation could not be performed. Instances of DeploymentException will be wrapped inside WorkflowException.; 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.; WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.deployModel( java.util.List deploymentElements, org.eclipse.stardust.engine.api.runtime.DeploymentOptions options)

setPrimaryImplementation

DeploymentInfo setPrimaryImplementation(long interfaceModelOid,
                                        String processId,
                                        String implementationModelId,
                                        org.eclipse.stardust.engine.api.runtime.LinkingOptions options)
                                        throws WorkflowException,
                                               RemoteException

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).

Precondition:

There needs to be at least one model having the ID implementingModelId that contains a process definition which implements the specified process interface.

If implementationModelId is null the default implementation will be reset to the process definition declaring the process interface ( the default implementation).

Parameters:: 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.
Returns:: Deployment information, including possible errors or warnings.
Throws:: DeploymentException - if the linking operation could not be performed. Instances of DeploymentException will be wrapped inside WorkflowException.; WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.setPrimaryImplementation( long interfaceModelOid, java.lang.String processId, java.lang.String implementationModelId, org.eclipse.stardust.engine.api.runtime.LinkingOptions options)

deleteModel

DeploymentInfo deleteModel(long modelOID)
                           throws WorkflowException,
                                  RemoteException

Deletes the specified model.

Parameters:: modelOID - the model to be deleted.
Returns:: deployment information, including possible errors or warnings.
Throws:: DeploymentException - Instances of DeploymentException will be wrapped inside WorkflowException.; WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.deleteModel( long modelOID)

deleteProcesses

void deleteProcesses(List piOids)
                     throws WorkflowException,
                            RemoteException

Deletes process instances from the audit trail.

Only terminated root process instance can be deleted. All subprocess instances started by one of the root process instances to be deleted will be deleted transitively, too.

Parameters:: piOids - A list with OIDs of the root process instance to be deleted.
Throws:: IllegalOperationException - Raised if non-root or non-terminated process instances are to be deleted. Instances of IllegalOperationException will be wrapped inside WorkflowException.; WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.deleteProcesses( java.util.List piOids)

cleanupRuntime

void cleanupRuntime(boolean keepUsers)
                    throws WorkflowException,
                           RemoteException

Removes all records from the runtime environment making up the audit trail database. The tables will still remain in the database.

Parameters:: keepUsers - a flag to specify if the users should be deleted or not.
Throws:: WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.cleanupRuntime( boolean keepUsers)

cleanupRuntimeAndModels

void cleanupRuntimeAndModels()
                             throws WorkflowException,
                                    RemoteException

Removes all records from the runtime environment making up the audit trail database. Additionally empties the model table. The tables will still remain in the database.

Throws:: WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.cleanupRuntimeAndModels( )

setProcessInstancePriority

ProcessInstance setProcessInstancePriority(long oid,
                                           int priority)
                                           throws WorkflowException,
                                                  RemoteException

Changes the process instance priority. Equivalent with setProcessInstancePriority(oid, priority, false).

Parameters:: oid - the OID of the process instance the priority should be changed of.; priority - the new priority of the process instance.
Returns:: the process instance that was changed.
Throws:: org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process instance with the specified oid. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.; WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.setProcessInstancePriority( long oid, int priority)

setProcessInstancePriority

ProcessInstance setProcessInstancePriority(long oid,
                                           int priority,
                                           boolean propagateToSubProcesses)
                                           throws WorkflowException,
                                                  RemoteException

Changes the process instance priority.

Parameters:: 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.
Returns:: the process instance that was changed.
Throws:: org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process instance with the specified oid. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.; WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.setProcessInstancePriority( long oid, int priority, boolean propagateToSubProcesses)

abortProcessInstance

ProcessInstance abortProcessInstance(long oid)
                                     throws WorkflowException,
                                            RemoteException

Aborts a process instance disregarding any activities which were or are performed by the process instance. Regularly the process instance to be aborted will be set to the state ABORTING synchronously. The returned ProcessInstance object will already be in that state. Before returning the ProcessInstance object, a asynchronous abortion task is scheduled for it. If the process instance is not yet inserted in the database but needs to be aborted for some reason ( e.g. by abort process event) then the abort operation is optimized to happen completely synchronously. In that case the returned ProcessInstance will already be in state ABORTED. This method also aborts all super process instances.

State changes:

Process state before: active, interrupted
State after: The state of root process, all sub-processes and activities that are not yet completed changes to aborted.

Parameters:: oid - the OID of the process instance to be aborted.
Returns:: the process instance that was aborted.
Throws:: 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.; WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: WorkflowService.abortActivityInstance(long), AdministrationService.abortProcessInstance( long oid)

recoverProcessInstance

ProcessInstance recoverProcessInstance(long oid)
                                       throws WorkflowException,
                                              RemoteException

Recovers the process instance identified by the given OID and all of its subprocess instances, executed in a separate transaction. By default the execution is synchronous. An asynchronous successor attempt to recover the process instance is scheduled only if there is a non fatal error (e.g. locking conflicts) during the first attempt.

This includes crashes during non-interactive application execution and crashes of the CARNOT runtime engine itself.

Parameters:: oid - the OID of the process instance to be recovered.
Returns:: the process instance that was recovered.
Throws:: org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process instance with the specified oid. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.; WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.recoverProcessInstance( long oid)

recoverProcessInstances

void recoverProcessInstances(List oids)
                             throws WorkflowException,
                                    RemoteException

Recovers the process instances identified by the given list of OIDs and all associated subprocess instances.Executed in a separate transaction. By default the execution is synchronous. Asynchronous successor attempts to recover the affected process instances are only scheduled if there are non fatal errors ( e.g. locking conflicts) during the first attempts.

This includes crashes during non-interactive application execution and crashes of the CARNOT runtime engine itself.

Parameters:: oids - the list of OID of the process instance to be recovered.
Throws:: 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.; WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.recoverProcessInstances( java.util.List oids)

getDaemon

Daemon getDaemon(String daemonType,
                 boolean acknowledge)
                 throws WorkflowException,
                        RemoteException

Retrieves the specified daemon. The following daemon types exist:

event.daemon for the event daemon
mail.trigger for the mail trigger daemon
timer.trigger for the timer trigger daemon
system.daemon for the notification daemon.

Parameters:: daemonType - the type of the daemon.; acknowledge - whether to acknowledge the daemon information
Returns:: daemon information.
Throws:: org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no daemon with the specified type. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.; WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.getDaemon( java.lang.String daemonType, boolean acknowledge)

stopDaemon

Daemon stopDaemon(String daemonType,
                  boolean acknowledge)
                  throws WorkflowException,
                         RemoteException

Stops the specified daemon. See 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.

Parameters:: daemonType - the type of the daemon to be stopped.; acknowledge - whether to acknowledge the stop operation.
Returns:: daemon information.
Throws:: org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no daemon with the specified type. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.; WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.stopDaemon( java.lang.String daemonType, boolean acknowledge)

startDaemon

Daemon startDaemon(String daemonType,
                   boolean acknowledge)
                   throws WorkflowException,
                          RemoteException

Starts the specified daemon. See 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.

Parameters:: daemonType - the type of the daemon to be started.; acknowledge - whether to acknowledge the start operation
Returns:: daemon information.
Throws:: org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no daemon with the specified type. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.; WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.startDaemon( java.lang.String daemonType, boolean acknowledge)

getAllDaemons

List<Daemon> getAllDaemons(boolean acknowledge)
                           throws WorkflowException,
                                  RemoteException

Retrieves a list of all the available daemons.

Parameters:: acknowledge - whether to acknowledge the daemon information
Returns:: a list containing Daemon objects.
Throws:: WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.getAllDaemons( boolean acknowledge)

getAuditTrailHealthReport

AuditTrailHealthReport getAuditTrailHealthReport()
                                                 throws WorkflowException,
                                                        RemoteException

Determines key indicators of audit trail health.

Returns:: A status report indicating some important indicators of audit trail health.
Throws:: WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.getAuditTrailHealthReport( )

getAuditTrailHealthReport

AuditTrailHealthReport getAuditTrailHealthReport(boolean countOnly)
                                                 throws WorkflowException,
                                                        RemoteException

Determines key indicators of audit trail health.

Parameters:: 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.
Returns:: A status report indicating some important indicators of audit trail health.
Throws:: WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.getAuditTrailHealthReport( boolean countOnly)

recoverRuntimeEnvironment

void recoverRuntimeEnvironment()
                               throws WorkflowException,
                                      RemoteException

Recovers the complete CARNOT runtime environment.Executed in a separate transaction. By default the execution is synchronous. Only if there are non fatal errors (e.g. locking conflicts), for the affected process instances, a successor asynchronous attempt to recover is scheduled.

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.

Throws:: WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.recoverRuntimeEnvironment( )

startProcess

ProcessInstance startProcess(long modelOID,
                             String id,
                             Map data,
                             boolean synchronously)
                             throws WorkflowException,
                                    RemoteException

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.

State changes:

Process state after: active

Parameters:: 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.
Returns:: the ProcessInstance that was started.
Throws:: 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.; WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: AdministrationService.startProcess( long modelOID, java.lang.String id, java.util.Map data, boolean synchronously)

forceCompletion

ActivityInstance forceCompletion(long activityInstanceOID,
                                 Map accessPoints)
                                 throws WorkflowException,
                                        RemoteException

Forces the completion of a non-interactive activity instance. A map of access points maybe provided. This way this method can mimic precisely the behavior of a normal completion of the activity.

State changes:

Activity state before: application, suspended, hibernated
Process state before: active, interrupted
Activity state after: completed
Process state after: State does not change.

Parameters:: 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
Returns:: the completed ActivityInstance.
Throws:: 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.; WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions; RemoteException
See Also:: forceSuspendToDefaultPerformer(long), AdministrationService.forceCompletion( long activityInstanceOID, java.util.Map accessPoints)





forceSuspendToDefaultPerformer
ActivityInstance forceSuspendToDefaultPerformer(long activityInstanceOID)
                                                throws WorkflowException,
                                                       RemoteException

Forces an activity instance to be suspended. It will be added to the worklist of
 the default performer declared for the corresponding activity, and the specified
 activity instance will be set to SUSPENDED state.
 
 State changes:
 
Activity state before: application, suspended, hibernated
 Process state before: active, interrupted
 Activity state after: suspended
 Process state after: State does not change.
 
 





Parameters:
activityInstanceOID - the OID of the activity to be suspended.
Returns:
the ActivityInstance that was
     suspended.
Throws:
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.
WorkflowException - as a wrapper for
         org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
RemoteException
See Also:
forceCompletion(long, Map), 
AdministrationService.forceSuspendToDefaultPerformer(
     long activityInstanceOID)





getUser
User getUser()
             throws WorkflowException,
                    RemoteException

Retrieves information on the current user.






Returns:
the current user.
Throws:
WorkflowException - as a wrapper for
         org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
RemoteException
See Also:
AdministrationService.getUser()





flushCaches
void flushCaches()
                 throws WorkflowException,
                        RemoteException

Flushes all internal caches, effectively returning the engine to a state just like
 after it has started.






Throws:
WorkflowException - as a wrapper for
         org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
RemoteException
See Also:
AdministrationService.flushCaches()





getPermissions
List<Permission> getPermissions()
                                throws WorkflowException,
                                       RemoteException

Retrieves all permissions the current user has on this service plus the global
 permissions.






Returns:
a list of permission ids.
Throws:
WorkflowException - as a wrapper for
         org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
RemoteException
See Also:
AdministrationService.getPermissions()





getProfile
Map<String,?> getProfile(ProfileScope scope)
                         throws WorkflowException,
                                RemoteException

Retrieves the profile for the specified scope.





Parameters:
scope - 
Returns:
the profile.
Throws:
WorkflowException - as a wrapper for
         org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
RemoteException
See Also:
AdministrationService.getProfile(
     org.eclipse.stardust.engine.api.model.ProfileScope scope)





setProfile
void setProfile(ProfileScope scope,
                Map profile)
                throws WorkflowException,
                       RemoteException

Sets the profile for the specified scope.





Parameters:
scope - the scope.
profile - the profile.
Throws:
WorkflowException - as a wrapper for
         org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
RemoteException
See Also:
AdministrationService.setProfile(
     org.eclipse.stardust.engine.api.model.ProfileScope scope, java.util.Map profile)





writeLogEntry
void writeLogEntry(LogType logType,
                   ContextKind contextType,
                   long contextOid,
                   String message,
                   Throwable throwable)
                   throws WorkflowException,
                          RemoteException

Logs an audit trail event of type LogCode.ADMINISTRATION.





Parameters:
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 event
contextOid - Oid of the runtime object (
     only used if context type is set to ProcessInstance or ActivityInstance)
message - any message that should be logged
throwable - any exception (or null) that should be appended to the message
Throws:
ObjectNotFoundException - if there is no runtime object with the specified OID
WorkflowException - as a wrapper for
         org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
RemoteException
See Also:
AdministrationService.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)





createDepartment
Department createDepartment(String id,
                            String name,
                            String description,
                            DepartmentInfo parent,
                            OrganizationInfo organization)
                            throws WorkflowException,
                                   RemoteException

Creates a new department.





Parameters:
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.
Returns:
the created department.
Throws:
DepartmentExistsException - if a department with the same id already exists in the parent scope.
     Instances of DepartmentExistsException
      will be wrapped inside WorkflowException.
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 - 

           - if either the id or the name is null or an empty string or

           - if the organization is null or

           - if the organization does not resolve to an actual organization in the model
           (i.e. resolves to a role or conditional performer) or

           - if the organization is not directly part of the organization to which
             the parent department is assigned (invalid hierarchy).
     Instances of InvalidArgumentException
     will be wrapped inside WorkflowException.
IllegalOperationException - - if the user was
     external authentified
     Instances of IllegalOperationException will be wrapped
     inside WorkflowException.
WorkflowException - as a wrapper for
         org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
RemoteException
See Also:
AdministrationService.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)





getDepartment
Department getDepartment(long oid)
                         throws WorkflowException,
                                RemoteException

Retrieves the department with the given oid.





Parameters:
oid - the unique identifier of the department.
Returns:
the modified department.
Throws:
ObjectNotFoundException - if there is no department with the specified oid.
     Instances of ObjectNotFoundException
      will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for
         org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
RemoteException
See Also:
AdministrationService.getDepartment(long oid)





modifyDepartment
Department modifyDepartment(long oid,
                            String name,
                            String description)
                            throws WorkflowException,
                                   RemoteException

Change the description of a department.





Parameters:
oid - the unique identifier of the department.
name - the new name of the department.
description - the new description.
Returns:
the modified department.
Throws:
ObjectNotFoundException - if there is no department with the specified oid.
     Instances of ObjectNotFoundException
      will be wrapped inside WorkflowException.
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.
WorkflowException - as a wrapper for
         org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
RemoteException
See Also:
AdministrationService.modifyDepartment(
     long oid, java.lang.String name, java.lang.String description)





removeDepartment
void removeDepartment(long oid)
                      throws WorkflowException,
                             RemoteException

Removes the department having the specified oid, all his children and all user grants
 associated with the department.





Parameters:
oid - the unique identifier of the department.
Throws:
ObjectNotFoundException - if there is no department with the specified oid.
     Instances of ObjectNotFoundException
      will be wrapped inside WorkflowException.
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.
WorkflowException - as a wrapper for
         org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
RemoteException
See Also:
AdministrationService.removeDepartment(
     long oid)





getPreferences
Preferences getPreferences(PreferenceScope scope,
                           String moduleId,
                           String preferencesId)
                           throws WorkflowException,
                                  RemoteException

Retrieves preferences from the given scope.





Parameters:
scope - the scope from which the preferences are to be retrieved from
moduleId - the moduleId of the preferences
preferencesId - the id of the preferences
Returns:
a preferences object.
Throws:
PublicException - if scope is null.
     Instances of PublicException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for
         org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
RemoteException
See Also:
AdministrationService.getPreferences(
     org.eclipse.stardust.engine.core.preferences.PreferenceScope scope, java.lang.String
     moduleId, java.lang.String preferencesId)





savePreferences
void savePreferences(Preferences preferences)
                     throws WorkflowException,
                            RemoteException

Saves the changed preferences to the preference store.





Parameters:
preferences - an preferences object to be saved.
Throws:
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user does
     not have the required privilege.
     Instances of AccessForbiddenException
     will be wrapped inside WorkflowException.
InvalidArgumentException - if preferences is null.
     Instances of InvalidArgumentException will be wrapped inside WorkflowException.
InvalidArgumentException - if preferences property preferences is null.
     Instances of InvalidArgumentException will be wrapped inside WorkflowException.
InvalidArgumentException - if preferences property moduleId is null or empty.
     Instances of InvalidArgumentException will be wrapped inside WorkflowException.
InvalidArgumentException - if preferences property preferencesId is null or
     empty.
     Instances of InvalidArgumentException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for
         org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
RemoteException
See Also:
AdministrationService.savePreferences(
     org.eclipse.stardust.engine.core.preferences.Preferences preferences)





savePreferences
void savePreferences(List preferences)
                     throws WorkflowException,
                            RemoteException

Saves a complete list of preferences to the preference store.





Parameters:
preferences - a list of preferences to be saved.
Throws:
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user does
     not have the required privilege.
     Instances of AccessForbiddenException
     will be wrapped inside WorkflowException.
InvalidArgumentException - if preferences is null.
     Instances of InvalidArgumentException will be wrapped inside WorkflowException.
InvalidArgumentException - if preferences property moduleId is null or empty.
     Instances of InvalidArgumentException will be wrapped inside WorkflowException.
InvalidArgumentException - if preferences property preferencesId is null or
     empty.
     Instances of InvalidArgumentException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for
         org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
RemoteException
See Also:
AdministrationService.savePreferences(
     java.util.List preferences)





getConfigurationVariables
ConfigurationVariables getConfigurationVariables(String modelId)
                                                 throws WorkflowException,
                                                        RemoteException

Retrieves merged configuration variables from all models matching the specified
 modelId (without Password type).
 The contained descriptions and default values are taken from the newest model version
 the configuration variable exists in.





Parameters:
modelId - The modelId of the model(s) to retrieve the configuration variables from.
Returns:
A ConfigurationVariables object containing the merged configuration variables from all
     model versions.
Throws:
InvalidArgumentException - if modelId is null or empty.
     Instances of InvalidArgumentException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for
         org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
RemoteException
See Also:
AdministrationService.getConfigurationVariables(
     java.lang.String modelId)





getConfigurationVariables
ConfigurationVariables getConfigurationVariables(String modelId,
                                                 boolean all)
                                                 throws WorkflowException,
                                                        RemoteException

Retrieves merged configuration variables from all models matching the specified
 modelId.
 The contained descriptions and default values are taken from the newest model version
 the configuration variable exists in.





Parameters:
modelId - The modelId of the model(s) to retrieve the configuration variables from.
all - Indicates if to fetch all configuration variables, including Password type.
Returns:
A ConfigurationVariables object containing the merged configuration variables from all
     model versions.
Throws:
InvalidArgumentException - if modelId is null or empty.
     Instances of InvalidArgumentException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for
         org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
RemoteException
See Also:
AdministrationService.getConfigurationVariables(
     java.lang.String modelId, boolean all)





getConfigurationVariables
List<ConfigurationVariables> getConfigurationVariables(List modelIds)
                                                       throws WorkflowException,
                                                              RemoteException

Retrieves merged configuration variables from all models matching the specified
 modelIds (without Password type).
 The contained descriptions and default values are taken from the newest model version
 the configuration variable exists in.





Parameters:
modelIds - The modelId of the model(s) to retrieve the configuration variables from.
Returns:
A List of ConfigurationVariables objects containing the merged configuration variables
     from all model versions.
Throws:
InvalidArgumentException - if modelIds is null or contains an modelId which is
     null or empty.
     Instances of InvalidArgumentException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for
         org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
RemoteException
See Also:
AdministrationService.getConfigurationVariables(
     java.util.List modelIds)





getConfigurationVariables
ConfigurationVariables getConfigurationVariables(byte[] model)
                                                 throws WorkflowException,
                                                        RemoteException

Retrieves configuration variables from the given model (without Password type).





Parameters:
model - The model xml representation in byte array form.
Returns:
A ConfigurationVariables object containing only the configuration variables from the
     given model.
Throws:
InvalidArgumentException - if model is null.
     Instances of InvalidArgumentException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for
         org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
RemoteException
See Also:
AdministrationService.getConfigurationVariables(
     byte[] model)





saveConfigurationVariables
List<ModelReconfigurationInfo> saveConfigurationVariables(ConfigurationVariables configurationVariables,
                                                          boolean force)
                                                          throws WorkflowException,
                                                                 RemoteException

Saves changes to configuration variables values.





Parameters:
configurationVariables - The configuration variables containing changed values.
force - Option to ignore validation warnings.
Returns:
model reconfiguration information, including possible errors or warnings.
Throws:
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user does
     not have the required privilege.
     Instances of AccessForbiddenException
     will be wrapped inside WorkflowException.
InvalidArgumentException - if configurationVariables is null.
     Instances of InvalidArgumentException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for
         org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
RemoteException
See Also:
AdministrationService.saveConfigurationVariables(
     org.eclipse.stardust.engine.core.preferences.configurationvariables.ConfigurationVariables
     configurationVariables, boolean force)





getGlobalPermissions
RuntimePermissions getGlobalPermissions()
                                        throws WorkflowException,
                                               RemoteException

Retrieves permissions that are globally set. For example permissions concerning
 model deployment, preference saving, modifying AuditTrail, managing deamons ect.






Returns:
the currently set Permissions
Throws:
WorkflowException - as a wrapper for
         org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
RemoteException
See Also:
AdministrationService.getGlobalPermissions()





setGlobalPermissions
void setGlobalPermissions(RuntimePermissions permissions)
                          throws WorkflowException,
                                 RemoteException

Saves the changed Permissions.
 Use 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.





Parameters:
permissions - the modified permissions
Throws:
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user does
     not have the required privilege.
     Instances of AccessForbiddenException
     will be wrapped inside WorkflowException.
InvalidArgumentException - if permissions is null.
     Instances of InvalidArgumentException will be wrapped inside WorkflowException.
ValidationException - if changed grants are not valid in the active model.
     Instances of ValidationException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for
         org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
RemoteException
See Also:
AdministrationService.setGlobalPermissions(
     org.eclipse.stardust.engine.api.runtime.RuntimePermissions permissions)





login
void login(String userId,
           String password)
           throws WorkflowException,
                  RemoteException






Throws:
WorkflowException
RemoteException





login
void login(String userId,
           String password,
           Map properties)
           throws WorkflowException,
                  RemoteException






Throws:
WorkflowException
RemoteException





logout
void logout()
            throws RemoteException






Throws:
RemoteException














  
      Overview 
      Package 
    Class 
      Tree 
      Deprecated 
      Index 
      Help 
  









 PREV CLASS 
 NEXT CLASS

  FRAMES   
 NO FRAMES   
 







  SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD






Copyright © 2014 Eclipse Stardust. All Rights Reserved.

org.eclipse.stardust.engine.api.ejb2 Interface RemoteAdministrationService

setPasswordRules

getPasswordRules

deployModel

overwriteModel

deployModel

overwriteModel

overwriteModel

deployModel

setPrimaryImplementation

deleteModel

deleteProcesses

cleanupRuntime

cleanupRuntimeAndModels

setProcessInstancePriority

setProcessInstancePriority

abortProcessInstance

recoverProcessInstance

recoverProcessInstances

getDaemon

stopDaemon

startDaemon

getAllDaemons

getAuditTrailHealthReport

getAuditTrailHealthReport

recoverRuntimeEnvironment

startProcess

forceCompletion

forceSuspendToDefaultPerformer

getUser

flushCaches

getPermissions

getProfile

setProfile

writeLogEntry

createDepartment

getDepartment

modifyDepartment

removeDepartment

getPreferences

savePreferences

savePreferences

getConfigurationVariables

getConfigurationVariables

getConfigurationVariables

getConfigurationVariables

saveConfigurationVariables

getGlobalPermissions

setGlobalPermissions

login

login

logout

org.eclipse.stardust.engine.api.ejb2
Interface RemoteAdministrationService