org.hibernate.ogm.datastore.mongodb.options

Enum WriteConcernType

java.lang.Object

java.lang.Enum<WriteConcernType>

org.hibernate.ogm.datastore.mongodb.options.WriteConcernType

All Implemented Interfaces:

Serializable, Comparable<WriteConcernType>

public enum WriteConcernType
extends Enum<WriteConcernType>

Write concern options for MongoDB. Represents the non-deprecated constants from WriteConcern.

Author:

Davide D'Alto <davide@hibernate.org>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACKNOWLEDGED Write operations that use this write concern will wait for acknowledgement from the primary server before returning.
CUSTOM A custom WriteConcern implementation is specified.
ERRORS_IGNORED Deprecated. This WriteConcern is no longer supported by MongoDB
FSYNCED Exceptions are raised for network issues, and server errors; the write operation waits for the server to flush the data to disk.
JOURNALED Exceptions are raised for network issues, and server errors; the write operation waits for the server to group commit to the journal file on disk.
MAJORITY Exceptions are raised for network issues, and server errors; waits on a majority of servers for the write operation.
REPLICA_ACKNOWLEDGED Exceptions are raised for network issues, and server errors; waits for at least 2 servers for the write operation.
UNACKNOWLEDGED Write operations that use this write concern will return as soon as the message is written to the socket.

Method Summary

Modifier and Type	Method and Description
com.mongodb.WriteConcern	getWriteConcern() Get the write concern
static WriteConcernType	valueOf(String name) Returns the enum constant of this type with the specified name.
static WriteConcernType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ERRORS_IGNORED

@Deprecated
public static final WriteConcernType ERRORS_IGNORED

Deprecated. This WriteConcern is no longer supported by MongoDB

No exceptions are raised, even for network issues. This write concern has been deprecated. There is no replacement for this write concern. The closest would be to use UNACKNOWLEDGED, then catch and ignore any exceptions of type MongoSocketException.

ACKNOWLEDGED

public static final WriteConcernType ACKNOWLEDGED

Write operations that use this write concern will wait for acknowledgement from the primary server before returning. Exceptions are raised for network issues, and server errors.

UNACKNOWLEDGED

public static final WriteConcernType UNACKNOWLEDGED

Write operations that use this write concern will return as soon as the message is written to the socket. Exceptions are raised for network issues, but not server errors.

FSYNCED

public static final WriteConcernType FSYNCED

Exceptions are raised for network issues, and server errors; the write operation waits for the server to flush the data to disk.

JOURNALED

public static final WriteConcernType JOURNALED

Exceptions are raised for network issues, and server errors; the write operation waits for the server to group commit to the journal file on disk.

REPLICA_ACKNOWLEDGED

public static final WriteConcernType REPLICA_ACKNOWLEDGED

Exceptions are raised for network issues, and server errors; waits for at least 2 servers for the write operation.

MAJORITY

public static final WriteConcernType MAJORITY

Exceptions are raised for network issues, and server errors; waits on a majority of servers for the write operation.

CUSTOM

public static final WriteConcernType CUSTOM

A custom WriteConcern implementation is specified.

Method Detail

values

public static WriteConcernType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (WriteConcernType c : WriteConcernType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static WriteConcernType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getWriteConcern

public com.mongodb.WriteConcern getWriteConcern()

Get the write concern

Returns:

the WriteConcern associated with this enum value; null in the case of CUSTOM.