|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ManagementAPI
Workflow process deployment operations. Individual or grouped deployment of objects relating to the process definition: XPDL file, java class data for hooks, mappers, performer assignments, ....
TxHook
,
Hook
Method Summary | |
---|---|
void |
clearHistory()
Clears the history data (archived data). |
void |
deletePackage(PackageDefinitionUUID pacDefinitionUUID)
Deletes from journal and history : the given package all its processes all instances of these processes. |
java.util.Map<java.lang.String,ProcessDefinition> |
deploy(Deployment deployment)
Deploys the XPDL Workflow giving the deployment object containing the XPDL Workflow Package and optionnally its depending java classes. |
java.util.Map<java.lang.String,ProcessDefinition> |
deploy(java.net.URL xpdlURL,
java.lang.Class<?>[] classes)
Deploys the XPDL Workflow Package and its depending java classes. |
java.util.Map<java.lang.String,ProcessDefinition> |
deployBar(byte[] barFile)
Deploys a package giving the URL of the bar file. |
java.util.Map<java.lang.String,ProcessDefinition> |
deployBar(java.net.URL barFileURL)
Deploys an XPDL workflow package giving the URL of archive file (.bar file) containing the XPDL definition file and optionally the classes to be deployed. |
void |
deployClass(byte[] clazz)
Deploys a class giving its bytes table. |
void |
deployClasses(java.util.Set<byte[]> classes)
Deploys several classes in global class repository giving a set of data classes. |
void |
deployClassesInJar(byte[] classesArchive)
Deploys several classes in global class repository giving an archive containing the classes. |
java.util.Map<java.lang.String,ProcessDefinition> |
deployXpdl(byte[] xpdlFile)
deploys the XPDL Workflow Package giving the byte array of the serialazed XPDL file. |
java.util.Map<java.lang.String,ProcessDefinition> |
deployXpdl(java.net.URL xpdlURL)
Deploys the XPDL Workflow Package giving the URL of the XPDL file. |
java.util.Map<java.lang.String,ProcessDefinition> |
deployZip(byte[] zipFile)
Deploys the XPDL Workflow giving the byte table of the zip archive containing the XPDL Workflow Package and optionnally its depending java classes. |
java.util.Map<java.lang.String,ProcessDefinition> |
deployZip(java.net.URL zipURL)
Deploys the XPDL Workflow giving the URL of the zip archive containing the XPDL Workflow Package and optionally its depending java classes. |
void |
removeClass(java.lang.String className)
Removes a class giving the class name. |
void |
removeClasses(java.lang.String[] classNames)
Removes classes giving there class names. |
void |
replaceClass(java.lang.String className,
byte[] newClazz)
Removes the class with the given className name. |
void |
undeploy(PackageDefinitionUUID packageUUID)
Un-deploys a Workflow package giving the package UUID. |
Method Detail |
---|
java.util.Map<java.lang.String,ProcessDefinition> deployXpdl(java.net.URL xpdlURL) throws DeploymentException
deployXpdl
in interface RemoteManagementAPI
xpdlURL
- the URL of the XPDL file.
ProcessDefinition
objects).
DeploymentException
- BonitaInternalException
- if an other exception occurs.java.util.Map<java.lang.String,ProcessDefinition> deployXpdl(byte[] xpdlFile) throws DeploymentException
deployXpdl
in interface RemoteManagementAPI
xpdlFile
- the byte array of the XPDL file.
ProcessDefinition
objects).
DeploymentException
- BonitaInternalException
- if an other exception occurs.java.util.Map<java.lang.String,ProcessDefinition> deploy(java.net.URL xpdlURL, java.lang.Class<?>[] classes) throws DeploymentException
deploy
in interface RemoteManagementAPI
xpdlURL
- the URL of the XPDL file.classes
- the table of java classes.
ProcessDefinition
objects).
DeploymentException
- BonitaInternalException
- if an other exception occurs.java.util.Map<java.lang.String,ProcessDefinition> deployZip(java.net.URL zipURL) throws DeploymentException
deployZip
in interface RemoteManagementAPI
zipURL
- the URL of the zip file.
ProcessDefinition
objects).
DeploymentException
- BonitaInternalException
- if an other exception occurs.java.util.Map<java.lang.String,ProcessDefinition> deployZip(byte[] zipFile) throws DeploymentException
deployZip
in interface RemoteManagementAPI
zipFile
- the bytes table of the zip file.
ProcessDefinition
objects).
DeploymentException
- BonitaInternalException
- if an other exception occurs.java.util.Map<java.lang.String,ProcessDefinition> deploy(Deployment deployment) throws DeploymentException
deploy
in interface RemoteManagementAPI
deployment
- the deployment object that should contain the XPDL file and the depending classes.
ProcessDefinition
objects).
DeploymentException
- BonitaInternalException
- if an exception occurs.java.util.Map<java.lang.String,ProcessDefinition> deployBar(java.net.URL barFileURL) throws DeploymentException
deployBar
in interface RemoteManagementAPI
barFileURL
- the URL of the bar file.
ProcessDefinition
objects).
java.lang.IllegalArgumentException
- if the barFileURL is null parameter.
DeploymentException
- BonitaInternalException
- if an other exception occurs.java.util.Map<java.lang.String,ProcessDefinition> deployBar(byte[] barFile) throws DeploymentException
deployBar
in interface RemoteManagementAPI
barFile
- the file of the barfile.
ProcessDefinition
objects).
java.lang.IllegalArgumentException
- if the barFile is null parameter.
DeploymentException
- BonitaInternalException
- if an other exception occurs.void deployClass(byte[] clazz) throws DeploymentException
deployClass
in interface RemoteManagementAPI
clazz
- the bytes table of the class.
DeploymentException
- if there is already a deployed class with this name.
BonitaInternalException
- if an other exception occurs.void deployClasses(java.util.Set<byte[]> classes) throws DeploymentException
deployClasses
in interface RemoteManagementAPI
classes
- a set of classes. Each class is represented by a bytes table.
java.lang.IllegalArgumentException
- if classes is null parameter.
DeploymentException
- if there is already a deployed class with the name
BonitaInternalException
- if an other exception occurs.void deployClassesInJar(byte[] classesArchive) throws DeploymentException
deployClassesInJar
in interface RemoteManagementAPI
classesArchive
- the archive containing the classes represented by a bytes table.
java.lang.IllegalArgumentException
- if the classes is null parameter.
DeploymentException
- if there is already a deployed class with this name or there's an IOException occurs.
BonitaInternalException
- if an other exception occurs.void undeploy(PackageDefinitionUUID packageUUID) throws DeploymentException
undeploy
in interface RemoteManagementAPI
packageUUID
- the package definition UUID.
This UUID can be retrieved from any DefinitionRecord
(e.g. ProcessDefinition
)
by calling DefinitionRecord.getPackageDefinitionUUID()
java.lang.IllegalStateException
- if the given parameter is null.
DeploymentException
- BonitaInternalException
- if an exception occurs.void removeClass(java.lang.String className) throws DeploymentException
removeClass
in interface RemoteManagementAPI
className
- the name of the class.
DeploymentException
- if there's no class defined in global class repository with this name
or a deployed process is still using this class.
BonitaInternalException
- if an other exception occurs.void removeClasses(java.lang.String[] classNames) throws DeploymentException
removeClasses
in interface RemoteManagementAPI
classNames
- the table of class names.
DeploymentException
- if there's no class defined in global class repository with this name
or a deployed process is still using given classes (deployed into the global class repository).
BonitaInternalException
- if an other exception occurs.void replaceClass(java.lang.String className, byte[] newClazz) throws DeploymentException
replaceClass
in interface RemoteManagementAPI
className
- the class name to be replaced.newClazz
- the bytes table of the new class.
DeploymentException
- if the class to be replaced is not found
into the global class repository.
BonitaInternalException
- if an other exception occurs.void clearHistory()
clearHistory
in interface RemoteManagementAPI
BonitaInternalException
- if an other exception occurs.void deletePackage(PackageDefinitionUUID pacDefinitionUUID) throws PackageNotFoundException, UndeletablePackageException, UndeletableInstanceException
deletePackage
in interface RemoteManagementAPI
pacDefinitionUUID
- UUID of the package to delete
PackageNotFoundException
- if the package can't be found
UndeletablePackageException
- if at least one process instance can't be deleted
UndeletableInstanceException
- if at least one instance of this process can't be deleted
BonitaInternalException
- if an other exception occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |