org.apache.jackrabbit.mongomk.impl.command

Class GetNodesCommand

java.lang.Object

org.apache.jackrabbit.mongomk.impl.command.BaseCommand<Node>

org.apache.jackrabbit.mongomk.impl.command.GetNodesCommand

All Implemented Interfaces:

Command<Node>

public class GetNodesCommand
extends BaseCommand<Node>

Command for MongoMicroKernel#getNodes(String, String, int, long, int, String)

Field Summary

Fields inherited from class org.apache.jackrabbit.mongomk.impl.command.BaseCommand

nodeStore

Constructor Summary

Constructors

Constructor and Description
GetNodesCommand(MongoNodeStore nodeStore, String path, Long revisionId) Constructs a new GetNodesCommandMongo.

Method Summary

Methods

Modifier and Type	Method and Description
Node	execute() Executes the Command and returns its result.
int	getNumOfRetries() Returns the number of retries this Command should be retried in case of an error or false result.
boolean	needsRetry(Exception e) Will be called in case of an Exception during the execution and a given number of retries which has not exceeded.
void	setBranchId(String branchId) Sets the branchId for the command.
void	setDepth(int depth) Sets the depth for the command.

Methods inherited from class org.apache.jackrabbit.mongomk.impl.command.BaseCommand

needsRetry

Methods inherited from class java.lang.Object

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

Constructor Detail

GetNodesCommand

public GetNodesCommand(MongoNodeStore nodeStore,
               String path,
               Long revisionId)

Constructs a new GetNodesCommandMongo.

Parameters:

nodeStore - Node store.

path - The root path of the nodes to get.

revisionId - The revision id or null for head revision.

Method Detail

setBranchId

public void setBranchId(String branchId)

Sets the branchId for the command.

Parameters:

branchId - Branch id.

setDepth

public void setDepth(int depth)

Sets the depth for the command.

Parameters:

depth - The depth for the command or -1 for limitless depth.

execute

public Node execute()
             throws Exception

Description copied from interface: Command

Executes the Command and returns its result.

Returns:

The result.

Throws:

Exception - If an error occurred while executing.

getNumOfRetries

public int getNumOfRetries()

Description copied from interface: Command

Returns the number of retries this Command should be retried in case of an error or false result.

The number of reties is evaluated in the following way:

n < 0: Unlimited retries n = 0: No retries (just one execution) n > 0: Corresponding number of retries

In order to determine whether the Command should be retired on Command.needsRetry(Exception) or Command.needsRetry(Object) will be called.

Specified by:

getNumOfRetries in interface Command<Node>

Overrides:

getNumOfRetries in class BaseCommand<Node>

Returns:

The number of retries.

See Also:

Command.needsRetry(Exception), Command.needsRetry(Object)

needsRetry

public boolean needsRetry(Exception e)

Description copied from interface: Command

Will be called in case of an Exception during the execution and a given number of retries which has not exceeded.

Specified by:

needsRetry in interface Command<Node>

Overrides:

needsRetry in class BaseCommand<Node>

Parameters:

e - The Exception which was thrown.

Returns:

true if a retry should be performed, else false.