<?xml version="1.0" encoding="UTF-8"?>
|
<!--
|
! CDDL HEADER START
|
!
|
! The contents of this file are subject to the terms of the
|
! Common Development and Distribution License, Version 1.0 only
|
! (the "License"). You may not use this file except in compliance
|
! with the License.
|
!
|
! You can obtain a copy of the license at
|
! trunk/opends/resource/legal-notices/OpenDS.LICENSE
|
! or https://OpenDS.dev.java.net/OpenDS.LICENSE.
|
! See the License for the specific language governing permissions
|
! and limitations under the License.
|
!
|
! When distributing Covered Code, include this CDDL HEADER in each
|
! file and include the License file at
|
! trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
|
! add the following below this CDDL HEADER, with the fields enclosed
|
! by brackets "[]" replaced with your own identifying information:
|
! Portions Copyright [yyyy] [name of copyright owner]
|
!
|
! CDDL HEADER END
|
!
|
!
|
! Copyright 2008-2009 Sun Microsystems, Inc.
|
! -->
|
<adm:managed-object name="ndb-backend"
|
plural-name="ndb-backends" package="org.opends.server.admin.std"
|
extends="backend" xmlns:adm="http://www.opends.org/admin"
|
xmlns:ldap="http://www.opends.org/admin-ldap"
|
xmlns:cli="http://www.opends.org/admin-cli">
|
<adm:synopsis>
|
The
|
<adm:user-friendly-name />
|
uses the NDB to store user-provided data.
|
</adm:synopsis>
|
<adm:description>
|
The
|
<adm:user-friendly-name />
|
stores the entries in NDB Cluster using shared data model
|
which allows for simultanious LDAP/SQL datastore access.
|
</adm:description>
|
<adm:profile name="ldap">
|
<ldap:object-class>
|
<ldap:name>ds-cfg-ndb-backend</ldap:name>
|
<ldap:superior>ds-cfg-backend</ldap:superior>
|
</ldap:object-class>
|
</adm:profile>
|
<adm:relation name="ndb-index">
|
<adm:one-to-many naming-property="attribute">
|
<adm:default-managed-object name="aci">
|
<adm:property name="index-type">
|
<adm:value>presence</adm:value>
|
</adm:property>
|
<adm:property name="attribute">
|
<adm:value>aci</adm:value>
|
</adm:property>
|
</adm:default-managed-object>
|
<adm:default-managed-object name="entryUUID">
|
<adm:property name="index-type">
|
<adm:value>equality</adm:value>
|
</adm:property>
|
<adm:property name="attribute">
|
<adm:value>entryUUID</adm:value>
|
</adm:property>
|
</adm:default-managed-object>
|
<adm:default-managed-object name="objectClass">
|
<adm:property name="index-type">
|
<adm:value>equality</adm:value>
|
</adm:property>
|
<adm:property name="attribute">
|
<adm:value>objectClass</adm:value>
|
</adm:property>
|
</adm:default-managed-object>
|
<adm:default-managed-object name="ds-sync-hist">
|
<adm:property name="index-type">
|
<adm:value>ordering</adm:value>
|
</adm:property>
|
<adm:property name="attribute">
|
<adm:value>ds-sync-hist</adm:value>
|
</adm:property>
|
</adm:default-managed-object>
|
</adm:one-to-many>
|
<adm:profile name="ldap">
|
<ldap:rdn-sequence>cn=Index</ldap:rdn-sequence>
|
</adm:profile>
|
<adm:profile name="cli">
|
<cli:relation>
|
<cli:default-property name="index-type" />
|
</cli:relation>
|
</adm:profile>
|
</adm:relation>
|
<adm:property-override name="java-class" advanced="true">
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>
|
org.opends.server.backends.ndb.BackendImpl
|
</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
</adm:property-override>
|
<adm:property name="ndb-connect-string" mandatory="true">
|
<adm:synopsis>
|
Specifies the NDB connect string.
|
</adm:synopsis>
|
<adm:description>
|
IP addresses or hostnames with portnumbers may be provided.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:component-restart />
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>localhost</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:string />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-ndb-connect-string</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="sql-connect-string" mandatory="true">
|
<adm:synopsis>
|
Specifies the SQL connect string.
|
</adm:synopsis>
|
<adm:description>
|
IP addresses or hostnames with portnumbers may be provided.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:component-restart />
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>localhost</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:string />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-sql-connect-string</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="sql-user">
|
<adm:synopsis>
|
Specifies the SQL database user on whose behalf
|
the connection is being made.
|
</adm:synopsis>
|
<adm:description>
|
SQL user name may be provided.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:component-restart />
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>root</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:string />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-sql-user</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="sql-passwd">
|
<adm:synopsis>
|
Specifies the SQL database user password.
|
</adm:synopsis>
|
<adm:description>
|
SQL user password may be provided.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:component-restart />
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:undefined />
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:string />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-sql-passwd</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="ndb-dbname" mandatory="true">
|
<adm:synopsis>
|
Specifies the SQL/NDB database name.
|
</adm:synopsis>
|
<adm:description>
|
SQL/NDB database name may be provided.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:component-restart />
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>ldap</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:string />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-ndb-dbname</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="ndb-num-connections" advanced="true">
|
<adm:synopsis>
|
Specifies the number of NDB connections.
|
</adm:synopsis>
|
<adm:description>
|
Logical connections made to NDB Cluster.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:component-restart />
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>4</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:integer lower-limit="1" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-ndb-num-connections</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="ndb-thread-count" advanced="true">
|
<adm:synopsis>
|
Specifies the number of threads that is used for concurrent
|
NDB processing.
|
</adm:synopsis>
|
<adm:description>
|
This should generally be equal to the number of worker threads.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:component-restart/>
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>24</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:integer lower-limit="1" upper-limit="128" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-ndb-thread-count</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="ndb-attr-len" advanced="true">
|
<adm:synopsis>
|
Specifies the attribute length.
|
</adm:synopsis>
|
<adm:description>
|
This should reflect SQL/NDB attribute column length.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:component-restart/>
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>128</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:integer lower-limit="1" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-ndb-attr-len</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="ndb-attr-blob" multi-valued="true" advanced="true">
|
<adm:synopsis>
|
Specifies the blob attribute.
|
</adm:synopsis>
|
<adm:description>
|
This should specify which attribute to treat as a blob.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:component-restart />
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:undefined />
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:string />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-ndb-attr-blob</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="deadlock-retry-limit" advanced="true">
|
<adm:synopsis>
|
Specifies the number of times that the server should retry an
|
attempted operation in the backend if a deadlock results from
|
two concurrent requests that interfere with each other in a
|
conflicting manner.
|
</adm:synopsis>
|
<adm:description>
|
A value of "0" indicates no limit.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>10</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:integer lower-limit="0" upper-limit="2147483647" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-deadlock-retry-limit</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="import-queue-size" advanced="true">
|
<adm:synopsis>
|
Specifies the size (in number of entries) of the queue that is
|
used to hold the entries read during an LDIF import.
|
</adm:synopsis>
|
<adm:requires-admin-action>
|
<adm:none>
|
<adm:synopsis>
|
Changes do not take effect for any import that may already
|
be in progress.
|
</adm:synopsis>
|
</adm:none>
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>100</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:integer lower-limit="1" upper-limit="2147483647" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-import-queue-size</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="import-thread-count" advanced="true">
|
<adm:synopsis>
|
Specifies the number of threads that is used for concurrent
|
processing during an LDIF import.
|
</adm:synopsis>
|
<adm:description>
|
This should generally be a small multiple (for example, 2x) of the number
|
of CPUs in the system for a traditional system, or equal to the
|
number of CPU strands for a CMT system.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:none>
|
<adm:synopsis>
|
Changes do not take effect for any import that may already
|
be in progress.
|
</adm:synopsis>
|
</adm:none>
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>8</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:integer lower-limit="1" upper-limit="2147483647" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-import-thread-count</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="index-entry-limit" advanced="true">
|
<adm:synopsis>
|
Specifies the maximum number of entries that is allowed to
|
match a given index key before that particular index key is no
|
longer maintained.
|
</adm:synopsis>
|
<adm:description>
|
This property is analogous to the ALL IDs threshold in the Sun
|
Java System Directory Server. Note that this is the default limit
|
for the backend, and it may be overridden on a per-attribute
|
basis. A value of 0 means there is no limit.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:none>
|
<adm:synopsis>
|
If any index keys have already reached this limit, indexes
|
need to be rebuilt before they are allowed to use the
|
new limit.
|
</adm:synopsis>
|
</adm:none>
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>4000</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:integer lower-limit="0" upper-limit="2147483647" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-index-entry-limit</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
</adm:managed-object>
|
