001/* 002 * (C) Copyright 2006-2015 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.api; 022 023import java.util.List; 024 025/** 026 * Interface for the service that manages commandline execution. 027 * 028 * @author tiry 029 */ 030public interface CommandLineExecutorService { 031 032 CommandAvailability getCommandAvailability(String commandName); 033 034 ExecResult execCommand(String commandName, CmdParameters params) throws CommandNotAvailable; 035 036 List<String> getRegistredCommands(); 037 038 List<String> getAvailableCommands(); 039 040 /** 041 * @return a new {@link CmdParameters} pre-filled with commonly used parameters such as the tmp dir. 042 * @since 7.4 043 */ 044 CmdParameters getDefaultCmdParameters(); 045 046}