org.nuxeo.ecm.directory

Class AbstractDirectory

java.lang.Object

org.nuxeo.ecm.directory.AbstractDirectory

All Implemented Interfaces:

Directory

Direct Known Subclasses:

LDAPDirectory, MemoryDirectory, MultiDirectory, SQLDirectory

public abstract class AbstractDirectory
extends Object
implements Directory

Field Summary

Fields

Modifier and Type	Field and Description
String	name

Method Summary

Methods

Modifier and Type	Method and Description
void	addReference(Reference reference)
void	addReferences(Reference[] references)
void	addSession(Session session)
DirectoryCache	getCache() Gets the cache instance of the directory
DirectoryFieldMapper	getFieldMapper()
Reference	getReference(String referenceFieldName) Lookup a Reference by field name.
Collection<Reference>	getReferences() Lookup all References defined on the directory.
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	isReference(String referenceFieldName)
void	orderEntries(List<DocumentModel> entries, Map<String,String> orderBy) Helper method to order entries.
void	removeSession(Session session)
void	shutdown() Shuts down the directory.

Methods inherited from class java.lang.Object

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

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

getIdField, getName, getParentDirectory, getPasswordField, getSchema, getSession

Field Detail

name

public final String name

Method Detail

invalidateCaches

public void invalidateCaches()
                      throws DirectoryException

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

Throws:

DirectoryException

getFieldMapper

public DirectoryFieldMapper getFieldMapper()

getReference

public Reference getReference(String referenceFieldName)

Description copied from interface: Directory

Lookup a Reference by field name.

Specified by:

getReference in interface Directory

Returns:

the matching reference implementation or null

isReference

public boolean isReference(String referenceFieldName)

addReference

public void addReference(Reference reference)
                  throws ClientException

Throws:

ClientException

addReferences

public void addReferences(Reference[] references)
                   throws ClientException

Throws:

ClientException

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