org.bonitasoft.engine.api

Interface PlatformCommandAPI

public interface PlatformCommandAPI

Author:

Matthieu Chaffotte

Method Summary

Methods

Modifier and Type	Method and Description
void	addDependency(String name, byte[] jar) Adds a dependency to the tenant scope.
Serializable	execute(String name, Map<String,Serializable> parameters) Execute a command according to its name and a list of parameters.
CommandDescriptor	get(String name) Returns the command descriptor
List<CommandDescriptor>	getCommands(int startIndex, int maxResults, CommandCriterion sort) Returns the paginated list of command descriptors according to the sort criterion.
CommandDescriptor	register(String name, String description, String implementation) Adds a command and its descriptor.
void	removeDependency(String name) Remove a dependency to the tenant scope.
void	unregister(String name) Delete a command and its descriptor.
void	update(String name, CommandUpdater updater) Updates a command according to the update descriptor.

Method Detail

addDependency

void addDependency(String name,
                 byte[] jar)
                   throws AlreadyExistsException,
                          CreationException

Adds a dependency to the tenant scope.

Parameters:

name - the dependency name.

jar - the JAR content

Throws:

InvalidSessionException - occurs when the session is not valid

AlreadyExistsException - occurs when the dependency name was already taken by another dependency

CreationException - if a problem occurs when creating the dependency

removeDependency

void removeDependency(String name)
                      throws DependencyNotFoundException,
                             DeletionException

Remove a dependency to the tenant scope.

Parameters:

name - the dependency name.

Throws:

InvalidSessionException - if the current platform session is not valid

DependencyNotFoundException - if no dependency can be found with the provided name

DeletionException - if a problem occurs when deleting the dependency

register

CommandDescriptor register(String name,
                         String description,
                         String implementation)
                           throws AlreadyExistsException,
                                  CreationException

Adds a command and its descriptor.

Parameters:

name - the command name

description - the command description

implementation - the implementation class which will be uses when executing the command.

Returns:

the descriptor of the command

Throws:

InvalidSessionException - occurs when the session is not valid

AlreadyExistsException - occurs when the command name was already taken by another command

CreationException - if a problem occurs when registering the command

execute

Serializable execute(String name,
                   Map<String,Serializable> parameters)
                     throws CommandNotFoundException,
                            CommandParameterizationException,
                            CommandExecutionException

Execute a command according to its name and a list of parameters.

Parameters:

name - the command name

parameters - the parameters (specific to the command to execute)

Returns:

the result of the command execution.

Throws:

InvalidSessionException - occurs when the session is not valid

CommandNotFoundException - occurs when the name does not refer to any existing command

CommandParameterizationException - when command parameters are not correct

CommandExecutionException - occurs when an exception is thrown during command execution

unregister

void unregister(String name)
                throws CommandNotFoundException,
                       DeletionException

Delete a command and its descriptor.

Parameters:

name - the command name

Throws:

InvalidSessionException - occurs when the session is not valid

CommandNotFoundException - occurs when the name does not refer to an existing command

DeletionException - occurs when an exception is thrown during command deletion

get

CommandDescriptor get(String name)
                      throws CommandNotFoundException,
                             CreationException

Returns the command descriptor

Parameters:

name - the command name

Returns:

the descriptor of the command

Throws:

InvalidSessionException - occurs when the session is not valid

CommandNotFoundException - occurs when the command name does not refer to an existing command.

CreationException

getCommands

List<CommandDescriptor> getCommands(int startIndex,
                                  int maxResults,
                                  CommandCriterion sort)

Returns the paginated list of command descriptors according to the sort criterion.

Parameters:

startIndex - the start index

maxResults - the number of CommandDescriptor to retrieve

sort - the sorting criterion

Returns:

the paginated list of command descriptors

Throws:

InvalidSessionException - occurs when the session is not valid

update

void update(String name,
          CommandUpdater updater)
            throws CommandNotFoundException,
                   UpdateException

Updates a command according to the update descriptor.

Parameters:

name - the command name

updater - the update descriptor

Throws:

InvalidSessionException - occurs when the session is not valid

CommandNotFoundException - occurs when the name does not refer to any existing command

UpdateException - occurs when an exception is thrown during command update