SQLDirectoryDescriptor (Nuxeo ECM Projects 5.8-SNAPSHOT API Documentation)

java.lang.Object
- org.nuxeo.ecm.directory.sql.SQLDirectoryDescriptor

public class SQLDirectoryDescriptor
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SQLDirectoryDescriptor.SubstringMatchType

Nested Classes
Modifier and Type	Class and Description
`static class`	`SQLDirectoryDescriptor.SubstringMatchType`

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`autoincrementIdField`
`int`	`cacheMaxSize`
`int`	`cacheTimeout`
`String`	`createTablePolicy`
`String`	`dataFileCharacterSeparator`
`String`	`dataFileName`
`String`	`dataSourceName`
`String`	`dbDriver`
`String`	`dbPassword`
`String`	`dbUrl`
`String`	`dbUser`
`String`	`idField`
`List<String>`	`initDependencies`
`String`	`name`
`Boolean`	`nativeCase`
`String`	`parentDirectory`
`String`	`passwordHashAlgorithm`
`Boolean`	`readOnly`
`String`	`schemaName`
`SQLDirectoryDescriptor.SubstringMatchType`	`substringMatchType`
`String`	`tableName`

Constructor Summary

Constructors
Constructor and Description

SQLDirectoryDescriptor()

Constructors
Constructor and Description
`SQLDirectoryDescriptor()`

Method Summary

Methods
Modifier and Type	Method and Description
`SQLDirectoryDescriptor`	`clone()`
`int`	`getCacheMaxSize()`
`int`	`getCacheTimeout()`
`String`	`getCreateTablePolicy()`
`char`	`getDataFileCharacterSeparator()`
`String`	`getDataFileName()`
`String`	`getDataSourceName()`
`String`	`getDbDriver()`
`String`	`getDbPassword()`
`String`	`getDbUrl()`
`String`	`getDbUser()`
`String`	`getIdField()`
`Reference[]`	`getInverseReferences()`
`String`	`getName()`
`String`	`getParentDirectory()`
`String`	`getPasswordField()`
`int`	`getQuerySizeLimit()`
`Boolean`	`getReadOnly()`
`boolean`	`getRemove()`
`String`	`getSchemaName()`
`SQLStaticFilter[]`	`getStaticFilters()`
`SQLDirectoryDescriptor.SubstringMatchType`	`getSubstringMatchType()`
`String`	`getTableName()`
`Reference[]`	`getTableReferences()`
`boolean`	`isAutoincrementIdField()`
`boolean`	`isComputeMultiTenantId()` Returns `true` if a multi tenant id should be computed for this directory, if the directory has support for multi tenancy, `false` otherwise.
`void`	`merge(SQLDirectoryDescriptor other)` Merge re-written since 5.6 to comply to hot reload needs, omitting to merge properties initialized by xmap)
`void`	`merge(SQLDirectoryDescriptor other, boolean overwite)`
`void`	`setAutoincrementIdField(boolean autoincrementIdField)`
`void`	`setCreateTablePolicy(String createTablePolicy)`
`void`	`setDataFileName(String dataFile)`
`void`	`setDataSourceName(String dataSourceName)`
`void`	`setDbDriver(String dbDriver)`
`void`	`setDbPassword(String dbPassword)`
`void`	`setDbUrl(String dbUrl)`
`void`	`setDbUser(String dbUser)`
`void`	`setIdField(String idField)`
`void`	`setInverseReferences(InverseReference[] inverseReferences)`
`void`	`setName(String name)`
`void`	`setParentDirectory(String parentDirectory)`
`void`	`setPasswordField(String passwordField)`
`void`	`setQuerySizeLimit(int querySizeLimit)`
`void`	`setReadOnly(Boolean readOnly)`
`void`	`setRemove(boolean delete)`
`void`	`setSchemaName(String schemaName)`
`void`	`setSubstringMatchType(SQLDirectoryDescriptor.SubstringMatchType substringMatchType)`
`void`	`setSubstringMatchType(String substringMatchType)`
`void`	`setTableName(String tableName)`
`void`	`setTableReferences(TableReference[] tableReferences)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name
```
public String name
```

schemaName
```
public String schemaName
```

parentDirectory
```
public String parentDirectory
```

dataSourceName
```
public String dataSourceName
```

dbDriver
```
public String dbDriver
```

dbUrl
```
public String dbUrl
```

dbUser
```
public String dbUser
```

dbPassword
```
public String dbPassword
```

tableName
```
public String tableName
```

initDependencies
```
public List<String> initDependencies
```

idField
```
public String idField
```

dataFileName
```
public String dataFileName
```

dataFileCharacterSeparator

public String dataFileCharacterSeparator

createTablePolicy
```
public String createTablePolicy
```

substringMatchType

public SQLDirectoryDescriptor.SubstringMatchType substringMatchType

autoincrementIdField
```
public boolean autoincrementIdField
```

readOnly
```
public Boolean readOnly
```

passwordHashAlgorithm
```
public String passwordHashAlgorithm
```

cacheTimeout
```
public int cacheTimeout
```

cacheMaxSize
```
public int cacheMaxSize
```

nativeCase
```
public Boolean nativeCase
```

Constructor Detail
- SQLDirectoryDescriptor
```
public SQLDirectoryDescriptor()
```

Method Detail

getDataSourceName
```
public String getDataSourceName()
```

setDataSourceName

public void setDataSourceName(String dataSourceName)

setIdField

public void setIdField(String idField)

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getSchemaName
```
public String getSchemaName()
```

setSchemaName

public void setSchemaName(String schemaName)

getParentDirectory
```
public String getParentDirectory()
```

setParentDirectory

public void setParentDirectory(String parentDirectory)

getTableName
```
public String getTableName()
```

setTableName

public void setTableName(String tableName)

getDbDriver
```
public String getDbDriver()
```

getDbPassword
```
public String getDbPassword()
```

getDbUrl
```
public String getDbUrl()
```

getDbUser
```
public String getDbUser()
```

getDataFileName
```
public String getDataFileName()
```

getDataFileCharacterSeparator

public char getDataFileCharacterSeparator()

getPasswordField
```
public String getPasswordField()
```

setPasswordField

public void setPasswordField(String passwordField)

getIdField
```
public String getIdField()
```

getCreateTablePolicy
```
public String getCreateTablePolicy()
```

setCreateTablePolicy

public void setCreateTablePolicy(String createTablePolicy)
                          throws DirectoryException

Throws:: DirectoryException

setSubstringMatchType

public void setSubstringMatchType(String substringMatchType)

getInverseReferences

public Reference[] getInverseReferences()

getTableReferences

public Reference[] getTableReferences()

getReadOnly
```
public Boolean getReadOnly()
```

setReadOnly

public void setReadOnly(Boolean readOnly)

isAutoincrementIdField

public boolean isAutoincrementIdField()

setAutoincrementIdField

public void setAutoincrementIdField(boolean autoincrementIdField)

setDbDriver

public void setDbDriver(String dbDriver)

setDbPassword

public void setDbPassword(String dbPassword)

setDbUrl
```
public void setDbUrl(String dbUrl)
```

setDbUser
```
public void setDbUser(String dbUser)
```

setInverseReferences

public void setInverseReferences(InverseReference[] inverseReferences)

setDataFileName

public void setDataFileName(String dataFile)

setTableReferences

public void setTableReferences(TableReference[] tableReferences)

getQuerySizeLimit
```
public int getQuerySizeLimit()
```

setQuerySizeLimit

public void setQuerySizeLimit(int querySizeLimit)

setRemove

public void setRemove(boolean delete)

getRemove
```
public boolean getRemove()
```

getCacheTimeout
```
public int getCacheTimeout()
```

getCacheMaxSize
```
public int getCacheMaxSize()
```

getSubstringMatchType

public SQLDirectoryDescriptor.SubstringMatchType getSubstringMatchType()

setSubstringMatchType

public void setSubstringMatchType(SQLDirectoryDescriptor.SubstringMatchType substringMatchType)

getStaticFilters

public SQLStaticFilter[] getStaticFilters()

isComputeMultiTenantId
```
public boolean isComputeMultiTenantId()
```
Returns true if a multi tenant id should be computed for this directory, if the directory has support for multi tenancy, false otherwise.

Since:

5.6

merge
```
public void merge(SQLDirectoryDescriptor other)
```
Merge re-written since 5.6 to comply to hot reload needs, omitting to merge properties initialized by xmap)

merge

public void merge(SQLDirectoryDescriptor other,
         boolean overwite)

clone
```
public SQLDirectoryDescriptor clone()
```
Overrides:

clone in class Object

Class SQLDirectoryDescriptor

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

schemaName

parentDirectory

dataSourceName

dbDriver

dbUrl

dbUser

dbPassword

tableName

initDependencies

idField

dataFileName

dataFileCharacterSeparator

createTablePolicy

substringMatchType

autoincrementIdField

readOnly

passwordHashAlgorithm

cacheTimeout

cacheMaxSize

nativeCase

Constructor Detail

SQLDirectoryDescriptor

Method Detail

getDataSourceName

setDataSourceName

setIdField

getName

setName

getSchemaName

setSchemaName

getParentDirectory

setParentDirectory

getTableName

setTableName

getDbDriver

getDbPassword

getDbUrl

getDbUser

getDataFileName

getDataFileCharacterSeparator

getPasswordField

setPasswordField

getIdField

getCreateTablePolicy

setCreateTablePolicy

setSubstringMatchType

getInverseReferences

getTableReferences

getReadOnly

setReadOnly

isAutoincrementIdField

setAutoincrementIdField

setDbDriver

setDbPassword

setDbUrl

setDbUser

setInverseReferences

setDataFileName

setTableReferences

getQuerySizeLimit

setQuerySizeLimit

setRemove

getRemove

getCacheTimeout

getCacheMaxSize

getSubstringMatchType

setSubstringMatchType

getStaticFilters

isComputeMultiTenantId

merge

merge

clone