org.nuxeo.ecm.directory

Class AbstractDirectory

java.lang.Object

org.nuxeo.ecm.directory.AbstractDirectory

All Implemented Interfaces:

Directory

Direct Known Subclasses:

CoreDirectory, LDAPDirectory, MemoryDirectory, MultiDirectory, SQLDirectory

public abstract class AbstractDirectory
extends Object
implements Directory

Field Summary

Fields

Modifier and Type	Field and Description
protected DirectoryCache	cache
BaseDirectoryDescriptor	descriptor
protected DirectoryFieldMapper	fieldMapper
protected Map<String,List<Reference>>	references
protected com.codahale.metrics.MetricRegistry	registry
protected com.codahale.metrics.Counter	sessionCount
protected com.codahale.metrics.Counter	sessionMaxCount

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDirectory(BaseDirectoryDescriptor descriptor)

Method Summary

Modifier and Type	Method and Description
void	addReference(Reference reference)
void	addReferences(Reference[] refs)
void	addSession(Session session)
protected boolean	doSanityChecks()
DirectoryCache	getCache() Gets the cache instance of the directory
abstract BaseDirectoryDescriptor	getDescriptor() To be implemented with a more specific return type.
List<DirectoryDeleteConstraint>	getDirectoryDeleteConstraints()
DirectoryFieldMapper	getFieldMapper()
String	getIdField() Gets the id field of the schema for this directory.
String	getName() Gets the unique name of the directory, used for registering.
String	getParentDirectory() Gets the name of the parent directory.
String	getPasswordField() Gets the password field of the schema for this directory.
Reference	getReference(String referenceFieldName) Deprecated.
Collection<Reference>	getReferences() Lookup all References defined on the directory.
List<Reference>	getReferences(String referenceFieldName) Lookup the References by field name.
String	getSchema() Gets the schema name used by this directory.
List<String>	getTypes() since @8.4
void	invalidateCaches() Invalidate my cache and the caches of linked directories by references.
void	invalidateDirectoryCache() Invalidates the cache instance of the directory
boolean	isMultiTenant() Returns true if this directory is a multi tenant directory, false otherwise.
boolean	isReadOnly() Checks if this directory is read-only.
boolean	isReference(String referenceFieldName)
void	orderEntries(List<DocumentModel> entries, Map<String,String> orderBy) Helper method to order entries.
void	removeSession(Session session)
void	setReadOnly(boolean readOnly)
void	shutdown() Shuts down the directory.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.directory.Directory

getSession

Field Detail

descriptor

public final BaseDirectoryDescriptor descriptor

fieldMapper

protected DirectoryFieldMapper fieldMapper

references

protected final Map<String,List<Reference>> references

cache

protected final DirectoryCache cache

registry

protected final com.codahale.metrics.MetricRegistry registry

sessionCount

protected final com.codahale.metrics.Counter sessionCount

sessionMaxCount

protected final com.codahale.metrics.Counter sessionMaxCount

Constructor Detail

AbstractDirectory

protected AbstractDirectory(BaseDirectoryDescriptor descriptor)

Method Detail

doSanityChecks

protected boolean doSanityChecks()

getDescriptor

public abstract BaseDirectoryDescriptor getDescriptor()

To be implemented with a more specific return type.

getName

public String getName()

Description copied from interface: Directory

Gets the unique name of the directory, used for registering.

Specified by:

getName in interface Directory

Returns:

the unique directory name

getSchema

public String getSchema()

Description copied from interface: Directory

Gets the schema name used by this directory.

Specified by:

getSchema in interface Directory

Returns:

the schema name

getParentDirectory

public String getParentDirectory()

Description copied from interface: Directory

Gets the name of the parent directory. This is used for hierarchical vocabularies.

Specified by:

getParentDirectory in interface Directory

Returns:

the name of the parent directory, or null.

getIdField

public String getIdField()

Description copied from interface: Directory

Gets the id field of the schema for this directory.

Specified by:

getIdField in interface Directory

Returns:

the id field.

getPasswordField

public String getPasswordField()

Description copied from interface: Directory

Gets the password field of the schema for this directory.

Specified by:

getPasswordField in interface Directory

Returns:

the password field.

isReadOnly

public boolean isReadOnly()

Description copied from interface: Directory

Checks if this directory is read-only.

Specified by:

isReadOnly in interface Directory

setReadOnly

public void setReadOnly(boolean readOnly)

invalidateCaches

public void invalidateCaches()
                      throws DirectoryException

Invalidate my cache and the caches of linked directories by references.

Throws:

DirectoryException

getFieldMapper

public DirectoryFieldMapper getFieldMapper()

getReference

@Deprecated
public Reference getReference(String referenceFieldName)

Deprecated.

Description copied from interface: Directory

Lookup a Reference by field name.

Specified by:

getReference in interface Directory

Returns:

the matching reference implementation or null

getReferences

public List<Reference> getReferences(String referenceFieldName)

Description copied from interface: Directory

Lookup the References by field name.

Specified by:

getReferences in interface Directory

Returns:

the matching references implementation or null

isReference

public boolean isReference(String referenceFieldName)

addReference

public void addReference(Reference reference)

addReferences

public void addReferences(Reference[] refs)

getReferences

public Collection<Reference> getReferences()

Description copied from interface: Directory

Lookup all References defined on the directory.

Specified by:

getReferences in interface Directory

Returns:

all registered references

orderEntries

public void orderEntries(List<DocumentModel> entries,
                         Map<String,String> orderBy)
                  throws DirectoryException

Helper method to order entries.

Parameters:

entries - the list of entries.

orderBy - an ordered map of field name -> "asc" or "desc".

Throws:

DirectoryException

getCache

public DirectoryCache getCache()

Description copied from interface: Directory

Gets the cache instance of the directory

Specified by:

getCache in interface Directory

Returns:

the cache of the directory

removeSession

public void removeSession(Session session)

addSession

public void addSession(Session session)

invalidateDirectoryCache

public void invalidateDirectoryCache()
                              throws DirectoryException

Description copied from interface: Directory

Invalidates the cache instance of the directory

Specified by:

invalidateDirectoryCache in interface Directory

Throws:

DirectoryException

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

shutdown

public void shutdown()

Description copied from interface: Directory

Shuts down the directory.

Specified by:

shutdown in interface Directory

getTypes

public List<String> getTypes()

since @8.4

Specified by:

getTypes in interface Directory

getDirectoryDeleteConstraints

public List<DirectoryDeleteConstraint> getDirectoryDeleteConstraints()

Specified by:

getDirectoryDeleteConstraints in interface Directory

Since:

8.4