Package.xml revision f65733ef5ab8cedafc18f3f1fb55892fb4a6ad24
<?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
! 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
!
!
! Portions Copyright 2007 Sun Microsystems, Inc.
! -->
xmlns:adm="http://www.opends.org/admin"
xmlns:ldap="http://www.opends.org/admin-ldap">
<adm:synopsis>
Core OpenDS Directory Server administrative components.
</adm:synopsis>
<adm:property name="listen-port" mandatory="true">
<adm:synopsis>
Specifies the port number on which the
<adm:user-friendly-name />
will listen for connections from clients.
</adm:synopsis>
<adm:description>
Only a single port number may be provided.
</adm:description>
<adm:requires-admin-action>
<adm:component-restart />
</adm:requires-admin-action>
<adm:syntax>
<adm:integer lower-limit="1" upper-limit="65535" />
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
<ldap:name>ds-cfg-listen-port</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property name="use-ssl">
<adm:synopsis>
Indicates whether the
<adm:user-friendly-name />
should use SSL.
</adm:synopsis>
<adm:description>
If enabled, the
<adm:user-friendly-name />
will use SSL to encrypt communication with the clients.
</adm:description>
<adm:requires-admin-action>
<adm:component-restart />
</adm:requires-admin-action>
<adm:default-behavior>
<adm:defined>
<adm:value>false</adm:value>
</adm:defined>
</adm:default-behavior>
<adm:syntax>
<adm:boolean />
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
<ldap:name>ds-cfg-use-ssl</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property name="ssl-cert-nickname">
<adm:TODO>Need a better default description.</adm:TODO>
<adm:synopsis>
Specifies the nickname (also called the alias) of the certificate
that the
<adm:user-friendly-name />
should use when performing SSL communication.
</adm:synopsis>
<adm:description>
This is only applicable when the
<adm:user-friendly-name />
is configured to use SSL.
</adm:description>
<adm:requires-admin-action>
<adm:component-restart />
</adm:requires-admin-action>
<adm:default-behavior>
<adm:alias>
<adm:synopsis>Let the server decide.</adm:synopsis>
</adm:alias>
</adm:default-behavior>
<adm:syntax>
<adm:string></adm:string>
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
<ldap:name>ds-cfg-ssl-cert-nickname</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property name="key-store-pin">
<adm:synopsis>
Specifies the clear-text PIN needed to access the
<adm:user-friendly-name />
.
</adm:synopsis>
<adm:requires-admin-action>
<adm:none>
<adm:synopsis>
Changes to this property will take effect the next time that
the
<adm:user-friendly-name />
is accessed.
</adm:synopsis>
</adm:none>
</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-key-store-pin</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property name="key-store-pin-property">
<adm:TODO>Better syntax for property name?</adm:TODO>
<adm:synopsis>
Specifies the name of the Java property that contains the
clear-text PIN needed to access the
<adm:user-friendly-name />
.
</adm:synopsis>
<adm:requires-admin-action>
<adm:none>
<adm:synopsis>
Changes to this property will take effect the next time that
the
<adm:user-friendly-name />
is accessed.
</adm:synopsis>
</adm:none>
</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-key-store-pin-property</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property name="key-store-pin-environment-variable">
<adm:synopsis>
Specifies the name of the environment variable that contains the
clear-text PIN needed to access the
<adm:user-friendly-name />
.
</adm:synopsis>
<adm:requires-admin-action>
<adm:none>
<adm:synopsis>
Changes to this property will take effect the next time that
the
<adm:user-friendly-name />
is accessed.
</adm:synopsis>
</adm:none>
</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-key-store-pin-environment-variable</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property name="key-store-pin-file">
<adm:TODO>Should use a file-based property definition?</adm:TODO>
<adm:synopsis>
Specifies the path to the text file whose only contents should be
a single line containing the clear-text PIN needed to access the
<adm:user-friendly-name />
.
</adm:synopsis>
<adm:requires-admin-action>
<adm:none>
<adm:synopsis>
Changes to this property will take effect the next time that
the
<adm:user-friendly-name />
is accessed.
</adm:synopsis>
</adm:none>
</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-key-store-pin-file</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property name="trust-store-pin">
<adm:synopsis>
Specifies the clear-text PIN needed to access the
<adm:user-friendly-name />
.
</adm:synopsis>
<adm:requires-admin-action>
<adm:none>
<adm:synopsis>
Changes to this property will take effect the next time that
the
<adm:user-friendly-name />
is accessed.
</adm:synopsis>
</adm:none>
</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-trust-store-pin</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property name="trust-store-pin-property">
<adm:TODO>Better syntax for property name?</adm:TODO>
<adm:synopsis>
Specifies the name of the Java property that contains the
clear-text PIN needed to access the
<adm:user-friendly-name />
.
</adm:synopsis>
<adm:requires-admin-action>
<adm:none>
<adm:synopsis>
Changes to this property will take effect the next time that
the
<adm:user-friendly-name />
is accessed.
</adm:synopsis>
</adm:none>
</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-trust-store-pin-property</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property name="trust-store-pin-environment-variable">
<adm:synopsis>
Specifies the name of the environment variable that contains the
clear-text PIN needed to access the
<adm:user-friendly-name />
.
</adm:synopsis>
<adm:requires-admin-action>
<adm:none>
<adm:synopsis>
Changes to this property will take effect the next time that
the
<adm:user-friendly-name />
is accessed.
</adm:synopsis>
</adm:none>
</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-trust-store-pin-environment-variable</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property name="trust-store-pin-file">
<adm:TODO>Should use a file-based property definition?</adm:TODO>
<adm:synopsis>
Specifies the path to the text file whose only contents should be
a single line containing the clear-text PIN needed to access the
<adm:user-friendly-name />
.
</adm:synopsis>
<adm:requires-admin-action>
<adm:none>
<adm:synopsis>
Changes to this property will take effect the next time that
the
<adm:user-friendly-name />
is accessed.
</adm:synopsis>
</adm:none>
</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-trust-store-pin-file</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property name="include-filter" mandatory="false"
multi-valued="true">
<adm:synopsis>
The set of filters that define the entries that should be included
in the cache.
</adm:synopsis>
<adm:default-behavior>
<adm:undefined />
</adm:default-behavior>
<adm:syntax>
<adm:string />
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
<ldap:name>ds-cfg-include-filter</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property name="exclude-filter" mandatory="false"
multi-valued="true">
<adm:synopsis>
The set of filters that define the entries that should be excluded
from the cache.
</adm:synopsis>
<adm:default-behavior>
<adm:undefined />
</adm:default-behavior>
<adm:syntax>
<adm:string />
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
<ldap:name>ds-cfg-exclude-filter</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
</adm:package>