org.nuxeo.ecm.directory.sql
Class SQLDirectory

java.lang.Object
  org.nuxeo.ecm.directory.AbstractDirectory
      org.nuxeo.ecm.directory.sql.SQLDirectory

All Implemented Interfaces:

Directory

public class SQLDirectory
extends AbstractDirectory

Constructor Summary

SQLDirectory(SQLDirectoryDescriptor config)

Method Summary

SQLDirectoryDescriptor	getConfig()
javax.sql.DataSource	getDataSource()
Dialect	getDialect()
java.lang.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.
java.lang.String	getName() Gets the unique name of the directory, used for registering.
java.lang.String	getParentDirectory() Gets the name of the parent directory.
java.lang.String	getPasswordField() Gets the password field of the schema for this directory.
java.lang.String	getSchema() Gets the schema name used by this directory.
java.util.Map<java.lang.String,Field>	getSchemaFieldMap()
Session	getSession() Creates a session for accessing entries in this directory.
java.util.List<java.lang.String>	getStoredFieldNames()
Table	getTable()
void	shutdown() Shuts down the directory.

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

addReference, addReferences, getCache, getFieldMapper, getReference, getReferences, invalidateCaches, invalidateDirectoryCache, isReference, orderEntries

Methods inherited from class java.lang.Object

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

Constructor Detail

SQLDirectory

public SQLDirectory(SQLDirectoryDescriptor config)
             throws ClientException

Throws:

ClientException

Method Detail

getConfig

public SQLDirectoryDescriptor getConfig()

getDataSource

public javax.sql.DataSource getDataSource()
                                   throws DirectoryException

Throws:

DirectoryException

getIdGenerator

public IdGenerator getIdGenerator()

Description copied from interface: Directory

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

Returns:

an ID Generator object

getName

public java.lang.String getName()

Description copied from interface: Directory

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

Returns:

the unique directory name

getSchema

public java.lang.String getSchema()

Description copied from interface: Directory

Gets the schema name used by this directory.

Returns:

the schema name

getParentDirectory

public java.lang.String getParentDirectory()

Description copied from interface: Directory

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

Returns:

the name of the parent directory, or null.

getIdField

public java.lang.String getIdField()

Description copied from interface: Directory

Gets the id field of the schema for this directory.

Returns:

the id field.

getPasswordField

public java.lang.String getPasswordField()

Description copied from interface: Directory

Gets the password field of the schema for this directory.

Returns:

the password field.

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

shutdown

public void shutdown()

Description copied from interface: Directory

Shuts down the directory.

getSchemaFieldMap

public java.util.Map<java.lang.String,Field> getSchemaFieldMap()

getStoredFieldNames

public java.util.List<java.lang.String> getStoredFieldNames()

getTable

public Table getTable()

getDialect

public Dialect getDialect()