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; 022import java.util.regex.Pattern; 023 024/** 025 * Interface for the service that manages commandline execution. 026 * 027 * @author tiry 028 */ 029public interface CommandLineExecutorService { 030 031 Pattern VALID_PARAMETER_PATTERN = Pattern.compile("[\\p{L}_0-9-.%:=/\\\\ ]+"); 032 033 Pattern VALID_PARAMETER_PATTERN_WIN = Pattern.compile("[\\p{L}_0-9-.%~:=/\\\\ ()]+"); 034 035 CommandAvailability getCommandAvailability(String commandName); 036 037 ExecResult execCommand(String commandName, CmdParameters params) throws CommandNotAvailable; 038 039 List<String> getRegistredCommands(); 040 041 List<String> getAvailableCommands(); 042 043 /** 044 * Returns true if the given {@code parameter} is valid to be used in a command. 045 * 046 * @since 5.7 047 */ 048 boolean isValidParameter(String parameter); 049 050 /** 051 * Checks if the given {@code parameter} is valid to be used in a command. 052 * <p> 053 * If not, throws an {@code IllegalArgumentException}. 054 * 055 * @since 5.7 056 */ 057 void checkParameter(String parameter); 058 059 /** 060 * @return a new {@link CmdParameters} pre-filled with commonly used parameters such as the tmp dir. 061 * @since 7.4 062 */ 063 CmdParameters getDefaultCmdParameters(); 064 065}