org.hibernate.ogm.datastore.mongodb

Class MongoDBProperties

java.lang.Object

org.hibernate.ogm.datastore.mongodb.MongoDBProperties

All Implemented Interfaces:

OgmProperties, DocumentStoreProperties

public final class MongoDBProperties
extends Object
implements DocumentStoreProperties

Properties for configuring the MongoDB datastore via persistence.xml or OgmConfiguration.

Author:

Sanne Grinovero <sanne@hibernate.org> (C) 2012 Red Hat Inc., Gunnar Morling

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASSOCIATION_DOCUMENT_STORAGE Configuration property for specifying how to store association documents.
static String	AUTHENTICATION_MECHANISM Specify the authentication mechanism that MongoDB will use to authenticate the connection.
static String	READ_PREFERENCE Configuration property for setting the read preference.
static String	TIMEOUT The timeout used at the connection to the MongoDB instance.
static String	WRITE_CONCERN Configuration property for defining the acknowledgement of write operations.
static String	WRITE_CONCERN_TYPE Configuration property for setting a custom WriteConcern implementation.

Fields inherited from interface org.hibernate.ogm.datastore.document.cfg.DocumentStoreProperties

ASSOCIATIONS_STORE

Fields inherited from interface org.hibernate.ogm.cfg.OgmProperties

CREATE_DATABASE, DATABASE, DATASTORE_PROVIDER, ERROR_HANDLER, GRID_DIALECT, HOST, OPTION_CONFIGURATOR, PASSWORD, PORT, USERNAME

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

WRITE_CONCERN

public static final String WRITE_CONCERN

Configuration property for defining the acknowledgement of write operations. Supported values are the WriteConcernType enum or the String representations of its constants.

Specify WriteConcernType.CUSTOM in conjunction with WRITE_CONCERN_TYPE to specify a custom WriteConcern implementation.

Defaults to WriteConcernType.ACKNOWLEDGED.

See Also:

WriteConcern, Constant Field Values

WRITE_CONCERN_TYPE

public static final String WRITE_CONCERN_TYPE

Configuration property for setting a custom WriteConcern implementation. Can be given as fully-qualified class name, class-object or instance of the implementation type. If not given as instance, the specified type must have a default (no-args) constructor.

Only takes affect if WRITE_CONCERN is set to WriteConcernType.CUSTOM.

See Also:

Constant Field Values

READ_PREFERENCE

public static final String READ_PREFERENCE

Configuration property for setting the read preference. Supported values are the ReadPreferenceType enum or the String representations of its constants.

Defaults to ReadPreferenceType.PRIMARY.

See Also:

ReadPreference, Constant Field Values

TIMEOUT

public static final String TIMEOUT

The timeout used at the connection to the MongoDB instance. This value is set in milliseconds. Defaults to 5000.

See Also:

Constant Field Values

ASSOCIATION_DOCUMENT_STORAGE

public static final String ASSOCIATION_DOCUMENT_STORAGE

Configuration property for specifying how to store association documents. Only applicable if DocumentStoreProperties.ASSOCIATIONS_STORE is set to AssociationStorageType.ASSOCIATION_DOCUMENT. Supported values are the AssociationDocumentStorageType enum or the String representations of its constants. Defaults to AssociationDocumentStorageType.GLOBAL_COLLECTION.

See Also:

Constant Field Values

AUTHENTICATION_MECHANISM

public static final String AUTHENTICATION_MECHANISM

Specify the authentication mechanism that MongoDB will use to authenticate the connection. Possible values are listed in AuthenticationMechanismType. BEST (default) will handshake with the server to find the best authentication mechanism.

See Also:

MongoCredential, Constant Field Values