org.nuxeo.directory.mongodb

Class MongoDBDirectory

java.lang.Object

org.nuxeo.ecm.directory.AbstractDirectory

org.nuxeo.directory.mongodb.MongoDBDirectory

All Implemented Interfaces:

Directory

public class MongoDBDirectory
extends AbstractDirectory

MongoDB implementation of a Directory

Since:

9.1

Field Summary

Fields

Modifier and Type	Field and Description
protected String	countersCollectionName
protected boolean	initialized

Fields inherited from class org.nuxeo.ecm.directory.AbstractDirectory

cache, descriptor, fieldMapper, referenceClass, references, registry, schemaFieldMap, sessionCount, sessionMaxCount, TENANT_ID_FIELD, types

Constructor Summary

Constructors

Constructor and Description
MongoDBDirectory(MongoDBDirectoryDescriptor descriptor)

Method Summary

Modifier and Type	Method and Description
protected void	addMongoDBReferences(MongoDBReferenceDescriptor[] mongodbReferences)
String	getCountersCollectionName()
MongoDBDirectoryDescriptor	getDescriptor() Get descriptor
Session	getSession() Creates a session for accessing entries in this directory.
protected void	initialize(MongoDBSession session)
protected void	initializeIfNeeded(MongoDBSession session)
boolean	isMultiTenant() Returns true if this directory is a multi tenant directory, false otherwise.
protected void	loadData(Schema schema, Session session)
void	shutdown() Shuts down the directory.

Methods inherited from class org.nuxeo.ecm.directory.AbstractDirectory

addInverseReferences, addReference, addReferences, addReferences, addSession, doSanityChecks, fallbackOnDefaultCache, getCache, getDirectoryDeleteConstraints, getFieldMapper, getIdField, getName, getParentDirectory, getPasswordField, getReference, getReferences, getReferences, getSchema, getSchemaFieldMap, getTypes, initSchemaFieldMap, invalidateCaches, invalidateDirectoryCache, isReadOnly, isReference, orderEntries, removeSession, setReadOnly

Methods inherited from class java.lang.Object

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

Field Detail

countersCollectionName

protected String countersCollectionName

initialized

protected volatile boolean initialized

Constructor Detail

MongoDBDirectory

public MongoDBDirectory(MongoDBDirectoryDescriptor descriptor)

Method Detail

getDescriptor

public MongoDBDirectoryDescriptor getDescriptor()

Description copied from interface: Directory

Get descriptor

getSession

public Session getSession()
                   throws DirectoryException

Description copied from interface: Directory

Creates a session for accessing entries in this directory.

Returns:

a Session object

Throws:

DirectoryException - if a session cannot be created

isMultiTenant

public boolean isMultiTenant()

Description copied from interface: Directory

Returns true if this directory is a multi tenant directory, false otherwise.

Specified by:

isMultiTenant in interface Directory

Overrides:

isMultiTenant in class AbstractDirectory

initializeIfNeeded

protected void initializeIfNeeded(MongoDBSession session)

initialize

protected void initialize(MongoDBSession session)

loadData

protected void loadData(Schema schema,
                        Session session)

addMongoDBReferences

protected void addMongoDBReferences(MongoDBReferenceDescriptor[] mongodbReferences)

getCountersCollectionName

public String getCountersCollectionName()

shutdown

public void shutdown()

Description copied from interface: Directory

Shuts down the directory.

Specified by:

shutdown in interface Directory

Overrides:

shutdown in class AbstractDirectory