001/*
002 * (C) Copyright 2006-2015 Nuxeo SA (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl-2.1.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     Nuxeo - initial API and implementation
016 *
017 */
018
019package org.nuxeo.ecm.platform.commandline.executor.api;
020
021import java.util.List;
022
023/**
024 * Interface for the service that manages commandline execution.
025 *
026 * @author tiry
027 */
028public interface CommandLineExecutorService {
029
030    CommandAvailability getCommandAvailability(String commandName);
031
032    ExecResult execCommand(String commandName, CmdParameters params) throws CommandNotAvailable;
033
034    List<String> getRegistredCommands();
035
036    List<String> getAvailableCommands();
037
038    /**
039     * @return a new {@link CmdParameters} pre-filled with commonly used parameters such as the tmp dir.
040     * @since 7.4
041     */
042    CmdParameters getDefaultCmdParameters();
043
044}