org.nuxeo.ecm.platform.commandline.executor.service

Class CommandLineExecutorComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.commandline.executor.service.CommandLineExecutorComponent

All Implemented Interfaces:

CommandLineExecutorService, Adaptable, Component, Extensible, TimestampedService

public class CommandLineExecutorComponent
extends DefaultComponent
implements CommandLineExecutorService

POJO implementation of the CommandLineExecutorService interface. Also handles the Extension Point logic.

Author:

tiry

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_EXECUTOR
static String	DEFAULT_TESTER
static String	EP_CMD
static String	EP_CMDTESTER
static String	EP_ENV

Fields inherited from interface org.nuxeo.ecm.platform.commandline.executor.api.CommandLineExecutorService

VALID_PARAMETER_PATTERN, VALID_PARAMETER_PATTERN_WIN

Constructor Summary

Constructors

Constructor and Description
CommandLineExecutorComponent()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(ComponentContext context) Activates the component.
void	checkParameter(String parameter) Checks if the given parameter is valid to be used in a command.
void	deactivate(ComponentContext context) Deactivates the component.
ExecResult	execCommand(String commandName, CmdParameters params)
List<String>	getAvailableCommands()
CommandAvailability	getCommandAvailability(String commandName)
static CommandLineDescriptor	getCommandDescriptor(String commandName)
List<String>	getRegistredCommands()
boolean	isValidParameter(String parameter) Returns true if the given parameter is valid to be used in a command.
static boolean	isWindows()
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

applicationStarted, getAdapter, getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, unregisterExtension

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EP_ENV

public static final String EP_ENV

See Also:

Constant Field Values

EP_CMD

public static final String EP_CMD

See Also:

Constant Field Values

EP_CMDTESTER

public static final String EP_CMDTESTER

See Also:

Constant Field Values

DEFAULT_TESTER

public static final String DEFAULT_TESTER

See Also:

Constant Field Values

DEFAULT_EXECUTOR

public static final String DEFAULT_EXECUTOR

See Also:

Constant Field Values

Constructor Detail

CommandLineExecutorComponent

public CommandLineExecutorComponent()

Method Detail

activate

public void activate(ComponentContext context)

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

deactivate

public void deactivate(ComponentContext context)

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

registerContribution

public void registerContribution(Object contribution,
                        String extensionPoint,
                        ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

unregisterContribution

public void unregisterContribution(Object contribution,
                          String extensionPoint,
                          ComponentInstance contributor)

Overrides:

unregisterContribution in class DefaultComponent

execCommand

public ExecResult execCommand(String commandName,
                     CmdParameters params)
                       throws CommandNotAvailable

Specified by:

execCommand in interface CommandLineExecutorService

Throws:

CommandNotAvailable

getCommandAvailability

public CommandAvailability getCommandAvailability(String commandName)

Specified by:

getCommandAvailability in interface CommandLineExecutorService

getRegistredCommands

public List<String> getRegistredCommands()

Specified by:

getRegistredCommands in interface CommandLineExecutorService

getAvailableCommands

public List<String> getAvailableCommands()

Specified by:

getAvailableCommands in interface CommandLineExecutorService

isWindows

public static boolean isWindows()

isValidParameter

public boolean isValidParameter(String parameter)

Description copied from interface: CommandLineExecutorService

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

Specified by:

isValidParameter in interface CommandLineExecutorService

checkParameter

public void checkParameter(String parameter)

Description copied from interface: CommandLineExecutorService

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

If not, throws an IllegalArgumentException.

Specified by:

checkParameter in interface CommandLineExecutorService

getCommandDescriptor

public static CommandLineDescriptor getCommandDescriptor(String commandName)