org.apache.jackrabbit.mongomk.impl.command

Class BaseCommand<T>

java.lang.Object

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

Type Parameters:

T - The result type of the Command.

All Implemented Interfaces:

Command<T>

Direct Known Subclasses:

CommitCommand, CommitCommandNew, DiffCommand, GetBlobLengthCommandGridFS, GetHeadRevisionCommand, GetJournalCommand, GetNodesCommand, GetNodesCommandNew, GetRevisionHistoryCommand, MergeCommand, NodeExistsCommand, OneLevelDiffCommand, ReadBlobCommandGridFS, WaitForCommitCommand, WriteBlobCommandGridFS

public abstract class BaseCommand<T>
extends Object
implements Command<T>

Base Command implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected MongoNodeStore	nodeStore

Constructor Summary

Constructors

Constructor and Description
BaseCommand() Constructs a base command.
BaseCommand(MongoNodeStore nodeStore) Constructs a base command with a mongo connection.

Method Summary

Methods

Modifier and Type	Method and Description
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.
boolean	needsRetry(T result) Will be called in case of a successful execution and a given number of retries which has not exceeded.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jackrabbit.mongomk.api.command.Command

execute

Field Detail

nodeStore

protected MongoNodeStore nodeStore

Constructor Detail

BaseCommand

public BaseCommand()

Constructs a base command.

BaseCommand

public BaseCommand(MongoNodeStore nodeStore)

Constructs a base command with a mongo connection.

Parameters:

nodeStore - Node store.

Method Detail

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<T>

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<T>

Parameters:

e - The Exception which was thrown.

Returns:

true if a retry should be performed, else false.

needsRetry

public boolean needsRetry(T result)

Description copied from interface: Command

Will be called in case of a successful execution and a given number of retries which has not exceeded.

This gives the implementor a chance to retry a false result.

Specified by:

needsRetry in interface Command<T>

Parameters:

result - The result of the execution.

Returns:

true if a retry should be performed, else false.