org.nuxeo.ecm.platform.commandline.executor.api

Interface CommandLineExecutorService

All Known Implementing Classes:

CommandLineExecutorComponent

public interface CommandLineExecutorService

Interface for the service that manages commandline execution.

Author:

tiry

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	VALID_PARAMETER_PATTERN
static Pattern	VALID_PARAMETER_PATTERN_WIN

Method Summary

Methods

Modifier and Type	Method and Description
void	checkParameter(String parameter) Checks if the given parameter is valid to be used in a command.
ExecResult	execCommand(String commandName, CmdParameters params)
List<String>	getAvailableCommands()
CommandAvailability	getCommandAvailability(String commandName)
List<String>	getRegistredCommands()
boolean	isValidParameter(String parameter) Returns true if the given parameter is valid to be used in a command.

Field Detail

VALID_PARAMETER_PATTERN

static final Pattern VALID_PARAMETER_PATTERN

VALID_PARAMETER_PATTERN_WIN

static final Pattern VALID_PARAMETER_PATTERN_WIN

Method Detail

getCommandAvailability

CommandAvailability getCommandAvailability(String commandName)

execCommand

ExecResult execCommand(String commandName,
                     CmdParameters params)
                       throws CommandNotAvailable

Throws:

CommandNotAvailable

getRegistredCommands

List<String> getRegistredCommands()

getAvailableCommands

List<String> getAvailableCommands()

isValidParameter

boolean isValidParameter(String parameter)

Returns true if the given parameter is valid to be used in a command.

Since:

5.7

checkParameter

void checkParameter(String parameter)

Checks if the given parameter is valid to be used in a command.

If not, throws an IllegalArgumentException.

Since:

5.7