From 5fcd533a636e3088ce00ee8f8b76ade5f53d9636 Mon Sep 17 00:00:00 2001
From: lfrost <lfrost@localhost>
Date: Thu, 24 Jan 2008 11:09:58 +0000
Subject: [PATCH] Initial doc review on Key Manager Provider Configuration Doc and some copyright changes.
---
opends/src/admin/defn/org/opends/server/admin/std/RegularExpressionIdentityMapperConfiguration.xml | 2
opends/src/admin/defn/org/opends/server/admin/std/KeyManagerProviderConfiguration.xml | 16 ++++++--
opends/src/admin/defn/org/opends/server/admin/std/ExactMatchIdentityMapperConfiguration.xml | 2
opends/src/admin/defn/org/opends/server/admin/std/PKCS11KeyManagerProviderConfiguration.xml | 4 +-
opends/src/admin/defn/org/opends/server/admin/std/Package.xml | 33 ++++++++++++++--
opends/src/admin/defn/org/opends/server/admin/std/IdentityMapperConfiguration.xml | 2
opends/src/admin/defn/org/opends/server/admin/std/FileBasedKeyManagerProviderConfiguration.xml | 35 +++++++++++++----
opends/src/admin/defn/org/opends/server/admin/std/TrustManagerProviderConfiguration.xml | 4 +-
8 files changed, 74 insertions(+), 24 deletions(-)
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/ExactMatchIdentityMapperConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/ExactMatchIdentityMapperConfiguration.xml
index 1ebcce0..cb3e024 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/ExactMatchIdentityMapperConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/ExactMatchIdentityMapperConfiguration.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="exact-match-identity-mapper"
plural-name="exact-match-identity-mappers"
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/FileBasedKeyManagerProviderConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/FileBasedKeyManagerProviderConfiguration.xml
index 9fa248c..5f5b4f5 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/FileBasedKeyManagerProviderConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/FileBasedKeyManagerProviderConfiguration.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="file-based-key-manager-provider"
plural-name="file-based-key-manager-providers"
@@ -33,11 +33,12 @@
<adm:synopsis>
The
<adm:user-friendly-name />
- provider accesses key information in a file on the local filesystem.
+ can be used to obtain the server certificate from a key store file on
+ the local file system.
</adm:synopsis>
<adm:description>
Multiple file formats may be supported, depending on the providers
- supported by the underlying Java runtime.
+ supported by the underlying Java runtime environment.
</adm:description>
<adm:constraint>
<adm:synopsis>
@@ -76,18 +77,26 @@
<adm:property name="key-store-file" mandatory="true">
<adm:TODO>Should use a file-based property definition?</adm:TODO>
<adm:synopsis>
- Specifies the path to the file containing the private key
- information. It may be an absolute path, or a path that is
+ Specifies the path to the file that contains the private key
+ information. This may be an absolute path, or a path that is
relative to the
<adm:product-name />
instance root.
</adm:synopsis>
<adm:description>
- Changes to this configuration attribute will take effect the next
+ Changes to this property will take effect the next
time that the key manager is accessed.
</adm:description>
<adm:syntax>
- <adm:string />
+ <adm:string>
+ <adm:pattern>
+ <adm:regex>.*</adm:regex>
+ <adm:usage>FILE</adm:usage>
+ <adm:synopsis>
+ A path to an existing file that is readable by the server.
+ </adm:synopsis>
+ </adm:pattern>
+ </adm:string>
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
@@ -106,7 +115,7 @@
<adm:description>
Valid values should always include 'JKS' and 'PKCS12', but
different implementations may allow other values as well. If no
- value is provided, then the JVM-default value will be used.
+ value is provided, the JVM-default value is used.
Changes to this configuration attribute will take effect the next
time that the key manager is accessed.
</adm:description>
@@ -114,7 +123,15 @@
<adm:undefined />
</adm:default-behavior>
<adm:syntax>
- <adm:string />
+ <adm:string>
+ <adm:pattern>
+ <adm:regex>.*</adm:regex>
+ <adm:usage>STRING</adm:usage>
+ <adm:synopsis>
+ Any key store format supported by the Java runtime environment.
+ </adm:synopsis>
+ </adm:pattern>
+ </adm:string>
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/IdentityMapperConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/IdentityMapperConfiguration.xml
index d13850e..34a60ea 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/IdentityMapperConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/IdentityMapperConfiguration.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="identity-mapper"
plural-name="identity-mappers" package="org.opends.server.admin.std"
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/KeyManagerProviderConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/KeyManagerProviderConfiguration.xml
index 2da8b3c..05f1a8e 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/KeyManagerProviderConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/KeyManagerProviderConfiguration.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="key-manager-provider"
plural-name="key-manager-providers"
@@ -33,9 +33,14 @@
xmlns:cli="http://www.opends.org/admin-cli">
<adm:synopsis>
<adm:user-friendly-plural-name />
- are responsible for managing the key material which is used to
+ are responsible for managing the key material that is used to
authenticate an SSL connection to its peer.
</adm:synopsis>
+ <adm:description>
+ <adm:user-friendly-plural-name />
+ essentially provide access to the certificate that is used by the
+ server when performing SSL or StartTLS negotiation.
+ </adm:description>
<adm:tag name="security" />
<adm:profile name="ldap">
<ldap:object-class>
@@ -48,7 +53,7 @@
</adm:profile>
<adm:property name="enabled" mandatory="true">
<adm:synopsis>
- Indicate whether the
+ Indicates whether the
<adm:user-friendly-name />
is enabled for use.
</adm:synopsis>
@@ -63,11 +68,14 @@
</adm:property>
<adm:property name="java-class" mandatory="true">
<adm:synopsis>
- The fully-qualified name of the Java class that should to provide
+ The fully-qualified name of the Java class that provides
the
<adm:user-friendly-name />
implementation.
</adm:synopsis>
+ <adm:requires-admin-action>
+ <adm:component-restart />
+ </adm:requires-admin-action>
<adm:syntax>
<adm:java-class>
<adm:instance-of>
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/PKCS11KeyManagerProviderConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/PKCS11KeyManagerProviderConfiguration.xml
index f81e561..58db0b1 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/PKCS11KeyManagerProviderConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/PKCS11KeyManagerProviderConfiguration.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="pkcs11-key-manager-provider"
plural-name="pkcs11-key-manager-providers"
@@ -33,7 +33,7 @@
<adm:synopsis>
The
<adm:user-friendly-name />
- provider provides the ability for the server to access the private
+ enables the server to access the private
key information through the PKCS11 interface.
</adm:synopsis>
<adm:description>
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/Package.xml b/opends/src/admin/defn/org/opends/server/admin/std/Package.xml
index 42b6a3e..f7f18d8 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/Package.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/Package.xml
@@ -23,7 +23,7 @@
! CDDL HEADER END
!
!
- ! Portions Copyright 2007 Sun Microsystems, Inc.
+ ! Portions Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:package name="org.opends.server.admin.std"
xmlns:adm="http://www.opends.org/admin"
@@ -160,7 +160,15 @@
<adm:undefined />
</adm:default-behavior>
<adm:syntax>
- <adm:string />
+ <adm:string>
+ <adm:pattern>
+ <adm:regex>.*</adm:regex>
+ <adm:usage>STRING</adm:usage>
+ <adm:synopsis>
+ The name of a defined Java property.
+ </adm:synopsis>
+ </adm:pattern>
+ </adm:string>
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
@@ -189,7 +197,16 @@
<adm:undefined />
</adm:default-behavior>
<adm:syntax>
- <adm:string />
+ <adm:string>
+ <adm:pattern>
+ <adm:regex>.*</adm:regex>
+ <adm:usage>STRING</adm:usage>
+ <adm:synopsis>
+ The name of a defined environment variable that contains the
+ clear-text PIN required to access the contents of the key store.
+ </adm:synopsis>
+ </adm:pattern>
+ </adm:string>
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
@@ -219,7 +236,15 @@
<adm:undefined />
</adm:default-behavior>
<adm:syntax>
- <adm:string />
+ <adm:string>
+ <adm:pattern>
+ <adm:regex>.*</adm:regex>
+ <adm:usage>FILE</adm:usage>
+ <adm:synopsis>
+ A path to an existing file that is readable by the server.
+ </adm:synopsis>
+ </adm:pattern>
+ </adm:string>
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/RegularExpressionIdentityMapperConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/RegularExpressionIdentityMapperConfiguration.xml
index 9c246fd..e85d2eb 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/RegularExpressionIdentityMapperConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/RegularExpressionIdentityMapperConfiguration.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="regular-expression-identity-mapper"
plural-name="regular-expression-identity-mappers"
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/TrustManagerProviderConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/TrustManagerProviderConfiguration.xml
index 9b4012a..95ae6ab 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/TrustManagerProviderConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/TrustManagerProviderConfiguration.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="trust-manager-provider"
plural-name="trust-manager-providers"
@@ -63,7 +63,7 @@
</adm:property>
<adm:property name="java-class" mandatory="true">
<adm:synopsis>
- The fully-qualified name of the Java class that should to provide
+ The fully-qualified name of the Java class that provides
the
<adm:user-friendly-name />
implementation.
--
Gitblit v1.10.0