Package org.bonitasoft.engine.api.impl

Class PlatformCommandAPIImpl

  • All Implemented Interfaces:
    org.bonitasoft.engine.api.PlatformCommandAPI
    public class PlatformCommandAPIImpl
extends java.lang.Object
implements org.bonitasoft.engine.api.PlatformCommandAPI
    Author:
    Matthieu Chaffotte, Zhang Bole, Emmanuel Duchastenier, Celine Souchet

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addDependency​(java.lang.String name, byte[] jar)  
      java.io.Serializable execute​(java.lang.String platformCommandName, java.util.Map<java.lang.String,​java.io.Serializable> parameters)  
      org.bonitasoft.engine.command.CommandDescriptor getCommand​(java.lang.String platformCommandName)  
      java.util.List<org.bonitasoft.engine.command.CommandDescriptor> getCommands​(int startIndex, int maxResults, org.bonitasoft.engine.command.CommandCriterion sort)  
      org.bonitasoft.engine.command.CommandDescriptor register​(java.lang.String name, java.lang.String description, java.lang.String implementation)  
      void removeDependency​(java.lang.String name)  
      void unregister​(java.lang.String platformCommandName)  
      void update​(java.lang.String platformCommandName, org.bonitasoft.engine.command.CommandUpdater updater)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • PlatformCommandAPIImpl

        public PlatformCommandAPIImpl()

    • Method Detail

      • addDependency

        public void addDependency​(java.lang.String name,
                          byte[] jar)
                   throws org.bonitasoft.engine.exception.CreationException
        Specified by:
        addDependency in interface org.bonitasoft.engine.api.PlatformCommandAPI
        Throws:
        org.bonitasoft.engine.exception.CreationException

      • removeDependency

        public void removeDependency​(java.lang.String name)
                      throws org.bonitasoft.engine.command.DependencyNotFoundException,
                             org.bonitasoft.engine.exception.DeletionException
        Specified by:
        removeDependency in interface org.bonitasoft.engine.api.PlatformCommandAPI
        Throws:
        org.bonitasoft.engine.command.DependencyNotFoundException
        org.bonitasoft.engine.exception.DeletionException

      • register

        public org.bonitasoft.engine.command.CommandDescriptor register​(java.lang.String name,
                                                                java.lang.String description,
                                                                java.lang.String implementation)
                                                         throws org.bonitasoft.engine.exception.CreationException
        Specified by:
        register in interface org.bonitasoft.engine.api.PlatformCommandAPI
        Throws:
        org.bonitasoft.engine.exception.CreationException

      • execute

        public java.io.Serializable execute​(java.lang.String platformCommandName,
                                    java.util.Map<java.lang.String,​java.io.Serializable> parameters)
                             throws org.bonitasoft.engine.command.CommandNotFoundException,
                                    org.bonitasoft.engine.command.CommandParameterizationException,
                                    org.bonitasoft.engine.command.CommandExecutionException
        Specified by:
        execute in interface org.bonitasoft.engine.api.PlatformCommandAPI
        Throws:
        org.bonitasoft.engine.command.CommandNotFoundException
        org.bonitasoft.engine.command.CommandParameterizationException
        org.bonitasoft.engine.command.CommandExecutionException

      • unregister

        public void unregister​(java.lang.String platformCommandName)
                throws org.bonitasoft.engine.command.CommandNotFoundException,
                       org.bonitasoft.engine.exception.DeletionException
        Specified by:
        unregister in interface org.bonitasoft.engine.api.PlatformCommandAPI
        Throws:
        org.bonitasoft.engine.command.CommandNotFoundException
        org.bonitasoft.engine.exception.DeletionException

      • getCommand

        public org.bonitasoft.engine.command.CommandDescriptor getCommand​(java.lang.String platformCommandName)
                                                           throws org.bonitasoft.engine.command.CommandNotFoundException
        Specified by:
        getCommand in interface org.bonitasoft.engine.api.PlatformCommandAPI
        Throws:
        org.bonitasoft.engine.command.CommandNotFoundException

      • getCommands

        public java.util.List<org.bonitasoft.engine.command.CommandDescriptor> getCommands​(int startIndex,
                                                                                   int maxResults,
                                                                                   org.bonitasoft.engine.command.CommandCriterion sort)
        Specified by:
        getCommands in interface org.bonitasoft.engine.api.PlatformCommandAPI

      • update

        public void update​(java.lang.String platformCommandName,
                   org.bonitasoft.engine.command.CommandUpdater updater)
            throws org.bonitasoft.engine.exception.UpdateException
        Specified by:
        update in interface org.bonitasoft.engine.api.PlatformCommandAPI
        Throws:
        org.bonitasoft.engine.exception.UpdateException