Package 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

Method Summary

Modifier and Type	Method	Description
ExecResult	execCommand(String commandName, CmdParameters params)
List<String>	getAvailableCommands()
CommandAvailability	getCommandAvailability(String commandName)
CommandLineDescriptor	getCommandLineDescriptor(String commandName)
CmdParameters	getDefaultCmdParameters()
List<String>	getRegistredCommands()

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()

getDefaultCmdParameters

CmdParameters getDefaultCmdParameters()

Returns:

a new CmdParameters pre-filled with commonly used parameters such as the tmp dir.

Since:

7.4

getCommandLineDescriptor

CommandLineDescriptor getCommandLineDescriptor(String commandName)

Since:

11.4