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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SQLDirectory.TxSessionCleaner

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.logging.Log	log
protected List<Column>	readColumns
protected List<Column>	readColumnsAll
protected String	readColumnsAllSQL
protected String	readColumnsSQL
static String	TENANT_ID_FIELD

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

cache, descriptor, fieldMapper, referenceClass, references, registry, schemaFieldMap, sessionCount, sessionMaxCount, types

Constructor Summary

Constructors

Constructor and Description
SQLDirectory(SQLDirectoryDescriptor descriptor)

Method Summary

Modifier and Type	Method and Description
protected void	addSession(SQLSession session)
protected void	addTableReferences(TableReferenceDescriptor[] tableReferences)
Connection	getConnection()
SQLDirectoryDescriptor	getDescriptor() Get descriptor
Dialect	getDialect()
Session	getSession() Creates a session for accessing entries in this directory.
Table	getTable()
protected boolean	initConnection() Initializes the table.
protected boolean	initConnectionIfNeeded() Lazily initializes the connection.
boolean	isMultiTenant() Returns true if this directory is a multi tenant directory, false otherwise.
protected void	registerInTx(SQLSession session)
String	toString()
boolean	useNativeCase()

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

addInverseReferences, addReference, addReferences, addReferences, addSession, doSanityChecks, fallbackOnDefaultCache, getCache, getDirectoryDeleteConstraints, getFieldMapper, getIdField, getName, getParentDirectory, getPasswordField, getReference, getReferences, getReferences, getSchema, getSchemaFieldMap, getTypes, initSchemaFieldMap, invalidateCaches, invalidateDirectoryCache, isReadOnly, isReference, orderEntries, removeSession, setReadOnly, shutdown

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final org.apache.commons.logging.Log log

TENANT_ID_FIELD

public static final String TENANT_ID_FIELD

See Also:

Constant Field Values

readColumnsAll

protected List<Column> readColumnsAll

readColumns

protected List<Column> readColumns

readColumnsAllSQL

protected String readColumnsAllSQL

readColumnsSQL

protected String readColumnsSQL

Constructor Detail

SQLDirectory

public SQLDirectory(SQLDirectoryDescriptor descriptor)

Method Detail

getDescriptor

public SQLDirectoryDescriptor getDescriptor()

Description copied from interface: Directory

Get descriptor

initConnectionIfNeeded

protected boolean initConnectionIfNeeded()

Lazily initializes the connection.

Returns:

true if CSV data should be loaded

Since:

8.4

initConnection

protected boolean initConnection()

Initializes the table.

Returns:

true if CSV data should be loaded

Since:

6.0

getConnection

public Connection getConnection()
                         throws DirectoryException

Throws:

DirectoryException

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

addSession

protected void addSession(SQLSession session)
                   throws DirectoryException

Throws:

DirectoryException

registerInTx

protected void registerInTx(SQLSession session)
                     throws DirectoryException

Throws:

DirectoryException

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

toString

public String toString()

Overrides:

toString in class Object

addTableReferences

protected void addTableReferences(TableReferenceDescriptor[] tableReferences)