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 025import org.nuxeo.ecm.platform.commandline.executor.service.CommandLineDescriptor; 026 027/** 028 * Interface for the service that manages commandline execution. 029 * 030 * @author tiry 031 */ 032public interface CommandLineExecutorService { 033 034 CommandAvailability getCommandAvailability(String commandName); 035 036 ExecResult execCommand(String commandName, CmdParameters params) throws CommandNotAvailable; 037 038 List<String> getRegistredCommands(); 039 040 List<String> getAvailableCommands(); 041 042 /** 043 * @return a new {@link CmdParameters} pre-filled with commonly used parameters such as the tmp dir. 044 * @since 7.4 045 */ 046 CmdParameters getDefaultCmdParameters(); 047 048 /** @since 11.4 */ 049 CommandLineDescriptor getCommandLineDescriptor(String commandName); 050 051}