org.nuxeo.ecm.directory.sql
Class SQLDirectoryProxy

java.lang.Object
  org.nuxeo.ecm.directory.sql.SQLDirectoryProxy

All Implemented Interfaces:

Directory

public class SQLDirectoryProxy
extends Object
implements Directory

Lazy directory initialization.

Author:

George Lefter

Constructor Summary

SQLDirectoryProxy(SQLDirectoryDescriptor descriptor)

Method Summary

DirectoryCache	getCache() Gets the cache instance of the directory
SQLDirectoryDescriptor	getDescriptor()
SQLDirectory	getDirectory()
String	getIdField() Gets the id field of the schema for this directory.
IdGenerator	getIdGenerator() Gets the ID generator used when creating new entries in 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) Lookup a Reference by field name.
Collection<Reference>	getReferences() Lookup all References defined on the directory.
String	getSchema() Gets the schema name used by this directory.
Session	getSession() Creates a session for accessing entries in this directory.
void	invalidateDirectoryCache() Invalidates the cache instance of the directory
void	shutdown() Shuts down the directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

SQLDirectoryProxy

public SQLDirectoryProxy(SQLDirectoryDescriptor descriptor)

Method Detail

getDirectory

public SQLDirectory getDirectory()
                          throws DirectoryException

Throws:

DirectoryException

getIdGenerator

public IdGenerator getIdGenerator()
                           throws DirectoryException

Description copied from interface: Directory

Gets the ID generator used when creating new entries in this directory.

Specified by:

getIdGenerator in interface Directory

Returns:

an ID Generator object

Throws:

DirectoryException

getName

public String getName()
               throws DirectoryException

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

Throws:

DirectoryException

getSchema

public String getSchema()
                 throws DirectoryException

Description copied from interface: Directory

Gets the schema name used by this directory.

Specified by:

getSchema in interface Directory

Returns:

the schema name

Throws:

DirectoryException

getParentDirectory

public String getParentDirectory()
                          throws DirectoryException

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.

Throws:

DirectoryException

getIdField

public String getIdField()
                  throws DirectoryException

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.

Throws:

DirectoryException

getPasswordField

public String getPasswordField()
                        throws DirectoryException

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.

Throws:

DirectoryException

getSession

public Session getSession()
                   throws DirectoryException

Description copied from interface: Directory

Creates a session for accessing entries in this directory.

Specified by:

getSession in interface Directory

Returns:

a Session object

Throws:

DirectoryException - if a session cannot be created

shutdown

public void shutdown()
              throws DirectoryException

Description copied from interface: Directory

Shuts down the directory.

Specified by:

shutdown in interface Directory

Throws:

DirectoryException

getReference

public Reference getReference(String referenceFieldName)
                       throws DirectoryException

Description copied from interface: Directory

Lookup a Reference by field name.

Specified by:

getReference in interface Directory

Returns:

the matching reference implementation or null

Throws:

DirectoryException

getReferences

public Collection<Reference> getReferences()
                                    throws DirectoryException

Description copied from interface: Directory

Lookup all References defined on the directory.

Specified by:

getReferences in interface Directory

Returns:

all registered references

Throws:

DirectoryException

getDescriptor

public SQLDirectoryDescriptor getDescriptor()

getCache

public DirectoryCache getCache()
                        throws DirectoryException

Description copied from interface: Directory

Gets the cache instance of the directory

Specified by:

getCache in interface Directory

Returns:

the cache of the directory

Throws:

DirectoryException

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