org.jboss.dna.graph.commands.executor
Class LoggingCommandExecutor

java.lang.Object
  org.jboss.dna.graph.commands.executor.DelegatingCommandExecutor
      org.jboss.dna.graph.commands.executor.LoggingCommandExecutor

All Implemented Interfaces:

CommandExecutor

public class LoggingCommandExecutor
extends DelegatingCommandExecutor

Author:

Randall Hauch

Constructor Summary

LoggingCommandExecutor(CommandExecutor delegate, Logger logger)
Create a command executor that logs before and after each method call, logging messages at the trace level.

LoggingCommandExecutor(CommandExecutor delegate, Logger logger, Logger.Level level)
Create a command executor that logs before and after each method call, logging messages at the supplied level.

Method Summary

void	close() Close this executor, allowing it to clean up any open resources.
void	execute(CompositeCommand command) Execute a composite command that contains other commands. This method should simply obtain and execute each of the nested commands.
void	execute(CopyBranchCommand command) Execute a command to copy an entire branch to a new location.
void	execute(CopyNodeCommand command) Execute a command to copy a node to a new location.
void	execute(CreateNodeCommand command) Execute a command to create a node and set the node's properties.
void	execute(DeleteBranchCommand command) Execute a command to delete an entire branch.
void	execute(GetChildrenCommand command) Execute a command to get the children of a node.
void	execute(GetNodeCommand command) Execute a command to get the properties and children of a node. GetNodeCommand is a subtype of both GetPropertiesCommand and GetChildrenCommand, so this method will be called in place of the CommandExecutor.execute(GetPropertiesCommand) and CommandExecutor.execute(GetChildrenCommand) methods.
void	execute(GetPropertiesCommand command) Execute a command to get the properties of a node.
void	execute(GraphCommand command) Execute a graph command. This method should examine the command's types to determine which other execute methods should be called, and should then call those methods. This method should also do nothing if the command is null.
void	execute(MoveBranchCommand command) Execute a command to move a branch from one location to another.
void	execute(RecordBranchCommand command) Execute a command to record the structure of a branch.
void	execute(SetPropertiesCommand command) Execute a command to set some (or all) of the properties on a node.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingCommandExecutor

public LoggingCommandExecutor(CommandExecutor delegate,
                              Logger logger)

Create a command executor that logs before and after each method call, logging messages at the trace level.

Parameters:

delegate - the delegate executor

logger - the logger

LoggingCommandExecutor

public LoggingCommandExecutor(CommandExecutor delegate,
                              Logger logger,
                              Logger.Level level)

Create a command executor that logs before and after each method call, logging messages at the supplied level.

Parameters:

delegate - the delegate executor

logger - the logger

level - the logging level, or null if trace-level logging should be used.

Method Detail

close

public void close()

Close this executor, allowing it to clean up any open resources.

Specified by:

close in interface CommandExecutor

Overrides:

close in class DelegatingCommandExecutor

See Also:

DelegatingCommandExecutor.close()

execute

public void execute(CompositeCommand command)
             throws RepositorySourceException

Execute a composite command that contains other commands. This method should simply obtain and execute each of the nested commands.

Specified by:

execute in interface CommandExecutor

Overrides:

execute in class DelegatingCommandExecutor

Parameters:

command - the command to be executed; may not be null

Throws:

RepositorySourceException - if there is an error executing the command

See Also:

DelegatingCommandExecutor.execute(org.jboss.dna.graph.commands.CompositeCommand)

execute

public void execute(CopyBranchCommand command)
             throws RepositorySourceException

Execute a command to copy an entire branch to a new location.

Specified by:

execute in interface CommandExecutor

Overrides:

execute in class DelegatingCommandExecutor

Parameters:

command - the command to be executed; may not be null

Throws:

RepositorySourceException - if there is an error executing the command

See Also:

DelegatingCommandExecutor.execute(org.jboss.dna.graph.commands.CopyBranchCommand)

execute

public void execute(CopyNodeCommand command)
             throws RepositorySourceException

Execute a command to copy a node to a new location.

Specified by:

execute in interface CommandExecutor

Overrides:

execute in class DelegatingCommandExecutor

Parameters:

command - the command to be executed; may not be null

Throws:

RepositorySourceException - if there is an error executing the command

See Also:

DelegatingCommandExecutor.execute(org.jboss.dna.graph.commands.CopyNodeCommand)

execute

