org.bonitasoft.engine.command.Command Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bonita-server Show documentation
The newest version!
/**
 * Copyright (C) 2019 Bonitasoft S.A.
 * Bonitasoft, 32 rue Gustave Eiffel - 38000 Grenoble
 * This library is free software; you can redistribute it and/or modify it under the terms
 * of the GNU Lesser General Public License as published by the Free Software Foundation
 * version 2.1 of the License.
 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License along with this
 * program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
 * Floor, Boston, MA 02110-1301, USA.
 **/
package org.bonitasoft.engine.command;

import java.io.Serializable;
import java.util.Map;

import org.bonitasoft.engine.api.CommandAPI;
import org.bonitasoft.engine.service.ServiceAccessor;

/**
 * A command is a class that is called from the API and executed on the server side.

 * It is used to extend the engine behavior. See {@link org.bonitasoft.engine.api.CommandAPI} for explanations of how to
 * deploy, undeploy and execute a command.
 * 

 * This class should not be directly subclassed by implementors: use {@link RuntimeCommand} instead
 *
 * @see org.bonitasoft.engine.api.CommandAPI
 * @see org.bonitasoft.engine.command.RuntimeCommand
 * @author Matthieu Chaffotte
 */
public interface Command {

    /**
     * Method that is called by the engine on the server side when the client calls
     * {@link CommandAPI#execute(String, Map)} with the name or id of this
     * command.
     * Implementors of commands must put here the code to be executed on the server side
     *
     * @param parameters
     *        a map of parameters that can be used by the command and that is given by the client when executing the
     *        command
     * @param serviceAccessor
     *        the ServiceAccessor that provides access to the engine's server-side services
     * @return
     *         a result that will be returned to the client
     * @throws SCommandParameterizationException
     *         can be thrown if insufficient or wrong parameters are given by the client
     * @throws SCommandExecutionException
     *         can be thrown when something unexpected happens while executing the command
     */
    Serializable execute(Map parameters, T serviceAccessor)
            throws SCommandParameterizationException, SCommandExecutionException;

}