The Global Index Backend exposes the content of a Global Index through a Backend interface.
The Global Index Backend provides an LDAP access to a Global Index instance. It must be used in addition to a Global Index Workflow Element object.
The Global Index Backend component inherits from the Backend
The following components have a direct AGGREGATION relation FROM Global Index Backends :
This page describes the Global Index Backend:
A description of each property follows.
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ backend-id | ↓ java-class |
| ↓ base-dn | ↓ writability-mode |
| ↓ enabled | |
| ↓ global-index-catalog |
| Description | Specifies a name to identify the associated backend. The name must be unique among all backends in the server. The backend ID may not be altered after the backend is created in the server. |
| Default Value | None |
| Allowed Values | A String |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | Yes |
| Description | Specifies the base DN(s) for the data that the backend handles. A single backend may be responsible for one or more base DNs. Note that no two backends may have the same base DN although one backend may have a base DN that is below a base DN provided by another backend (similar to the use of sub-suffixes in the Sun Java System Directory Server). If any of the base DNs is subordinate to a base DN for another backend, then all base DNs for that backend must be subordinate to that same base DN. |
| Default Value | None |
| Allowed Values | A valid DN. |
| Multi-valued | Yes |
| Required | Yes |
| Admin Action Required | None. No administrative action is required by default although some action may be required on a per-backend basis before the new base DN may be used. |
| Advanced Property | No |
| Read-only | No |
| Description | Indicates whether the backend is enabled in the server. If a backend is not enabled, then its contents are not accessible when processing operations. |
| Default Value | None |
| Allowed Values | true false |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Identifies the global index extension configured for this backend. |
| Default Value | None |
| Allowed Values | The DN of any Extension. The referenced global index must be enabled. |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | Yes |
| Description | Specifies the fully-qualified name of the Java class that provides the backend implementation. |
| Default Value | com.sun.dps.server.backend.globalindex.GlobalIndexBackend |
| Allowed Values | A java class that implements or extends the class(es) : org.opends.server.api.Backend |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | The Global Index Backend must be disabled and re-enabled for changes to this setting to take effect |
| Advanced Property | Yes |
| Read-only | No |
| Description | Specifies the behavior that the backend should use when processing write operations. |
| Default Value | enabled |
| Allowed Values | disabled - Causes all write attempts to fail. enabled - Allows write operations to be performed in that backend (if the requested operation is valid, the user has permission to perform the operation, the backend supports that type of write operation, and the global writability-mode property is also enabled). internal-only - Causes external write attempts to fail but allows writes by replication and internal operations. |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | Yes |
| Read-only | No |
Each configuration property can be mapped to a specific LDAP attribute under the "cn=config" entry. The mappings that follow are provided for information only. In general, you should avoid changing the server configuration by manipulating the LDAP attributes directly.
| Base DN | cn=Backends,cn=config |
| objectclass name | ds-cfg-global-index-backend |
| objectclass superior | ds-cfg-backend |
| Property | LDAP attribute |
| backend-id | ds-cfg-backend-id |
| base-dn | ds-cfg-base-dn |
| enabled | ds-cfg-enabled |
| global-index-catalog | ds-cfg-global-index-catalog-ref |
| java-class | ds-cfg-java-class |
| writability-mode | ds-cfg-writability-mode |