Package 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	Description
protected Map<String,CommandLineDescriptor>	commandDescriptors
static final String	DEFAULT_EXECUTOR
static final String	DEFAULT_TESTER
protected EnvironmentDescriptor	env
protected Map<String,EnvironmentDescriptor>	envDescriptors
static final String	EP_CMD
static final String	EP_CMDTESTER
static final String	EP_ENV
protected Map<String,Executor>	executors
protected Map<String,CommandTester>	testers
protected boolean	useTimeout

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

lastModified, name

Constructor Summary

Constructors

Constructor	Description
CommandLineExecutorComponent()

Method Summary

Modifier and Type	Method	Description
void	activate(ComponentContext context)	Activates the component.
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)	Deprecated. since 11.4, use instance method getCommandLineDescriptor(java.lang.String) instead
CommandLineDescriptor	getCommandLineDescriptor(String commandName)
CmdParameters	getDefaultCmdParameters()
List<String>	getRegistredCommands()
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	start(ComponentContext context)	Start the component.
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

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

addRuntimeMessage, addRuntimeMessage, getAdapter, getDescriptor, getDescriptors, getLastModified, getRegistry, register, registerExtension, setLastModified, setModifiedNow, setName, stop, unregister, unregisterExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Component

getApplicationStartedOrder

Field Details

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

commandDescriptors

protected Map<String,CommandLineDescriptor> commandDescriptors

env

protected EnvironmentDescriptor env

envDescriptors

protected Map<String,EnvironmentDescriptor> envDescriptors

testers

protected Map<String,CommandTester> testers

executors

protected Map<String,Executor> executors

useTimeout

protected boolean useTimeout

Constructor Details

CommandLineExecutorComponent

public CommandLineExecutorComponent()

Method Details

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

start

public void start(ComponentContext context)

Description copied from interface: Component

Start the component. This method is called after all the components were resolved and activated

Specified by:

start in interface Component

Overrides:

start in class DefaultComponent

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

getCommandLineDescriptor

public CommandLineDescriptor getCommandLineDescriptor(String commandName)

Specified by:

getCommandLineDescriptor in interface CommandLineExecutorService

getCommandDescriptor

@Deprecated
public static CommandLineDescriptor getCommandDescriptor(String commandName)

Deprecated.

since 11.4, use instance method getCommandLineDescriptor(java.lang.String) instead

getDefaultCmdParameters

public CmdParameters getDefaultCmdParameters()

Specified by:

getDefaultCmdParameters in interface CommandLineExecutorService

Returns:

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