From 37737e52ffa8025dc5206dfeb6e6ba46e75f25fe Mon Sep 17 00:00:00 2001
From: rhaggard <rhaggard@localhost>
Date: Wed, 06 Feb 2008 18:09:50 +0000
Subject: [PATCH] Commiting configuration XML files after adding info from the old config guide to be incorporated in the new generated config reference
---
opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/VirtualAttributeConfiguration.xml | 79 ++++++++++++++++++++++++++++-----------
1 files changed, 57 insertions(+), 22 deletions(-)
diff --git a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/VirtualAttributeConfiguration.xml b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/VirtualAttributeConfiguration.xml
index dfa217e..96956f1 100644
--- a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/VirtualAttributeConfiguration.xml
+++ b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/VirtualAttributeConfiguration.xml
@@ -23,7 +23,7 @@
! CDDL HEADER END
!
!
- ! Portions Copyright 2007 Sun Microsystems, Inc.
+ ! Portions Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:managed-object name="virtual-attribute"
plural-name="virtual-attributes" package="org.opends.server.admin.std"
@@ -32,9 +32,13 @@
xmlns:cli="http://www.opends.org/admin-cli">
<adm:synopsis>
<adm:user-friendly-plural-name />
- are responsible for dynamically generating attribute values which
+ are responsible for dynamically generating attribute values that
appear in entries but are not persistently stored in the backend.
</adm:synopsis>
+ <adm:description>
+ Virtual attributes are associated with a virtual attribute
+ provider, which contains the logic for generating the value.
+ </adm:description>
<adm:tag name="core" />
<adm:profile name="ldap">
<ldap:object-class>
@@ -47,10 +51,12 @@
</adm:profile>
<adm:property name="java-class" mandatory="true">
<adm:synopsis>
- The fully-qualified name of the Java class that provides the
- <adm:user-friendly-name />
- implementation.
+ Specifies the fully-qualified name of the virtual attribute
+ provider class that generates the attribute values.
</adm:synopsis>
+ <adm:requires-admin-action>
+ <adm:component-restart />
+ </adm:requires-admin-action>
<adm:syntax>
<adm:java-class>
<adm:instance-of>
@@ -66,7 +72,7 @@
</adm:property>
<adm:property name="enabled" mandatory="true">
<adm:synopsis>
- Indicate whether the
+ Indicates whether the
<adm:user-friendly-name />
is enabled for use.
</adm:synopsis>
@@ -81,7 +87,7 @@
</adm:property>
<adm:property name="attribute-type" mandatory="true">
<adm:synopsis>
- Specifies the attribute type for the attribute whose values should
+ Specifies the attribute type for the attribute whose values are to
be dynamically assigned by the virtual attribute.
</adm:synopsis>
<adm:syntax>
@@ -96,12 +102,16 @@
<adm:property name="base-dn" multi-valued="true">
<adm:synopsis>
Specifies the base DNs for the branches containing entries that
- may be eligible to use this virtual attribute.
+ are eligible to use this virtual attribute.
</adm:synopsis>
+ <adm:description>
+ If no values are given, then the server generates virtual attributes
+ anywhere in the server.
+ </adm:description>
<adm:default-behavior>
<adm:alias>
<adm:synopsis>
- The location of the entry in the server will not be taken into
+ The location of the entry in the server is not taken into
account when determining whether an entry is eligible to use
this virtual attribute.
</adm:synopsis>
@@ -118,13 +128,19 @@
</adm:property>
<adm:property name="group-dn" multi-valued="true">
<adm:synopsis>
- Specifies the DNs of the groups whose members may be eligible to
+ Specifies the DNs of the groups whose members can be eligible to
use this virtual attribute.
</adm:synopsis>
+ <adm:description>
+ If no values are given, then group
+ membership is not taken into account when generating the virtual
+ attribute. If one or more group DNs are specified, then only
+ members of those groups are allowed to have the virtual attribute.
+ </adm:description>
<adm:default-behavior>
<adm:alias>
<adm:synopsis>
- Group membership will not be taken into account when
+ Group membership is not taken into account when
determining whether an entry is eligible to use this virtual
attribute.
</adm:synopsis>
@@ -141,16 +157,31 @@
</adm:property>
<adm:property name="filter" multi-valued="true">
<adm:synopsis>
- Specifies the search filters for entries that may be eligible to
- use this virtual attribute.
+ Specifies the search filters to be applied against entries to
+ determine if the virtual attribute is to be generated for those
+ entries.
</adm:synopsis>
+ <adm:description>
+ If no values are given, then any entry is eligible to
+ have the value generated. If one or more filters are specified,
+ then only entries that match at least one of those filters are
+ allowed to have the virtual attribute.
+ </adm:description>
<adm:default-behavior>
<adm:defined>
<adm:value>(objectClass=*)</adm:value>
</adm:defined>
</adm:default-behavior>
<adm:syntax>
- <adm:string />
+ <adm:string>
+ <adm:pattern>
+ <adm:regex>.*</adm:regex>
+ <adm:usage>STRING</adm:usage>
+ <adm:synopsis>
+ Any valid search filter string.
+ </adm:synopsis>
+ </adm:pattern>
+ </adm:string>
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
@@ -160,8 +191,9 @@
</adm:property>
<adm:property name="conflict-behavior">
<adm:synopsis>
- Specifies the behavior that the server should exhibit for entries
- that contain one or more real values for the associated attribute.
+ Specifies the behavior that the server is to exhibit for entries
+ that already contain one or more real values for the associated
+ attribute.
</adm:synopsis>
<adm:default-behavior>
<adm:defined>
@@ -172,20 +204,23 @@
<adm:enumeration>
<adm:value name="real-overrides-virtual">
<adm:synopsis>
- Any real values contained in the entry should be preserved
- and virtual values should not be generated.
+ Indicates that any real values contained in the entry are
+ preserved and used, and virtual values are not generated.
</adm:synopsis>
</adm:value>
<adm:value name="virtual-overrides-real">
<adm:synopsis>
- Any real values contained in the entry should be suppressed
- and virtual values should be generated.
+ Indicates that the virtual attribute provider suppresses
+ any real values contained in the entry
+ and generates virtual values and uses them.
</adm:synopsis>
</adm:value>
<adm:value name="merge-real-and-virtual">
<adm:synopsis>
- Any real values contained in the entry should be preserved
- and merged with the set of generated virtual values.
+ Indicates that the virtual attribute provider
+ is to preserve any real values contained in the entry
+ and merge them with the set of generated virtual values
+ so that both the real and virtual values are used.
</adm:synopsis>
</adm:value>
</adm:enumeration>
--
Gitblit v1.10.0