Package com.mongodb

Class MongoException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.mongodb.MongoException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MongoChangeStreamException, MongoClientException, MongoExecutionTimeoutException, MongoGridFSException, MongoIncompatibleDriverException, MongoInternalException, MongoInterruptedException, MongoServerException, MongoSocketException, MongoStalePrimaryException

public class MongoException
extends RuntimeException

Top level Exception for all Exceptions, server-side or client-side, that come from the driver.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RETRYABLE_ERROR_LABEL	The operation is safe to retry, that is, retry without rereading the relevant data or considering the semantics of the operation.
static final String	SYSTEM_OVERLOADED_ERROR_LABEL	Server is overloaded and shedding load.
static final String	TRANSIENT_TRANSACTION_ERROR_LABEL	An error label indicating that the exception can be treated as a transient transaction error.
static final String	UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL	An error label indicating that the exception can be treated as an unknown transaction commit result.

Constructor Summary

Constructors

Constructor	Description
MongoException(int code, String msg)
MongoException(int code, String msg, Throwable t)
MongoException(int code, String msg, org.bson.BsonDocument response)
MongoException(String msg)
MongoException(String msg, Throwable t)

Method Summary

Modifier and Type	Method	Description
void	addLabel(String errorLabel)	Adds the given error label to the exception.
protected void	addLabels(Collection<String> labels)	Add labels.
protected void	addLabels(org.bson.BsonArray labels)	Add labels.
static MongoException	fromThrowable(Throwable t)	Static helper to create or cast a MongoException from a throwable
static MongoException	fromThrowableNonNull(Throwable t)	Static helper to create or cast a MongoException from a throwable
int	getCode()	Gets the exception code
Set<String>	getErrorLabels()	Gets the set of error labels associated with this exception.
boolean	hasErrorLabel(String errorLabel)	Return true if the exception is labelled with the given error label, and false otherwise.
void	removeLabel(String errorLabel)	Removes the given error label from the exception.

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

Field Details

TRANSIENT_TRANSACTION_ERROR_LABEL

public static final String TRANSIENT_TRANSACTION_ERROR_LABEL

An error label indicating that the exception can be treated as a transient transaction error. See the documentation linked below for more information.

Since:

3.8

See Also:

• hasErrorLabel(String)
• Constant Field Values

MongoDB documentation

TransientTransactionError

UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL

public static final String UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL

An error label indicating that the exception can be treated as an unknown transaction commit result. See the documentation linked below for more information.

Since:

3.8

See Also:

• hasErrorLabel(String)
• Constant Field Values

MongoDB documentation

UnknownTransactionCommitResult

SYSTEM_OVERLOADED_ERROR_LABEL

public static final String SYSTEM_OVERLOADED_ERROR_LABEL

Server is overloaded and shedding load. If an application retries explicitly, it should use exponential backoff because the server has indicated overload. This label on its own does not mean that the operation can be safely retried.

Since:

5.12

See Also:

• hasErrorLabel(String)
• MongoClientSettings.Builder.maxAdaptiveRetries(Integer)
• Constant Field Values

MongoDB documentation

overloadAwareServerSelectionEnabled

Since server release

9.0

RETRYABLE_ERROR_LABEL

public static final String RETRYABLE_ERROR_LABEL

The operation is safe to retry, that is, retry without rereading the relevant data or considering the semantics of the operation.

For more information on how transactions affect retries, see the documentation of the "TransientTransactionError", "UnknownTransactionCommitResult" error labels.

Since:

5.12

See Also:

• hasErrorLabel(String)
• MongoClientSettings.Builder.retryWrites(boolean)
• MongoClientSettings.Builder.retryReads(boolean)
• Constant Field Values

Since server release

9.0

Constructor Details

MongoException

public MongoException(String msg)

Parameters:

msg - the message

MongoException

public MongoException(int code,
 String msg)

Parameters:

code - the error code

msg - the message

MongoException

public MongoException(@Nullable
 String msg,
 @Nullable
 Throwable t)

Parameters:

msg - the message

t - the throwable cause

MongoException

public MongoException(int code,
 String msg,
 Throwable t)

Parameters:

code - the error code

msg - the message

t - the throwable cause

MongoException

public MongoException(int code,
 String msg,
 org.bson.BsonDocument response)

Parameters:

code - the error code

msg - the message

response - the response

Since:

4.1

Method Details

fromThrowable

@Nullable
public static MongoException fromThrowable(@Nullable
 Throwable t)

Static helper to create or cast a MongoException from a throwable

Parameters:

t - a throwable, which may be null

Returns:

a MongoException

fromThrowableNonNull

public static MongoException fromThrowableNonNull(Throwable t)

Static helper to create or cast a MongoException from a throwable

Parameters:

t - a throwable, which may not be null

Returns:

a MongoException

Since:

3.7

getCode

public int getCode()

Gets the exception code

Returns:

the error code.

addLabel

public void addLabel(String errorLabel)

Adds the given error label to the exception.

Parameters:

errorLabel - the non-null error label to add to the exception

Since:

3.8

removeLabel

public void removeLabel(String errorLabel)

Removes the given error label from the exception.

Parameters:

errorLabel - the non-null error label to remove from the exception

Since:

3.8

getErrorLabels

public Set<String> getErrorLabels()

Gets the set of error labels associated with this exception.

Returns:

the error labels, which may not be null but may be empty

Since:

3.8

hasErrorLabel

public boolean hasErrorLabel(String errorLabel)

Return true if the exception is labelled with the given error label, and false otherwise.

Parameters:

errorLabel - the non-null error label

Returns:

true if the exception is labelled with the given error label

Since:

3.8

addLabels

protected void addLabels(org.bson.BsonArray labels)

Add labels.

Parameters:

labels - the labels

addLabels

protected void addLabels(Collection<String> labels)

Add labels.

Parameters:

labels - the labels