org.bonitasoft.engine.api.impl

Class CommandAPIImpl

java.lang.Object

org.bonitasoft.engine.api.impl.CommandAPIImpl

All Implemented Interfaces:

CommandAPI

public class CommandAPIImpl
extends Object
implements CommandAPI

Author:

Zhang Bole, Matthieu Chaffotte, Celine Souchet, Emmanuel Duchastenier, Laurent Vaills

Constructor Summary

Constructors

Constructor and Description
CommandAPIImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDependency(String name, byte[] jar)
Serializable	execute(long commandId, Map<String,Serializable> parameters)
Serializable	execute(String commandName, Map<String,Serializable> parameters)
Serializable	executeWithUserTransactions(long commandId, Map<String,Serializable> parameters)
Serializable	executeWithUserTransactions(String commandName, Map<String,Serializable> parameters)
CommandDescriptor	get(long commandId)
List<CommandDescriptor>	getAllCommands(int startIndex, int maxResults, CommandCriterion sort)
CommandDescriptor	getCommand(String commandName)
protected static TenantServiceAccessor	getTenantAccessor()
List<CommandDescriptor>	getUserCommands(int startIndex, int maxResults, CommandCriterion sort)
CommandDescriptor	register(String name, String description, String implementation)
void	removeDependency(String name)
SearchResult<CommandDescriptor>	searchCommands(SearchOptions searchOptions)
void	unregister(long commandId)
void	unregister(String name)
void	unregisterAll()
void	update(long commandId, CommandUpdater updateDescriptor)
void	update(String commandName, CommandUpdater updateDescriptor)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommandAPIImpl

public CommandAPIImpl()

Method Detail

getTenantAccessor

protected static TenantServiceAccessor getTenantAccessor()

addDependency

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

Specified by:

addDependency in interface CommandAPI

Throws:

AlreadyExistsException

CreationException

removeDependency

public void removeDependency(String name)
                      throws DependencyNotFoundException,
                             DeletionException

Specified by:

removeDependency in interface CommandAPI

Throws:

DependencyNotFoundException

DeletionException

register

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

Specified by:

register in interface CommandAPI

Throws:

AlreadyExistsException

CreationException

execute

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

Specified by:

execute in interface CommandAPI

Throws:

CommandNotFoundException

CommandParameterizationException

CommandExecutionException

execute

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

Specified by:

execute in interface CommandAPI

Throws:

CommandNotFoundException

CommandParameterizationException

CommandExecutionException

executeWithUserTransactions

public Serializable executeWithUserTransactions(String commandName,
                                       Map<String,Serializable> parameters)
                                         throws CommandNotFoundException,
                                                CommandParameterizationException,
                                                CommandExecutionException

Specified by:

executeWithUserTransactions in interface CommandAPI

Throws:

CommandNotFoundException

CommandParameterizationException

CommandExecutionException

executeWithUserTransactions

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

Specified by:

executeWithUserTransactions in interface CommandAPI

Throws:

CommandNotFoundException

CommandParameterizationException

CommandExecutionException

unregister

public void unregister(long commandId)
                throws CommandNotFoundException,
                       DeletionException

Specified by:

unregister in interface CommandAPI

Throws:

CommandNotFoundException

DeletionException

unregister

public void unregister(String name)
                throws CommandNotFoundException,
                       DeletionException

Specified by:

unregister in interface CommandAPI

Throws:

CommandNotFoundException

DeletionException

unregisterAll

public void unregisterAll()
                   throws DeletionException

Specified by:

unregisterAll in interface CommandAPI

Throws:

DeletionException

get

public CommandDescriptor get(long commandId)
                      throws CommandNotFoundException

Specified by:

get in interface CommandAPI

Throws:

CommandNotFoundException

getCommand

public CommandDescriptor getCommand(String commandName)
                             throws CommandNotFoundException

Specified by:

getCommand in interface CommandAPI

Throws:

CommandNotFoundException

getAllCommands

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

Specified by:

getAllCommands in interface CommandAPI

update

public void update(long commandId,
          CommandUpdater updateDescriptor)
            throws UpdateException

Specified by:

update in interface CommandAPI

Throws:

UpdateException

update

public void update(String commandName,
          CommandUpdater updateDescriptor)
            throws UpdateException

Specified by:

update in interface CommandAPI

Throws:

UpdateException

getUserCommands

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

Specified by:

getUserCommands in interface CommandAPI

searchCommands

public SearchResult<CommandDescriptor> searchCommands(SearchOptions searchOptions)
                                               throws SearchException

Specified by:

searchCommands in interface CommandAPI

Throws:

SearchException