|
|||||||||
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 classDatas for hooks, mappers, performer assignments, ....
TxHook
Method Summary | |
---|---|
void |
clearHistory()
Clear the history data (archived data). |
java.util.Map<java.lang.String,ProcessDefinition> |
deploy(org.ow2.bonita.deployment.Deployment deployment)
To deploy the XPDL Workflow giving the deployment object containing the XPDL Workflow Package and optionnally its required java classDatas. |
java.util.Map<java.lang.String,ProcessDefinition> |
deploy(java.net.URL xpdlURL,
java.lang.Class<?>[] classes)
To deploy the XPDL Workflow Package and its required java classDatas giving the URL of the XPDL file and the table of classDatas. |
java.util.Map<java.lang.String,ProcessDefinition> |
deployBar(byte[] barFile)
To deploy a package giving the URL of the bar file. |
java.util.Map<java.lang.String,ProcessDefinition> |
deployBar(java.net.URL barFileURL)
To deploy an XPDL workflow package giving the URL of archive file (.bar file) containing the XPDL definition file and optionally the classDatas to be deployed. |
void |
deployClass(byte[] clazz)
To deploy a class giving its bytes table. |
void |
deployClasses(java.lang.Class<?>[] classes)
To deploy several classDatas in global class repository giving a set of classDatas. |
void |
deployClasses(java.util.Set<byte[]> classes)
To deploy several classDatas in global class repository giving a set of classDatas. |
void |
deployClassesInJar(byte[] classesArchive)
To deploy several classDatas in global class repository giving an archive containing the classDatas. |
java.util.Map<java.lang.String,ProcessDefinition> |
deployXpdl(java.net.URL xpdlURL)
To deploy the XPDL Workflow Package giving the URL of the XPDL file. |
java.util.Map<java.lang.String,ProcessDefinition> |
deployZip(byte[] zipFile)
To deploy the XPDL Workflow giving the byte table of the zip archive containing the XPDL Workflow Package and optionnally its required java classDatas. |
java.util.Map<java.lang.String,ProcessDefinition> |
deployZip(java.net.URL zipURL)
To deploy the XPDL Workflow giving the URL of the zip archive containing the XPDL Workflow Package and optionnally its required java classDatas. |
void |
removeClass(java.lang.String className)
To remove a class giving the class name. |
void |
removeClasses(java.lang.String[] classNames)
To remove classDatas giving the class names. |
void |
replaceClass(java.lang.String className,
byte[] newClazz)
Remove the class with the className name. |
void |
undeploy(PackageDefinitionUUID packageUUID)
To undeploy 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 org.ow2.bonita.facade.remote.RemoteManagementAPI
xpdlURL
- the URL of the XPDL file.
ProcessDefinition
objects as values.
DeploymentException
- if deploy error occurred.
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 org.ow2.bonita.facade.remote.RemoteManagementAPI
xpdlURL
- the URL of the XPDL file.classDatas
- the table of java classDatas.
ProcessDefinition
objects as values.
DeploymentException
- if deploy error occurred.
BonitaInternalException
- if an other exception occurs.java.util.Map<java.lang.String,ProcessDefinition> deployZip(java.net.URL zipURL) throws DeploymentException
deployZip
in interface org.ow2.bonita.facade.remote.RemoteManagementAPI
zipURL
- the URL of the zip file.
ProcessDefinition
objects as values.
DeploymentException
- if deploy error occurred.
BonitaInternalException
- if an other exception occurs.java.util.Map<java.lang.String,ProcessDefinition> deployZip(byte[] zipFile) throws DeploymentException
deployZip
in interface org.ow2.bonita.facade.remote.RemoteManagementAPI
zipFile
- the bytes table of the zip file.
ProcessDefinition
objects as values.
DeploymentException
- if deploy error occurred.
BonitaInternalException
- if an other exception occurs.java.util.Map<java.lang.String,ProcessDefinition> deploy(org.ow2.bonita.deployment.Deployment deployment) throws DeploymentException
deploy
in interface org.ow2.bonita.facade.remote.RemoteManagementAPI
deployment
- the deployment object that should contain the xpdl file and the map of required classDatas.
ProcessDefinition
objects as values.
DeploymentException
- if deploy error occurred.
BonitaInternalException
- if an exception occurs.java.util.Map<java.lang.String,ProcessDefinition> deployBar(java.net.URL barFileURL) throws DeploymentException
deployBar
in interface org.ow2.bonita.facade.remote.RemoteManagementAPI
barFileURL
- the URL of the bar file.
ProcessDefinition
objects as values.
java.lang.IllegalArgumentException
- if the barFileURL is null parameter.
DeploymentException
- if an IO exception is thrown.
BonitaInternalException
- if an other exception occurs.java.util.Map<java.lang.String,ProcessDefinition> deployBar(byte[] barFile) throws DeploymentException
deployBar
in interface org.ow2.bonita.facade.remote.RemoteManagementAPI
barFile
- the file of the barfile.
ProcessDefinition
objects as values.
java.lang.IllegalArgumentException
- if the barFile is null parameter.
DeploymentException
- if the archive file is not found.
BonitaInternalException
- if an other exception occurs.void deployClass(byte[] clazz) throws DeploymentException
deployClass
in interface org.ow2.bonita.facade.remote.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 org.ow2.bonita.facade.remote.RemoteManagementAPI
classDatas
- a set of classDatas. Each class is represented by a bytes table.
java.lang.IllegalArgumentException
- if classDatas is null parameter.
DeploymentException
- if there is already a deployed class with the name
BonitaInternalException
- if an other exception occurs.void deployClasses(java.lang.Class<?>[] classes) throws DeploymentException
deployClasses
in interface org.ow2.bonita.facade.remote.RemoteManagementAPI
classDatas
- a table of Class type.
java.lang.IllegalArgumentException
- if the classDatas 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 org.ow2.bonita.facade.remote.RemoteManagementAPI
classesArchive
- the archive containing the classDatas represented by a bytes table.
java.lang.IllegalArgumentException
- if the classDatas 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)
undeploy
in interface org.ow2.bonita.facade.remote.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
BonitaInternalException
- if an exception occurs.void removeClass(java.lang.String className) throws DeploymentException
removeClass
in interface org.ow2.bonita.facade.remote.RemoteManagementAPI
className
- the name of the class.
DeploymentException
- if there's no class defined in global class repository with this name
or a deployed package is still using this class.
BonitaInternalException
- if an other exception occurs.void removeClasses(java.lang.String[] classNames) throws DeploymentException
removeClasses
in interface org.ow2.bonita.facade.remote.RemoteManagementAPI
classNames
- the class names.
DeploymentException
- if there's no class defined in global class repository with this name
or a package is still using global class.
BonitaInternalException
- if an other exception occurs.void replaceClass(java.lang.String className, byte[] newClazz) throws DeploymentException
replaceClass
in interface org.ow2.bonita.facade.remote.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
at global class repository.
BonitaInternalException
- if an other exception occurs.void clearHistory()
clearHistory
in interface org.ow2.bonita.facade.remote.RemoteManagementAPI
BonitaInternalException
- if an other exception occurs.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |