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

Field Summary

Fields

Modifier and Type	Field and Description
static String	TENANT_ID_FIELD

Constructor Summary

Constructors

Constructor and Description
SQLDirectory(SQLDirectoryDescriptor config)

Method Summary

Methods

Modifier and Type	Method and Description
SQLDirectoryDescriptor	getConfig()
DataSource	getDataSource()
Dialect	getDialect()
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.
String	getSchema() Gets the schema name used by this directory.
Map<String,Field>	getSchemaFieldMap()
Session	getSession() Creates a session for accessing entries in this directory.
List<String>	getStoredFieldNames()
Table	getTable()
boolean	isMultiTenant() Returns true if this directory is a multi tenant directory, false otherwise.
void	shutdown() Shuts down the directory.
boolean	useNativeCase()

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

Field Detail

TENANT_ID_FIELD

public static final String TENANT_ID_FIELD

See Also:

Constant Field Values

Constructor Detail

SQLDirectory

public SQLDirectory(SQLDirectoryDescriptor config)
             throws ClientException

Throws:

ClientException

Method Detail

getConfig

public SQLDirectoryDescriptor getConfig()

getDataSource

public DataSource getDataSource()
                         throws DirectoryException

Throws:

DirectoryException

getName

public String getName()

Description copied from interface: Directory

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

Returns:

the unique directory name

getSchema

public String getSchema()

Description copied from interface: Directory

Gets the schema name used by this 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.

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.

Returns:

the id field.

getPasswordField

public 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 Map<String,Field> getSchemaFieldMap()

getStoredFieldNames

public List<String> getStoredFieldNames()

getTable

public Table getTable()

getDialect

public Dialect getDialect()

useNativeCase

public boolean useNativeCase()

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