com.allanbank.mongodb.error

Class ServerVersionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.allanbank.mongodb.MongoDbException

com.allanbank.mongodb.error.ServerVersionException

All Implemented Interfaces:

Serializable

public class ServerVersionException
extends MongoDbException

ServerVersionException is thrown to report that an attempt was made to send a request to a server that required a more recent version of the server.

See Also:

Serialized Form

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2013, Allanbank Consulting, Inc., All Rights Reserved

Constructor Summary

Constructors

Constructor and Description
ServerVersionException(String operation, VersionRange range, Version actual, Message message) Creates a new ServerVersionException.

Method Summary

Methods

Modifier and Type	Method and Description
Version	getActualVersion() Returns the actual server version.
Version	getMaximumVersion() Returns the maximum (exclusive) server version for the operation.
String	getOperation() Returns the name of the operation.
Version	getRequiredVersion() Returns the required (inclusive) server version for the operation.
Message	getSentMessage() Returns the operation's message.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerVersionException

public ServerVersionException(String operation,
                      VersionRange range,
                      Version actual,
                      Message message)

Creates a new ServerVersionException.

Parameters:

operation - The name of the command/operation.

range - The required server version range for the operation.

actual - The actual version from the server.

message - The operation's message.

Method Detail

getActualVersion

public Version getActualVersion()

Returns the actual server version.

Returns:

The actual server version.

getMaximumVersion

public Version getMaximumVersion()

Returns the maximum (exclusive) server version for the operation.

Returns:

The required server version for the operation.

getOperation

public String getOperation()

Returns the name of the operation.

Returns:

The name of the operation.

getRequiredVersion

public Version getRequiredVersion()

Returns the required (inclusive) server version for the operation.

Returns:

The required server version for the operation.

getSentMessage

public Message getSentMessage()

Returns the operation's message.

Returns:

The operation's message.