Doc changes to Matching Rule and Monitor Provider Configuration Doc and some copyright changes. Thanks to Daniel for the review.
| | |
| | | ! CDDL HEADER END |
| | | ! |
| | | ! |
| | | ! Portions Copyright 2007 Sun Microsystems, Inc. |
| | | ! Portions Copyright 2007-2008 Sun Microsystems, Inc. |
| | | ! --> |
| | | <adm:managed-object name="approximate-matching-rule" |
| | | plural-name="approximate-matching-rules" |
| | |
| | | ! CDDL HEADER END |
| | | ! |
| | | ! |
| | | ! Portions Copyright 2007 Sun Microsystems, Inc. |
| | | ! Portions Copyright 2007-2008 Sun Microsystems, Inc. |
| | | ! --> |
| | | <adm:managed-object name="client-connection-monitor-provider" |
| | | plural-name="client-connection-monitor-providers" |
| | |
| | | ! CDDL HEADER END |
| | | ! |
| | | ! |
| | | ! Portions Copyright 2007 Sun Microsystems, Inc. |
| | | ! Portions Copyright 2007-2008 Sun Microsystems, Inc. |
| | | ! --> |
| | | <adm:managed-object name="entry-cache-monitor-provider" |
| | | plural-name="entry-cache-monitor-providers" |
| | |
| | | <adm:synopsis> |
| | | The |
| | | <adm:user-friendly-name /> |
| | | exposes monitor information about Directory Server entry caches |
| | | state. |
| | | exposes monitor information about the state of Directory Server |
| | | entry caches. |
| | | </adm:synopsis> |
| | | <adm:profile name="ldap"> |
| | | <ldap:object-class> |
| | |
| | | ! CDDL HEADER END |
| | | ! |
| | | ! |
| | | ! Portions Copyright 2007 Sun Microsystems, Inc. |
| | | ! Portions Copyright 2007-2008 Sun Microsystems, Inc. |
| | | ! --> |
| | | <adm:managed-object name="equality-matching-rule" |
| | | plural-name="equality-matching-rules" |
| | |
| | | <adm:synopsis> |
| | | <adm:user-friendly-plural-name /> |
| | | define a set of rules for performing equality matching operations |
| | | against assertion values (i.e., to determine whether an attribute |
| | | against assertion values (that is, to determine whether an attribute |
| | | value equals an assertion value). |
| | | </adm:synopsis> |
| | | <adm:profile name="ldap"> |
| | |
| | | ! CDDL HEADER END |
| | | ! |
| | | ! |
| | | ! Portions Copyright 2007 Sun Microsystems, Inc. |
| | | ! Portions Copyright 2007-2008 Sun Microsystems, Inc. |
| | | ! --> |
| | | <adm:managed-object name="matching-rule" plural-name="matching-rules" |
| | | package="org.opends.server.admin.std" abstract="true" |
| | |
| | | assertion values. |
| | | </adm:synopsis> |
| | | <adm:description> |
| | | The primary types of matching rules are equality, ordering, |
| | | substring, and approximate. |
| | | Matching rules are frequently associated with an attribute syntax |
| | | and are used to compare values according to that syntax. For example, |
| | | the distinguishedNameEqualityMatch matching rule can be used to |
| | | determine whether two DNs are equal and can ignore unnecessary spaces |
| | | around commas and equal signs, differences in capitalization in |
| | | attribute names, an so on. |
| | | </adm:description> |
| | | <adm:tag name="core" /> |
| | | <adm:profile name="ldap"> |
| | |
| | | </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> |
| | |
| | | </adm:property> |
| | | <adm:property name="java-class" mandatory="true"> |
| | | <adm:synopsis> |
| | | The fully-qualified name of the Java class that provides the |
| | | Specifies the fully-qualified name of the Java class that provides the |
| | | <adm:user-friendly-name /> |
| | | implementation. |
| | | </adm:synopsis> |
| | |
| | | ! CDDL HEADER END |
| | | ! |
| | | ! |
| | | ! Portions Copyright 2007 Sun Microsystems, Inc. |
| | | ! Portions Copyright 2007-2008 Sun Microsystems, Inc. |
| | | ! --> |
| | | <adm:managed-object name="memory-usage-monitor-provider" |
| | | plural-name="memory-usage-monitor-providers" |
| | |
| | | <adm:synopsis> |
| | | The |
| | | <adm:user-friendly-name /> |
| | | may be used to publish information about memory consumption and |
| | | can be used to publish information about memory consumption and |
| | | garbage collection activity in the JVM. |
| | | </adm:synopsis> |
| | | <adm:profile name="ldap"> |
| | |
| | | ! CDDL HEADER END |
| | | ! |
| | | ! |
| | | ! Portions Copyright 2007 Sun Microsystems, Inc. |
| | | ! Portions Copyright 2007-2008 Sun Microsystems, Inc. |
| | | ! --> |
| | | <adm:managed-object name="monitor-provider" |
| | | plural-name="monitor-providers" package="org.opends.server.admin.std" |
| | |
| | | xmlns:cli="http://www.opends.org/admin-cli"> |
| | | <adm:synopsis> |
| | | <adm:user-friendly-plural-name /> |
| | | may be used to provide information about the state of the server or |
| | | can be used to provide information about the state of the server or |
| | | one of its components. |
| | | </adm:synopsis> |
| | | <adm:description> |
| | | This information may be useful for monitoring and/or troubleshooting |
| | | purposes. |
| | | This information is useful for monitoring or troubleshooting. |
| | | </adm:description> |
| | | <adm:tag name="core" /> |
| | | <adm:profile name="ldap"> |
| | |
| | | </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> |
| | |
| | | </adm:property> |
| | | <adm:property name="java-class" mandatory="true"> |
| | | <adm:synopsis> |
| | | The fully-qualified name of the Java class that provides the |
| | | Specifies the fully-qualified name of the Java class that provides the |
| | | <adm:user-friendly-name /> |
| | | implementation. |
| | | </adm:synopsis> |
| | |
| | | ! CDDL HEADER END |
| | | ! |
| | | ! |
| | | ! Portions Copyright 2007 Sun Microsystems, Inc. |
| | | ! Portions Copyright 2007-2008 Sun Microsystems, Inc. |
| | | ! --> |
| | | <adm:managed-object name="ordering-matching-rule" |
| | | plural-name="ordering-matching-rules" |
| | |
| | | ! CDDL HEADER END |
| | | ! |
| | | ! |
| | | ! Portions Copyright 2007 Sun Microsystems, Inc. |
| | | ! Portions Copyright 2007-2008 Sun Microsystems, Inc. |
| | | ! --> |
| | | <adm:managed-object name="stack-trace-monitor-provider" |
| | | plural-name="stack-trace-monitor-providers" |
| | |
| | | <adm:synopsis> |
| | | The |
| | | <adm:user-friendly-name /> |
| | | provides the ability for clients to obtain a stack trace of all |
| | | threads currently running in the Directory Server. |
| | | enables clients to obtain a stack trace of all the threads that are |
| | | currently running in the Directory Server. |
| | | </adm:synopsis> |
| | | <adm:profile name="ldap"> |
| | | <ldap:object-class> |
| | |
| | | ! CDDL HEADER END |
| | | ! |
| | | ! |
| | | ! Portions Copyright 2007 Sun Microsystems, Inc. |
| | | ! Portions Copyright 2007-2008 Sun Microsystems, Inc. |
| | | ! --> |
| | | <adm:managed-object name="substring-matching-rule" |
| | | plural-name="substring-matching-rules" |
| | |
| | | against assertion values. |
| | | </adm:synopsis> |
| | | <adm:description> |
| | | Substring matching may be used to perform partial matching with |
| | | Substring matching can be used to perform partial matching with |
| | | attribute values. |
| | | </adm:description> |
| | | <adm:profile name="ldap"> |
| | |
| | | ! CDDL HEADER END |
| | | ! |
| | | ! |
| | | ! Portions Copyright 2007 Sun Microsystems, Inc. |
| | | ! Portions Copyright 2007-2008 Sun Microsystems, Inc. |
| | | ! --> |
| | | <adm:managed-object name="system-info-monitor-provider" |
| | | plural-name="system-info-monitor-providers" |
| | |
| | | <adm:synopsis> |
| | | The |
| | | <adm:user-friendly-name /> |
| | | may be used to publish information about the system and virtual |
| | | can be used to publish information about the system and virtual |
| | | machine on which the Directory Server is running. |
| | | </adm:synopsis> |
| | | <adm:profile name="ldap"> |
| | |
| | | ! CDDL HEADER END |
| | | ! |
| | | ! |
| | | ! Portions Copyright 2007 Sun Microsystems, Inc. |
| | | ! Portions Copyright 2007-2008 Sun Microsystems, Inc. |
| | | ! --> |
| | | <adm:managed-object name="version-monitor-provider" |
| | | plural-name="version-monitor-providers" |
| | |
| | | <adm:synopsis> |
| | | The |
| | | <adm:user-friendly-name /> |
| | | may be used to publish Directory Server version information. |
| | | can be used to publish Directory Server version information. |
| | | </adm:synopsis> |
| | | <adm:profile name="ldap"> |
| | | <ldap:object-class> |