org.bonitasoft.engine.api

Interface CommandAPI

public interface CommandAPI

Author:

Matthieu Chaffotte, Yanyan Liu, Celine Souchet

Method Summary

Methods

Modifier and Type	Method and Description
void	addDependency(String name, byte[] jar) Adds a dependency to the tenant scope.
Serializable	execute(long commandId, Map<String,Serializable> parameters) Execute a command according to its id and a map of parameters.
Serializable	execute(String name, Map<String,Serializable> parameters) Execute a command according to its name and a map of parameters.
CommandDescriptor	get(long commandId) Get the command descriptor by its id
List<CommandDescriptor>	getAllCommands(int startIndex, int maxResults, CommandCriterion sort) Returns the paginated list of command descriptors according to the sort criterion.
CommandDescriptor	getCommand(String name) Returns the command descriptor
List<CommandDescriptor>	getUserCommands(int startIndex, int maxResults, CommandCriterion sort) Returns the Commands with System is false
CommandDescriptor	register(String name, String description, String implementation) Create a new command with its provided name, description, implementation.
void	removeDependency(String name) Remove a dependency to the tenant scope.
SearchResult<CommandDescriptor>	searchCommands(SearchOptions searchOptions) Search commands
void	unregister(long commandId) Delete a command through its id.
void	unregister(String name) Delete a command through its name.
void	unregisterAll() Delete all commands
void	update(long commandId, CommandUpdater updater) Updates a command according to the update descriptor.
void	update(String name, CommandUpdater updateDescriptor) 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 - Generic exception thrown if API Session is invalid, e.g session has expired.

AlreadyExistsException - if a dependency with the same name already exists

CreationException - occurs when any other dependency creation problem occurs

Since:

6.0

removeDependency

void removeDependency(String name)
                      throws DependencyNotFoundException,
                             DeletionException

Remove a dependency to the tenant scope.

Parameters:

name - the dependency name.

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

DependencyNotFoundException - occurs when the name does not refer to any existing dependency

DeletionException - occurs when an exception is thrown during dependency deletion

Since:

6.0

register

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

Create a new command with its provided name, description, implementation.

Parameters:

name - the command name

description - the descriptor of the command

implementation - the implementation class which will be uses when executing the command. This class is inside the jar.

Returns:

the descriptor of the newly created command

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

AlreadyExistsException - when a command with the same name already exists

CreationException - when the command registering cannot be fulfilled

Since:

6.0

execute

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

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

Parameters:

name - the command name

parameters - the parameters

Returns:

the result of the command execution.

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

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

Since:

6.0

execute

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

Execute a command according to its id and a map of parameters.

Parameters:

commandId - the command commandId

parameters - the parameters

Returns:

the result of the command execution.

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

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

Since:

6.0

unregister

void unregister(String name)
                throws CommandNotFoundException,
                       DeletionException

Delete a command through its name.

Parameters:

name - the command name

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

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

DeletionException - occurs when an exception is thrown during command deletion

Since:

6.0

getCommand

CommandDescriptor getCommand(String name)
                             throws CommandNotFoundException

Returns the command descriptor

Parameters:

name - the command name

Returns:

the descriptor of the command

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

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

Since:

6.0

getAllCommands

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

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

Parameters:

startIndex - the list start index

maxResults - the number of CommandDescriptor to retrieve

sort - the sorting criterion

Returns:

the paginated list of descriptors of the command

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

Since:

6.0

update

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

Updates a command according to the update descriptor.

Parameters:

name - the command name

updateDescriptor - the update descriptor

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

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

UpdateException - when the update cannot be fulfilled correctly

Since:

6.0

unregisterAll

void unregisterAll()
                   throws DeletionException

Delete all commands

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

CommandDeletionException - occurs when an exception is thrown during command (unregistering) deletion

DeletionException

Since:

6.0

getUserCommands

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

Returns the Commands with System is false

Parameters:

startIndex - The starting index

maxResults - The number of CommandDescriptor

sort - The sorting criterion

Returns:

The list of commands

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

Since:

6.0

get

CommandDescriptor get(long commandId)
                      throws CommandNotFoundException

Get the command descriptor by its id

Parameters:

commandId - identifier of command

Returns:

the descriptor of the command

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

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

Since:

6.0

update

void update(long commandId,
          CommandUpdater updater)
            throws CommandNotFoundException,
                   UpdateException

Updates a command according to the update descriptor.

Parameters:

commandId - identifier of command to indicate which command will be updated

updater - the update descriptor

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

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

CommandUpdateException - occurs when an exception is thrown during command update

UpdateException

Since:

6.0

unregister

void unregister(long commandId)
                throws CommandNotFoundException,
                       DeletionException

Delete a command through its id.

Parameters:

commandId - the identifier of command

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

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

CommandDeletionException - occurs when an exception is thrown during command deletion

DeletionException

Since:

6.0

searchCommands

SearchResult<CommandDescriptor> searchCommands(SearchOptions searchOptions)
                                               throws SearchException

Search commands

Parameters:

searchOptions - The criterion used during the search

Returns:

A SearchResult containing the search result

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

SearchException - when problem occurs during the commands search

Since:

6.0