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 theCommandLineExecutorService
interface. Also handles the Extension Point logic.- Author:
- tiry
-
-
Field Summary
Fields Modifier and Type Field Description protected Map<String,CommandLineDescriptor>
commandDescriptors
static String
DEFAULT_EXECUTOR
static String
DEFAULT_TESTER
protected EnvironmentDescriptor
env
protected Map<String,EnvironmentDescriptor>
envDescriptors
static String
EP_CMD
static String
EP_CMDTESTER
static 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
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 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 methodgetCommandLineDescriptor(java.lang.String)
insteadCommandLineDescriptor
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
applicationStarted, getApplicationStartedOrder
-
-
-
-
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
-
commandDescriptors
protected Map<String,CommandLineDescriptor> commandDescriptors
-
env
protected EnvironmentDescriptor env
-
envDescriptors
protected Map<String,EnvironmentDescriptor> envDescriptors
-
testers
protected Map<String,CommandTester> testers
-
useTimeout
protected boolean useTimeout
-
-
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 interfaceComponent
- Overrides:
activate
in classDefaultComponent
- 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 interfaceComponent
- Overrides:
start
in classDefaultComponent
-
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 interfaceComponent
- Overrides:
deactivate
in classDefaultComponent
- Parameters:
context
- the runtime context
-
registerContribution
public void registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
- Overrides:
registerContribution
in classDefaultComponent
-
unregisterContribution
public void unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
- Overrides:
unregisterContribution
in classDefaultComponent
-
execCommand
public ExecResult execCommand(String commandName, CmdParameters params) throws CommandNotAvailable
- Specified by:
execCommand
in interfaceCommandLineExecutorService
- Throws:
CommandNotAvailable
-
getCommandAvailability
public CommandAvailability getCommandAvailability(String commandName)
- Specified by:
getCommandAvailability
in interfaceCommandLineExecutorService
-
getRegistredCommands
public List<String> getRegistredCommands()
- Specified by:
getRegistredCommands
in interfaceCommandLineExecutorService
-
getAvailableCommands
public List<String> getAvailableCommands()
- Specified by:
getAvailableCommands
in interfaceCommandLineExecutorService
-
getCommandLineDescriptor
public CommandLineDescriptor getCommandLineDescriptor(String commandName)
- Specified by:
getCommandLineDescriptor
in interfaceCommandLineExecutorService
-
getCommandDescriptor
@Deprecated public static CommandLineDescriptor getCommandDescriptor(String commandName)
Deprecated.since 11.4, use instance methodgetCommandLineDescriptor(java.lang.String)
instead
-
getDefaultCmdParameters
public CmdParameters getDefaultCmdParameters()
- Specified by:
getDefaultCmdParameters
in interfaceCommandLineExecutorService
- Returns:
- a new
CmdParameters
pre-filled with commonly used parameters such as the tmp dir.
-
-