001/*
002 * (C) Copyright 2006-2013 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Nuxeo - initial API and implementation
018 *
019 */
020
021package org.nuxeo.ecm.platform.commandline.executor.service.executors;
022
023import org.nuxeo.ecm.platform.commandline.executor.api.CmdParameters;
024import org.nuxeo.ecm.platform.commandline.executor.api.ExecResult;
025import org.nuxeo.ecm.platform.commandline.executor.service.CommandLineDescriptor;
026import org.nuxeo.ecm.platform.commandline.executor.service.EnvironmentDescriptor;
027
028/**
029 * Interface for class that provide a way to execute a {@link CommandLineDescriptor}.
030 *
031 * @author tiry
032 */
033public interface Executor {
034
035    /**
036     * No exception is thrown but the returned {@link ExecResult} contains everything about the command execution,
037     * including an optional exception.
038     *
039     * @param cmdDesc Command to run. Cannot be null.
040     * @param params Parameters passed to the command. Cannot be null.
041     * @return Result of the execution
042     * @deprecated Since 7.4. Prefer use of {@link #exec(CommandLineDescriptor, CmdParameters, EnvironmentDescriptor)}
043     */
044    @Deprecated
045    ExecResult exec(CommandLineDescriptor cmdDesc, CmdParameters params);
046
047    /**
048     * No exception is thrown but the returned {@link ExecResult} contains everything about the command execution,
049     * including an optional exception.
050     *
051     * @param cmdDesc Command to run. Cannot be null.
052     * @param params Parameters passed to the command. Cannot be null.
053     * @param env Environment context (variable and working directory)
054     * @return Result of the execution
055     * @since 7.4
056     */
057    ExecResult exec(CommandLineDescriptor cmdDesc, CmdParameters params, EnvironmentDescriptor env);
058
059}