mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git

lfrost
24.09.2008 5fcd533a636e3088ce00ee8f8b76ade5f53d9636
Initial doc review on Key Manager Provider Configuration Doc and some copyright changes.
8 files modified
98 ■■■■ changed files
opends/src/admin/defn/org/opends/server/admin/std/ExactMatchIdentityMapperConfiguration.xml 2 ●●● patch | view | raw | blame | history
opends/src/admin/defn/org/opends/server/admin/std/FileBasedKeyManagerProviderConfiguration.xml 35 ●●●● patch | view | raw | blame | history
opends/src/admin/defn/org/opends/server/admin/std/IdentityMapperConfiguration.xml 2 ●●● patch | view | raw | blame | history
opends/src/admin/defn/org/opends/server/admin/std/KeyManagerProviderConfiguration.xml 16 ●●●● patch | view | raw | blame | history
opends/src/admin/defn/org/opends/server/admin/std/PKCS11KeyManagerProviderConfiguration.xml 4 ●●●● patch | view | raw | blame | history
opends/src/admin/defn/org/opends/server/admin/std/Package.xml 33 ●●●● patch | view | raw | blame | history
opends/src/admin/defn/org/opends/server/admin/std/RegularExpressionIdentityMapperConfiguration.xml 2 ●●● patch | view | raw | blame | history
opends/src/admin/defn/org/opends/server/admin/std/TrustManagerProviderConfiguration.xml 4 ●●●● patch | view | raw | blame | history
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"
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>
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"
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>
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>
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>
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"
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.