com.allanbank.mongodb.client

Class AbstractReplyCallback<F>

java.lang.Object

com.allanbank.mongodb.client.AbstractReplyCallback<F>

Type Parameters:

F - The type for the converted Reply.

All Implemented Interfaces:

Callback<Reply>

Direct Known Subclasses:

ReplyResultCallback

public abstract class AbstractReplyCallback<F>
extends Object
implements Callback<Reply>

Helper class for constructing callbacks that convert a Reply message into a different type of result.

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

2011-2012, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_CODE_FIELD The fields that may contain the error code.
static List<String>	ERROR_MESSAGE_FIELDS The fields that may contain the error message.

Constructor Summary

Constructors

Constructor and Description
AbstractReplyCallback(Callback<F> forwardCallback) Create a new AbstractReplyCallback.

Method Summary

Methods

Modifier and Type	Method and Description
protected MongoDbException	asError(Reply reply) Creates an exception from the Reply.
protected MongoDbException	asError(Reply reply, boolean knownError) Creates an exception from the Reply.
protected MongoDbException	asError(Reply reply, int okValue, int errorNumber, String errorMessage) Creates an exception from the parsed reply fields.
protected String	asString(Element errorMessageElem) Converts the Element to a string.
void	callback(Reply result) Called when the MongoDB operation has completed with the result of the operation.
protected void	checkForError(Reply reply) Checks for a non-flag error in the reply.
protected abstract F	convert(Reply reply) Converts the Reply into the final response type.
void	exception(Throwable thrown) Called when the operation fails due to an exception.
Callback<F>	getForwardCallback() Returns the forwardCallback value.
protected int	toInt(Element element) Converts a NumericElementinto an int value.
protected void	verify(Reply reply) Checks the reply for an error message.

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_CODE_FIELD

public static final String ERROR_CODE_FIELD

The fields that may contain the error code.

See Also:

Constant Field Values

ERROR_MESSAGE_FIELDS

public static final List<String> ERROR_MESSAGE_FIELDS

The fields that may contain the error message.

Constructor Detail

AbstractReplyCallback

public AbstractReplyCallback(Callback<F> forwardCallback)

Create a new AbstractReplyCallback.

Parameters:

forwardCallback - The callback for the converted type.

Method Detail

callback

public void callback(Reply result)

Called when the MongoDB operation has completed with the result of the operation.

Overridden to verify the reply and then convert it to the final result.

Specified by:

callback in interface Callback<Reply>

Parameters:

result - The result of the operation.

See Also:

Callback.callback(V)

exception

public void exception(Throwable thrown)

Called when the operation fails due to an exception.

Overridden to forward the exception to the myForwardCallback.

Specified by:

exception in interface Callback<Reply>

Parameters:

thrown - The thrown exception.

See Also:

Callback.exception(java.lang.Throwable)

getForwardCallback

public Callback<F> getForwardCallback()

Returns the forwardCallback value.

Returns:

the forwardCallback

asError

protected MongoDbException asError(Reply reply)

Creates an exception from the Reply.

Parameters:

reply - The raw reply.

Returns:

The exception created.

asError

protected MongoDbException asError(Reply reply,
                       boolean knownError)

Creates an exception from the Reply.

Parameters:

reply - The raw reply.

knownError - If true then the reply is assumed to be an error reply.

Returns:

The exception created.

asError

protected MongoDbException asError(Reply reply,
                       int okValue,
                       int errorNumber,
                       String errorMessage)

Creates an exception from the parsed reply fields.

Parameters:

reply - The raw reply.

okValue - The 'ok' field.

errorNumber - The 'errno' field.

errorMessage - The 'errmsg' field.

Returns:

The exception created.

asString

protected String asString(Element errorMessageElem)

Converts the Element to a string. If a StringElement the value of the element is returned. In all other cases the toString() result for the element is returned.

Parameters:

errorMessageElem - The element to convert to a string.

Returns:

The Element's string value.

checkForError

protected void checkForError(Reply reply)
                      throws MongoDbException

Checks for a non-flag error in the reply.

Parameters:

reply - The reply to check.

Throws:

MongoDbException - On an error represented in the reply.

convert

protected abstract F convert(Reply reply)
                      throws MongoDbException

Converts the Reply into the final response type.

Parameters:

reply - The reply to convert.

Returns:

The converted reply.

Throws:

MongoDbException - On a failure converting the reply. Generally, the verify(Reply) method should be used to report errors.

toInt

protected int toInt(Element element)

Converts a NumericElementinto an int value. If not a NumericElement then -1 is returned.

Parameters:

element - The element to convert.

Returns:

The element's integer value or -1.

verify

protected void verify(Reply reply)
               throws MongoDbException

Checks the reply for an error message.

Parameters:

reply - The Reply to verify is successful.

Throws:

MongoDbException - On a failure message in the reply.