public void execute(CreateNodeCommand command)
             throws RepositorySourceException

Execute a command to create a node and set the node's properties.

Specified by:

execute in interface CommandExecutor

Overrides:

execute in class DelegatingCommandExecutor

Parameters:

command - the command to be executed; may not be null

Throws:

RepositorySourceException - if there is an error executing the command

See Also:

DelegatingCommandExecutor.execute(org.jboss.dna.graph.commands.CreateNodeCommand)

execute

public void execute(DeleteBranchCommand command)
             throws RepositorySourceException

Execute a command to delete an entire branch.

Specified by:

execute in interface CommandExecutor

Overrides:

execute in class DelegatingCommandExecutor

Parameters:

command - the command to be executed; may not be null

Throws:

RepositorySourceException - if there is an error executing the command

See Also:

DelegatingCommandExecutor.execute(org.jboss.dna.graph.commands.DeleteBranchCommand)

execute

public void execute(GetChildrenCommand command)
             throws RepositorySourceException

Execute a command to get the children of a node.

Specified by:

execute in interface CommandExecutor

Overrides:

execute in class DelegatingCommandExecutor

Parameters:

command - the command to be executed; may not be null

Throws:

RepositorySourceException - if there is an error executing the command

See Also:

DelegatingCommandExecutor.execute(org.jboss.dna.graph.commands.GetChildrenCommand)

execute

public void execute(GetNodeCommand command)
             throws RepositorySourceException

Execute a command to get the properties and children of a node. GetNodeCommand is a subtype of both GetPropertiesCommand and GetChildrenCommand, so this method will be called in place of the CommandExecutor.execute(GetPropertiesCommand) and CommandExecutor.execute(GetChildrenCommand) methods.

Specified by:

execute in interface CommandExecutor

Overrides:

execute in class DelegatingCommandExecutor

Parameters:

command - the command to be executed; may not be null

Throws:

RepositorySourceException - if there is an error executing the command

See Also:

DelegatingCommandExecutor.execute(org.jboss.dna.graph.commands.GetNodeCommand)

execute

public void execute(GetPropertiesCommand command)
             throws RepositorySourceException

Execute a command to get the properties of a node.

Specified by:

execute in interface CommandExecutor

Overrides:

execute in class DelegatingCommandExecutor

Parameters:

command - the command to be executed; may not be null

Throws:

RepositorySourceException - if there is an error executing the command

See Also:

DelegatingCommandExecutor.execute(org.jboss.dna.graph.commands.GetPropertiesCommand)

execute

public void execute(GraphCommand command)
             throws RepositorySourceException

Execute a graph command. This method should examine the command's types to determine which other execute methods should be called, and should then call those methods. This method should also do nothing if the command is null.

Specified by:

execute in interface CommandExecutor

Overrides:

execute in class DelegatingCommandExecutor

Parameters:

command - the command to be executed

Throws:

RepositorySourceException - if there is an error executing the command

See Also:

DelegatingCommandExecutor.execute(org.jboss.dna.graph.commands.GraphCommand)

execute

public void execute(MoveBranchCommand command)
             throws RepositorySourceException

Execute a command to move a branch from one location to another.

Specified by:

execute in interface CommandExecutor

Overrides:

execute in class DelegatingCommandExecutor

Parameters:

command - the command to be executed; may not be null

Throws:

RepositorySourceException - if there is an error executing the command

See Also:

DelegatingCommandExecutor.execute(org.jboss.dna.graph.commands.MoveBranchCommand)

execute

public void execute(RecordBranchCommand command)
             throws RepositorySourceException

Execute a command to record the structure of a branch.

Specified by:

execute in interface CommandExecutor

Overrides:

execute in class DelegatingCommandExecutor

Parameters:

command - the command to be executed; may not be null

Throws:

RepositorySourceException - if there is an error executing the command

See Also:

DelegatingCommandExecutor.execute(org.jboss.dna.graph.commands.RecordBranchCommand)

execute

public void execute(SetPropertiesCommand command)
             throws RepositorySourceException

Execute a command to set some (or all) of the properties on a node.

Specified by:

execute in interface CommandExecutor

Overrides:

execute in class DelegatingCommandExecutor

Parameters:

command - the command to be executed; may not be null

Throws:

RepositorySourceException - if there is an error executing the command

See Also:

DelegatingCommandExecutor.execute(org.jboss.dna.graph.commands.SetPropertiesCommand)