com.mongodb

Class CommandFailureException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.mongodb.MongoException

com.mongodb.CommandFailureException

All Implemented Interfaces:

java.io.Serializable

public class CommandFailureException
extends MongoException

An exception indicating that a command sent to a MongoDB server returned a failure.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.mongodb.MongoException

MongoException.CursorNotFound, MongoException.DuplicateKey, MongoException.Network

Constructor Summary

Constructors

Constructor and Description
CommandFailureException(CommandResult commandResult) Deprecated. for internal use only

Method Summary

Methods

Modifier and Type	Method and Description
CommandResult	getCommandResult() Deprecated. Use either getErrorMessage() or MongoException.getCode() or getServerAddress()
java.lang.String	getErrorMessage() Gets the error message from the command failure, typically from the "errmsg" property of the document returned from the failed command.
ServerAddress	getServerAddress() Gets the address of the server that the command executed on.

Methods inherited from class com.mongodb.MongoException

getCode

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

CommandFailureException

@Deprecated
public CommandFailureException(CommandResult commandResult)

Deprecated. for internal use only

Construct a new instance with the CommandResult from a failed command

Parameters:

commandResult - the result

Method Detail

getServerAddress

public ServerAddress getServerAddress()

Gets the address of the server that the command executed on.

Returns:

the address of the server that the command executed on

Since:

2.13

getErrorMessage

public java.lang.String getErrorMessage()

Gets the error message from the command failure, typically from the "errmsg" property of the document returned from the failed command.

Returns:

the error message

getCommandResult

@Deprecated
public CommandResult getCommandResult()

Deprecated. Use either getErrorMessage() or MongoException.getCode() or getServerAddress()

Gets the command result document.

Returns:

the command result