|
||||||||||
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 Ofor hooks, mappers, performer assignments, ....
TxHook
,
Hook
Method Summary | |
---|---|
void |
addMetaData(java.lang.String key,
java.lang.String value)
Add a meta data. |
void |
deleteAllProcesses()
Deletes from journal and history : all packages and their processes all instances of these processes. |
void |
deleteMetaData(java.lang.String key)
Delete a meta data. |
void |
deleteProcess(ProcessDefinitionUUID processUUID)
Deletes from journal and history : the given package all its processes all instances of these processes. Warning UndeletableProcessException is thrown if at least one process can't be deleted. |
ProcessDefinition |
deploy(BusinessArchive businessArchive)
|
ProcessDefinition |
deployBar(byte[] barContent)
Deploys the businessArchive represented by this byte array. |
ProcessDefinition |
deployBar(java.net.URL barFileURL)
Deploys the business archive represented by the given url. |
void |
deployClass(byte[] clazz)
Deploys a class giving its bytes table. |
void |
deployClasses(java.util.Collection<byte[]> classes)
Deploys several classes in global class repository giving a collection of data classes. |
void |
deployClassesInJar(byte[] classesArchive)
Deploys several classes in global class repository giving an archive containing the classes. |
java.lang.String |
getLoggedUser()
Returns the current logged user |
java.lang.String |
getMetaData(java.lang.String key)
Obtains a meta data. |
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(ProcessDefinitionUUID processUUID)
Un-deploys a Workflow package giving the package UUID. |
Method Detail |
---|
ProcessDefinition deployBar(java.net.URL barFileURL) throws DeploymentException
barFileURL:
- url of bar to deploy
DeploymentException
- if an error occurs while deploying the given Bar
BonitaInternalException
- if an exception occurs.ProcessDefinition deployBar(byte[] barContent) throws DeploymentException
barContent:
- barContent to deploy
DeploymentException
- if an error occurs while deploying the given Bar
BonitaInternalException
- if an exception occurs.ProcessDefinition deploy(BusinessArchive businessArchive) throws DeploymentException
DeploymentException
void deployClass(byte[] clazz) throws DeploymentException
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.Collection<byte[]> classes) throws DeploymentException
classes
- a collection 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
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(ProcessDefinitionUUID processUUID) throws DeploymentException
processUUID
- the process definition UUID.
This UUID can be retrieved from any NamedElement
(e.g. ProcessDefinition
)
by calling org.ow2.bonita.facade.def.majorElement.NamedElement#getProcessDefinitionUUID()
java.lang.IllegalStateException
- if the given parameter is null.
DeploymentException
- BonitaInternalException
- if an exception occurs.void removeClass(java.lang.String className) throws DeploymentException
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
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
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 deleteProcess(ProcessDefinitionUUID processUUID) throws ProcessNotFoundException, UndeletableProcessException, UndeletableInstanceException
pacDefinitionUUID
- UUID of the package to delete
ProcessNotFoundException
- if the package can't be found
UndeletableProcessException
- 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.void deleteAllProcesses() throws UndeletableInstanceException, UndeletableProcessException
UndeletableInstanceException
- if at least one instance of this process can't be deleted
UndeletablePackaException
- if at least one instance of this process can't be deleted
BonitaInternalException
- if an other exception occurs.
UndeletableProcessException
java.lang.String getLoggedUser()
void addMetaData(java.lang.String key, java.lang.String value)
key
- the meta data keyvalue
- the meta data valuejava.lang.String getMetaData(java.lang.String key)
key
- the key of the meta data
void deleteMetaData(java.lang.String key)
key
- the key of the meta data
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |