BaseDirectoryDescriptor (Nuxeo ECM Projects 10.3 API)

java.lang.Object
- org.nuxeo.ecm.directory.BaseDirectoryDescriptor

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

CoreDirectoryDescriptor, LDAPDirectoryDescriptor, MemoryDirectoryDescriptor, MongoDBDirectoryDescriptor, MultiDirectoryDescriptor, SQLDirectoryDescriptor
```
public class BaseDirectoryDescriptor
extends Object
implements Cloneable
```
Basic directory descriptor, containing the basic fields used by all directories.

Since:

8.2

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BaseDirectoryDescriptor.SubstringMatchType
How directory semi-"fulltext" searches are matched with a query string.

Nested Classes
Modifier and Type	Class and Description
`static class`	`BaseDirectoryDescriptor.SubstringMatchType` How directory semi-"fulltext" searches are matched with a query string.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`AUTO_INCREMENT_ID_FIELD_DEFAULT`
`Boolean`	`autoincrementIdField`
`static int`	`CACHE_MAX_SIZE_DEFAULT`
`static int`	`CACHE_TIMEOUT_DEFAULT`
`String`	`cacheEntryName`
`String`	`cacheEntryWithoutReferencesName`
`Integer`	`cacheMaxSize`
`Integer`	`cacheTimeout`
`protected boolean`	`computeMultiTenantId`
`static List<String>`	`CREATE_TABLE_POLICIES`
`static String`	`CREATE_TABLE_POLICY_ALWAYS` Always recreates the table from scratch and loads the CSV data.
`static String`	`CREATE_TABLE_POLICY_DEFAULT`
`static String`	`CREATE_TABLE_POLICY_NEVER` Doesn't create or modify the table in any way.
`static String`	`CREATE_TABLE_POLICY_ON_MISSING_COLUMNS` If the table doesn't exist then creates it and loads the CSV data.
`String`	`createTablePolicy`
`String`	`dataFileCharacterSeparator`
`String`	`dataFileName`
`static char`	`DEFAULT_DATA_FILE_CHARACTER_SEPARATOR`
`String`	`extendz`
`String`	`idField`
`String`	`name`
`Boolean`	`negativeCaching`
`String`	`parentDirectory`
`String`	`passwordField`
`String`	`passwordHashAlgorithm`
`PermissionDescriptor[]`	`permissions`
`static boolean`	`READ_ONLY_DEFAULT`
`Boolean`	`readOnly`
`boolean`	`remove`
`String`	`schemaName`
`static BaseDirectoryDescriptor.SubstringMatchType`	`SUBSTRING_MATCH_TYPE_DEFAULT`
`String`	`substringMatchType`
`String`	`tableName`
`boolean`	`template`
`String[]`	`types`

Constructor Summary

Constructors
Constructor and Description

BaseDirectoryDescriptor()

Constructors
Constructor and Description
`BaseDirectoryDescriptor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BaseDirectoryDescriptor`	`clone()` Sub-classes MUST OVERRIDE and use a more specific return type.
`int`	`getCacheMaxSize()`
`int`	`getCacheTimeout()`
`String`	`getCreateTablePolicy()`
`char`	`getDataFileCharacterSeparator()`
`String`	`getDataFileName()`
`List<DirectoryDeleteConstraint>`	`getDeleteConstraints()`
`InverseReferenceDescriptor[]`	`getInverseReferences()`
`ReferenceDescriptor[]`	`getReferences()`
`BaseDirectoryDescriptor.SubstringMatchType`	`getSubstringMatchType()`
`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.
`boolean`	`isReadOnly()`
`void`	`merge(BaseDirectoryDescriptor other)`
`Directory`	`newDirectory()` Creates a new `Directory` instance from this {@link BaseDirectoryDescriptor).
`void`	`setAutoincrementIdField(boolean autoincrementIdField)`
`void`	`setReadOnly(boolean readOnly)`

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

Field Detail

AUTO_INCREMENT_ID_FIELD_DEFAULT

public static final boolean AUTO_INCREMENT_ID_FIELD_DEFAULT

See Also:: Constant Field Values

CACHE_TIMEOUT_DEFAULT
```
public static final int CACHE_TIMEOUT_DEFAULT
```
See Also:

Constant Field Values

CACHE_MAX_SIZE_DEFAULT
```
public static final int CACHE_MAX_SIZE_DEFAULT
```
See Also:

Constant Field Values

READ_ONLY_DEFAULT

public static final boolean READ_ONLY_DEFAULT

See Also:: Constant Field Values

SUBSTRING_MATCH_TYPE_DEFAULT

public static final BaseDirectoryDescriptor.SubstringMatchType SUBSTRING_MATCH_TYPE_DEFAULT

DEFAULT_DATA_FILE_CHARACTER_SEPARATOR
```
public static final char DEFAULT_DATA_FILE_CHARACTER_SEPARATOR
```
See Also:

Constant Field Values

CREATE_TABLE_POLICY_NEVER
```
public static final String CREATE_TABLE_POLICY_NEVER
```
Doesn't create or modify the table in any way.

See Also:

Constant Field Values

CREATE_TABLE_POLICY_ALWAYS
```
public static final String CREATE_TABLE_POLICY_ALWAYS
```
Always recreates the table from scratch and loads the CSV data.

See Also:

Constant Field Values

CREATE_TABLE_POLICY_ON_MISSING_COLUMNS
```
public static final String CREATE_TABLE_POLICY_ON_MISSING_COLUMNS
```
If the table doesn't exist then creates it and loads the CSV data. If the table already exists, only adds missing columns (with null values).

See Also:

Constant Field Values

CREATE_TABLE_POLICY_DEFAULT

public static final String CREATE_TABLE_POLICY_DEFAULT

See Also:: Constant Field Values

CREATE_TABLE_POLICIES

public static final List<String> CREATE_TABLE_POLICIES

name
```
public String name
```

remove
```
public boolean remove
```

template
```
public boolean template
```

extendz
```
public String extendz
```

parentDirectory
```
public String parentDirectory
```

schemaName
```
public String schemaName
```

idField
```
public String idField
```

autoincrementIdField
```
public Boolean autoincrementIdField
```

tableName
```
public String tableName
```

readOnly
```
public Boolean readOnly
```

passwordField
```
public String passwordField
```

passwordHashAlgorithm
```
public String passwordHashAlgorithm
```

permissions

public PermissionDescriptor[] permissions

cacheTimeout
```
public Integer cacheTimeout
```

cacheMaxSize
```
public Integer cacheMaxSize
```

cacheEntryName
```
public String cacheEntryName
```

cacheEntryWithoutReferencesName

public String cacheEntryWithoutReferencesName

negativeCaching
```
public Boolean negativeCaching
```

substringMatchType
```
public String substringMatchType
```

computeMultiTenantId
```
protected boolean computeMultiTenantId
```

types
```
public String[] types
```
Since:

8.4

dataFileName
```
public String dataFileName
```

dataFileCharacterSeparator

public String dataFileCharacterSeparator

createTablePolicy
```
public String createTablePolicy
```

Constructor Detail
- BaseDirectoryDescriptor
```
public BaseDirectoryDescriptor()
```

Method Detail

isAutoincrementIdField

public boolean isAutoincrementIdField()

setAutoincrementIdField

public void setAutoincrementIdField(boolean autoincrementIdField)

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

getDataFileCharacterSeparator

public char getDataFileCharacterSeparator()

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

isReadOnly
```
public boolean isReadOnly()
```

setReadOnly

public void setReadOnly(boolean readOnly)

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

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

getSubstringMatchType

public BaseDirectoryDescriptor.SubstringMatchType getSubstringMatchType()

clone
```
public BaseDirectoryDescriptor clone()
```
Sub-classes MUST OVERRIDE and use a more specific return type.
Usually it's bad to use clone(), and a copy-constructor is preferred, but here we want the copy method to be inheritable so clone() is appropriate.

Overrides:

clone in class Object

merge

public void merge(BaseDirectoryDescriptor other)

newDirectory
```
public Directory newDirectory()
```
Creates a new Directory instance from this {@link BaseDirectoryDescriptor).

getDeleteConstraints

public List<DirectoryDeleteConstraint> getDeleteConstraints()

Since:: 8.4

getReferences

public ReferenceDescriptor[] getReferences()

Since:: 9.2

getInverseReferences

public InverseReferenceDescriptor[] getInverseReferences()

Since:: 9.2

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:

10.1

Class BaseDirectoryDescriptor

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AUTO_INCREMENT_ID_FIELD_DEFAULT

CACHE_TIMEOUT_DEFAULT

CACHE_MAX_SIZE_DEFAULT

READ_ONLY_DEFAULT

SUBSTRING_MATCH_TYPE_DEFAULT

DEFAULT_DATA_FILE_CHARACTER_SEPARATOR

CREATE_TABLE_POLICY_NEVER

CREATE_TABLE_POLICY_ALWAYS

CREATE_TABLE_POLICY_ON_MISSING_COLUMNS

CREATE_TABLE_POLICY_DEFAULT

CREATE_TABLE_POLICIES

name

remove

template

extendz

parentDirectory

schemaName

idField

autoincrementIdField

tableName

readOnly

passwordField

passwordHashAlgorithm

permissions

cacheTimeout

cacheMaxSize

cacheEntryName

cacheEntryWithoutReferencesName

negativeCaching

substringMatchType

computeMultiTenantId

types

dataFileName

dataFileCharacterSeparator

createTablePolicy

Constructor Detail

BaseDirectoryDescriptor

Method Detail

isAutoincrementIdField

setAutoincrementIdField

getDataFileName

getDataFileCharacterSeparator

getCreateTablePolicy

isReadOnly

setReadOnly

getCacheTimeout

getCacheMaxSize

getSubstringMatchType

clone

merge

newDirectory

getDeleteConstraints

getReferences

getInverseReferences

isComputeMultiTenantId