info.magnolia.commands

Class CommandsManager

java.lang.Object

info.magnolia.cms.util.WorkspaceObservingManager

info.magnolia.cms.util.ModuleConfigurationObservingManager

info.magnolia.commands.CommandsManager

@Singleton
public class CommandsManager
extends ModuleConfigurationObservingManager

Manages configured commands and command catalogs and performs execution of commands. Monitors configuration of commands and catalogs in JCR within each module under a node named commands.

See Also:

Catalog, Command

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMAND_DELIM
static String	DEFAULT_CATALOG

Constructor Summary

Constructors

Constructor and Description
CommandsManager(ModuleRegistry moduleRegistry, Node2BeanProcessor nodeToBean, EventBus systemEventBus)
CommandsManager(Node2BeanProcessor nodeToBean) Deprecated. since 5.4.5 use CommandsManager(ModuleRegistry, Node2BeanProcessor, EventBus)

Method Summary

Modifier and Type	Method and Description
void	clear() Deprecated. since 5.4.5. Use ModuleConfigurationObservingManager.onClear() instead.
boolean	executeCommand(Command command, Map<String,Object> params) Executes the given command with the given parameters.
boolean	executeCommand(Command command, Map<String,Object> params, Context context) Executes the given command with given context.
boolean	executeCommand(String commandName, Map<String,Object> params) Executes the given command in the default catalog with the given parameters.
boolean	executeCommand(String catalogName, String commandName, Map<String,Object> params) Executes the given command in the given catalog with the given parameters.
Command	getCommand(String commandName) Use a delimiter to separate the catalog and command name.
Command	getCommand(String catalogName, String commandName) Get the command.
static CommandsManager	getInstance() Deprecated. since 4.5, use IoC !
protected void	onRegister(Content node) Deprecated. since 5.4.5. Use reload(java.util.List) instead.
void	register(Content content) Deprecated. since 5.4.5. Use reload(java.util.List) instead.
protected void	registerCatalog(Content node) Deprecated. since 5.4.5. Use reload(java.util.List) instead.
protected void	registerCatalog(javax.jcr.Node node, Map<String,MgnlCatalog> catalogs)
protected void	registerCatalogs(javax.jcr.Node node, Map<String,MgnlCatalog> catalogs)
void	reload() Deprecated. since 5.4.5. This should not be public but only protected. Use super#reload() instead.
protected void	reload(List<javax.jcr.Node> nodes)

Methods inherited from class info.magnolia.cms.util.ModuleConfigurationObservingManager

getObservedNodes, getObservedPaths, getSession, onClear, onRegister, onStart, registerChangeListener

Methods inherited from class info.magnolia.cms.util.WorkspaceObservingManager

getDelay, getEventTypesMask, getMaxDelay, getNodeTypes, getObservedPath, getReloadMonitor, getWorkspace, instantiateEventListener, isIncludeSubNodes, setDelay, setMaxDelay, start

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CATALOG

public static final String DEFAULT_CATALOG

See Also:

Constant Field Values

COMMAND_DELIM

public static final String COMMAND_DELIM

See Also:

Constant Field Values

Constructor Detail

CommandsManager

@Inject
public CommandsManager(ModuleRegistry moduleRegistry,
                               Node2BeanProcessor nodeToBean,
                               @Named(value="system")
                               EventBus systemEventBus)

CommandsManager

@Deprecated
public CommandsManager(Node2BeanProcessor nodeToBean)

Deprecated. since 5.4.5 use CommandsManager(ModuleRegistry, Node2BeanProcessor, EventBus)

Method Detail

reload

protected void reload(List<javax.jcr.Node> nodes)
               throws javax.jcr.RepositoryException

Overrides:

reload in class ModuleConfigurationObservingManager

Throws:

javax.jcr.RepositoryException

registerCatalogs

protected void registerCatalogs(javax.jcr.Node node,
                                Map<String,MgnlCatalog> catalogs)
                         throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

registerCatalog

protected void registerCatalog(javax.jcr.Node node,
                               Map<String,MgnlCatalog> catalogs)

getCommand

public Command getCommand(String catalogName,
                          String commandName)

Get the command.

Parameters:

catalogName - the catalog containing the command

commandName - the name of the command

Returns:

the command to execute

getCommand

public Command getCommand(String commandName)

Use a delimiter to separate the catalog and command name.

getInstance

@Deprecated
public static CommandsManager getInstance()

Deprecated. since 4.5, use IoC !

Returns:

Returns the instance.

executeCommand

public boolean executeCommand(String catalogName,
                              String commandName,
                              Map<String,Object> params)
                       throws Exception

Executes the given command in the given catalog with the given parameters.

Throws:

Exception - if an error occurs during execution or if the command could not be found in any catalog

executeCommand

public boolean executeCommand(String commandName,
                              Map<String,Object> params)
                       throws Exception

Executes the given command in the default catalog with the given parameters.

Throws:

Exception - if an error occurs during execution or if the command could not be found in any catalog

See Also:

executeCommand(String, String, Map)

executeCommand

public boolean executeCommand(Command command,
                              Map<String,Object> params)
                       throws Exception

Executes the given command with the given parameters.

Throws:

Exception - if an error occurs during execution or if the command could not be found in any catalog

See Also:

executeCommand(String, Map)

executeCommand

public boolean executeCommand(Command command,
                              Map<String,Object> params,
                              Context context)
                       throws Exception

Executes the given command with given context.

Throws:

Exception

See Also:

executeCommand(String, Map)

onRegister

@Deprecated
protected void onRegister(Content node)

Deprecated. since 5.4.5. Use reload(java.util.List) instead.

register

@Deprecated
public void register(Content content)

Deprecated. since 5.4.5. Use reload(java.util.List) instead.

registerCatalog

@Deprecated
protected void registerCatalog(Content node)

Deprecated. since 5.4.5. Use reload(java.util.List) instead.

reload

@Deprecated
public void reload()

Deprecated. since 5.4.5. This should not be public but only protected. Use super#reload() instead.

Overrides:

reload in class ModuleConfigurationObservingManager

clear

@Deprecated
public void clear()

Deprecated. since 5.4.5. Use ModuleConfigurationObservingManager.onClear() instead.