|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface AdministrationService
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.
| Field Summary | |
|---|---|
static String |
BENCHMARK_DAEMON
The predefined benchmark daemon type- |
static String |
CRITICALITY_DAEMON
The predefined criticality daemon type. |
static String |
EVENT_DAEMON
The predefined event daemon type. |
static String |
SYSTEM_DAEMON
The predefined notification daemon type. |
| 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<Long> piOids)
Deletes process instances from the audit trail. |
void |
deleteRuntimeArtifact(long oid)
Deleted a deployed artifact by oid. |
List<DeploymentInfo> |
deployModel(List<DeploymentElement> 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<String,?> 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<String> 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. |
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<Long> 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> 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<String,?> 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<String,?> 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. |
| Field Detail |
|---|
static final String EVENT_DAEMON
static final String SYSTEM_DAEMON
static final String CRITICALITY_DAEMON
static final String BENCHMARK_DAEMON
| Method Detail |
|---|
@ExecutionPermission(id=modifyAuditTrail) void setPasswordRules(PasswordRules rules)
rules - The rules or null.@ExecutionPermission PasswordRules getPasswordRules()
@ExecutionPermission(id=deployProcessModel)
DeploymentInfo deployModel(String model,
int predecessorOID)
throws DeploymentException
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
@ExecutionPermission(id=deployProcessModel)
DeploymentInfo overwriteModel(String model,
int modelOID)
throws DeploymentException
model - the XML representation of the model to deploy.modelOID - the model to be overwritten.
DeploymentException
@ExecutionPermission(id=deployProcessModel)
DeploymentInfo deployModel(String model,
String configuration,
int predecessorOID,
Date validFrom,
Date validTo,
String comment,
boolean disabled,
boolean ignoreWarnings)
throws DeploymentException
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.
DeploymentException
@ExecutionPermission(id=deployProcessModel)
DeploymentInfo overwriteModel(String model,
String configuration,
int modelOID,
Date validFrom,
Date validTo,
String comment,
boolean disabled,
boolean ignoreWarnings)
throws DeploymentException
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
@ExecutionPermission(id=deployProcessModel)
DeploymentInfo overwriteModel(DeploymentElement deploymentElement,
int modelOID,
DeploymentOptions options)
throws DeploymentException
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.
@ExecutionPermission(id=deployProcessModel)
List<DeploymentInfo> deployModel(List<DeploymentElement> deploymentElements,
DeploymentOptions options)
throws DeploymentException,
org.eclipse.stardust.common.error.ConcurrencyException
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.
org.eclipse.stardust.common.error.InvalidArgumentException - if the deploymentElements argument is null.
org.eclipse.stardust.common.error.ConcurrencyException - if the multiple transactions trying to deploy models at the same time.
@ExecutionPermission(id=deployProcessModel)
DeploymentInfo setPrimaryImplementation(long interfaceModelOid,
String processId,
String implementationModelId,
org.eclipse.stardust.engine.api.runtime.LinkingOptions options)
throws DeploymentException
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.
@ExecutionPermission(id=deployProcessModel)
DeploymentInfo deleteModel(long modelOID)
throws DeploymentException
modelOID - the model to be deleted.
DeploymentException
@ExecutionPermission(id=modifyAuditTrail,
changeable=false)
void deleteProcesses(List<Long> piOids)
throws IllegalOperationException
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.
@ExecutionPermission(id=modifyAuditTrail)
void cleanupRuntime(boolean keepUsers,
boolean keepBO)
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.@ExecutionPermission(id=modifyAuditTrail) void cleanupRuntime(boolean keepUsers)
keepUsers - a flag to specify if the users should be deleted or not.@ExecutionPermission(id=modifyAuditTrail) void cleanupRuntimeAndModels()
@ExecutionPermission(id=modifyProcessInstances,
scope=processDefinition)
ProcessInstance setProcessInstancePriority(long oid,
int priority)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
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.
@ExecutionPermission(id=modifyProcessInstances,
scope=processDefinition)
ProcessInstance setProcessInstancePriority(long oid,
int priority,
boolean propagateToSubProcesses)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
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.
@ExecutionPermission(id=abortProcessInstances,
scope=processDefinition)
ProcessInstance abortProcessInstance(long oid)
throws org.eclipse.stardust.common.error.ObjectNotFoundException,
IllegalOperationException
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.
IllegalOperationException - if the oid references a case process instance.WorkflowService.abortActivityInstance(long)
@ExecutionPermission(id=runRecovery)
ProcessInstance recoverProcessInstance(long oid)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
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.
@ExecutionPermission(id=runRecovery)
void recoverProcessInstances(List<Long> oids)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
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.
@ExecutionPermission(id=manageDaemons)
Daemon getDaemon(String daemonType,
boolean acknowledge)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
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.
@ExecutionPermission(id=manageDaemons)
Daemon stopDaemon(String daemonType,
boolean acknowledge)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
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.
@ExecutionPermission(id=manageDaemons)
Daemon startDaemon(String daemonType,
boolean acknowledge)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
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.
@ExecutionPermission(id=manageDaemons)
List<Daemon> getAllDaemons(boolean acknowledge)
throws org.eclipse.stardust.common.error.AccessForbiddenException
acknowledge - whether to acknowledge the daemon information
org.eclipse.stardust.common.error.AccessForbiddenException@ExecutionPermission(id=readAuditTrailStatistics) AuditTrailHealthReport getAuditTrailHealthReport()
@ExecutionPermission(id=readAuditTrailStatistics) AuditTrailHealthReport getAuditTrailHealthReport(boolean countOnly)
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.
@ExecutionPermission(id=runRecovery) void recoverRuntimeEnvironment()
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.
@ExecutionPermission(id=modifyAuditTrail,
changeable=false)
ProcessInstance startProcess(long modelOID,
String id,
Map<String,?> data,
boolean synchronously)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
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.
@ExecutionPermission(id=performActivity,
changeable=false)
ActivityInstance forceCompletion(long activityInstanceOID,
Map<String,?> accessPoints)
throws org.eclipse.stardust.common.error.ConcurrencyException,
org.eclipse.stardust.common.error.ObjectNotFoundException,
IllegalStateChangeException,
org.eclipse.stardust.common.error.InvalidValueException,
org.eclipse.stardust.common.error.AccessForbiddenException,
IllegalOperationException
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.
org.eclipse.stardust.common.error.ConcurrencyException - if the activity instance is exclusively locked by another thread.
IllegalStateChangeException - if the activity is already completed or aborted.
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.
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user is not an administrator.
IllegalOperationException - if the activity instance is interactive.forceSuspendToDefaultPerformer(long)
@ExecutionPermission(id=forceSuspend)
ActivityInstance forceSuspendToDefaultPerformer(long activityInstanceOID)
throws org.eclipse.stardust.common.error.ObjectNotFoundException,
org.eclipse.stardust.common.error.ConcurrencyException,
IllegalStateChangeException,
org.eclipse.stardust.common.error.AccessForbiddenException
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.
org.eclipse.stardust.common.error.ConcurrencyException - if the activity instance is exclusively locked by another thread.
IllegalStateChangeException - if the activity is already completed or aborted.
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user does not have the required privilege.forceCompletion(long, java.util.Map)@ExecutionPermission User getUser()
@ExecutionPermission(id=controlProcessEngine) void flushCaches()
@ExecutionPermission List<Permission> getPermissions()
@ExecutionPermission Map<String,?> getProfile(ProfileScope scope)
scope -
@ExecutionPermission
void setProfile(ProfileScope scope,
Map<String,?> profile)
scope - the scope.profile - the profile.
@ExecutionPermission(id=modifyAuditTrailStatistics)
void writeLogEntry(LogType logType,
ContextKind contextType,
long contextOid,
String message,
Throwable throwable)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
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
@ExecutionPermission(id=modifyDepartments)
Department createDepartment(String id,
String name,
String description,
DepartmentInfo parent,
OrganizationInfo organization)
throws DepartmentExistsException,
org.eclipse.stardust.common.error.ObjectNotFoundException,
org.eclipse.stardust.common.error.InvalidArgumentException,
IllegalOperationException
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.
org.eclipse.stardust.common.error.ObjectNotFoundException - if either the parent or the organization could not be resolved.
org.eclipse.stardust.common.error.InvalidArgumentException - IllegalOperationException - - if the user was external authentified
@ExecutionPermission(id=readDepartments,
defaults=ALL)
Department getDepartment(long oid)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
oid - the unique identifier of the department.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no department with the specified oid.
@ExecutionPermission(id=modifyDepartments)
Department modifyDepartment(long oid,
String name,
String description)
throws org.eclipse.stardust.common.error.ObjectNotFoundException,
org.eclipse.stardust.common.error.InvalidArgumentException,
IllegalOperationException
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.
org.eclipse.stardust.common.error.InvalidArgumentException - if the name is null or an empty string
IllegalOperationException - - if the user was external authentified
@ExecutionPermission(id=modifyDepartments)
void removeDepartment(long oid)
throws org.eclipse.stardust.common.error.ObjectNotFoundException,
org.eclipse.stardust.common.error.InvalidArgumentException,
IllegalOperationException
oid - the unique identifier of the department.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no department with the specified oid.
org.eclipse.stardust.common.error.InvalidArgumentException - if there are work items currently associated with the department or any child of the department.
IllegalOperationException - - if the user was external authentified
@ExecutionPermission
Preferences getPreferences(PreferenceScope scope,
String moduleId,
String preferencesId)
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.
@ExecutionPermission(id=saveOwnUserScopePreferences,
defaults=ALL)
void savePreferences(Preferences preferences)
throws org.eclipse.stardust.common.error.AccessForbiddenException
preferences - an preferences object to be saved.
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user does not have the required privilege.
org.eclipse.stardust.common.error.InvalidArgumentException - if preferences is null.
org.eclipse.stardust.common.error.InvalidArgumentException - if preferences property preferences is null.
org.eclipse.stardust.common.error.InvalidArgumentException - if preferences property moduleId is null or empty.
org.eclipse.stardust.common.error.InvalidArgumentException - if preferences property preferencesId is null or empty.
@ExecutionPermission(id=saveOwnUserScopePreferences,
defaults=ALL)
void savePreferences(List<Preferences> preferences)
throws org.eclipse.stardust.common.error.AccessForbiddenException
preferences - a list of preferences to be saved.
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user does not have the required privilege.
org.eclipse.stardust.common.error.InvalidArgumentException - if preferences is null.
org.eclipse.stardust.common.error.InvalidArgumentException - if preferences property moduleId is null or empty.
org.eclipse.stardust.common.error.InvalidArgumentException - if preferences property preferencesId is null or empty.@ExecutionPermission ConfigurationVariables getConfigurationVariables(String modelId)
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.
@ExecutionPermission
ConfigurationVariables getConfigurationVariables(String modelId,
boolean all)
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.@ExecutionPermission List<ConfigurationVariables> getConfigurationVariables(List<String> modelIds)
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.@ExecutionPermission ConfigurationVariables getConfigurationVariables(byte[] model)
model - The model xml representation in byte array form.
org.eclipse.stardust.common.error.InvalidArgumentException - if model is null.
@ExecutionPermission(id=saveOwnPartitionScopePreferences)
List<ModelReconfigurationInfo> saveConfigurationVariables(ConfigurationVariables configurationVariables,
boolean force)
throws org.eclipse.stardust.common.error.AccessForbiddenException
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.
org.eclipse.stardust.common.error.InvalidArgumentException - if configurationVariables is null.@ExecutionPermission RuntimePermissions getGlobalPermissions()
@ExecutionPermission(id=saveOwnPartitionScopePreferences)
void setGlobalPermissions(RuntimePermissions permissions)
throws org.eclipse.stardust.common.error.AccessForbiddenException
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.
org.eclipse.stardust.common.error.InvalidArgumentException - if permissions is null.
org.eclipse.stardust.common.error.ValidationException - if changed grants are not valid in the active model.@ExecutionPermission(id=deployRuntimeArtifact) DeployedRuntimeArtifact deployRuntimeArtifact(RuntimeArtifact runtimeArtifact)
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.
@ExecutionPermission(id=deployRuntimeArtifact)
DeployedRuntimeArtifact overwriteRuntimeArtifact(long oid,
RuntimeArtifact runtimeArtifact)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
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.
@ExecutionPermission(id=deployRuntimeArtifact)
void deleteRuntimeArtifact(long oid)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
oid - The oid of the artifact
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no runtime artifact with the specified oid.
@ExecutionPermission(id=readRuntimeArtifact,
defaults=ALL)
RuntimeArtifact getRuntimeArtifact(long oid)
oid - The oid of the artifact.
null if it does not exist.@ExecutionPermission(id=readRuntimeArtifact) List<ArtifactType> getSupportedRuntimeArtifactTypes()
The ArtifactType.getId()
is used to identify the ArtifactType for a
RuntimeArtifact.
@ExecutionPermission(id=modifyAuditTrail)
ProcessInstanceLinkType createProcessInstanceLinkType(String id,
String description)
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.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||