org.bonitasoft.engine.api

Interface PlatformCommandAPI

public interface PlatformCommandAPI

Manipulates a platform command. A command can be registered, unregistered and executed with parameters.
These commands are executed in a platform scope, see CommandAPI for an explanation of how to deploy, execute, ... a command. The only difference between the CommandAPI and the PlatformCommandAPI is that a platform command must extend org.bonitasoft.engine.command.PlatformCommand.

Author:

Matthieu Chaffotte, Emmanuel Duchastenier

See Also:

CommandDescriptor

Method Summary

Methods

Modifier and Type	Method and Description
void	addDependency(String name, byte[] jar) Adds a dependency.
Serializable	execute(String name, Map<String,Serializable> parameters) Executes a command according to its name and the list of parameters.
CommandDescriptor	get(String name) Deprecated. As of release 6.2.1, replaced by getCommand(String) that does not throw CreationException.
CommandDescriptor	getCommand(String commandName) Returns the command descriptor corresponding to the given command name.
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) Removes the dependency.
void	unregister(String name) Deletes 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.

Parameters:

name - the dependency name.

jar - the JAR content

Throws:

InvalidSessionException - occurs when the session is not valid

AlreadyExistsException - occurs when the dependency name is already used for another dependency

CreationException - if a problem occurs when creating the dependency

removeDependency

void removeDependency(String name)
                      throws DependencyNotFoundException,
                             DeletionException

Removes the dependency.

Parameters:

name - the dependency name.

Throws:

InvalidSessionException - if the current platform session is not valid

DependencyNotFoundException - if no dependency can be found with the specified 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 used 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 is already used for another command

CreationException - if a problem occurs when registering the command

execute

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

Executes a command according to its name and the 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

Deletes 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

@Deprecated
CommandDescriptor get(String name)
                      throws CommandNotFoundException,
                             CreationException

Deprecated. As of release 6.2.1, replaced by getCommand(String) that does not throw 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

getCommand

CommandDescriptor getCommand(String commandName)
                             throws CommandNotFoundException

Returns the command descriptor corresponding to the given command name.

Parameters:

commandName - the name of the command

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.

Since:

6.2.1

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 - if 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