EntryUUIDPluginConfiguration.xml revision bccd35904bb6c244e7eae5b7ddb28e5c295e856b
<?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 legal-notices/CDDLv1_0.txt
! or http://forgerock.org/license/CDDLv1.0.html.
! 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 legal-notices/CDDLv1_0.txt.
! 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
!
!
! Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:managed-object name="entry-uuid-plugin"
plural-name="entry-uuid-plugins" package="org.forgerock.opendj.admin"
extends="plugin" xmlns:adm="http://www.opends.org/admin"
xmlns:ldap="http://www.opends.org/admin-ldap">
<adm:synopsis>
The
<adm:user-friendly-name />
generates values for the entryUUID operational attribute
whenever an entry is added via protocol or imported from LDIF.
</adm:synopsis>
<adm:description>
The entryUUID plug-in ensures that all entries
added to the server, whether through an LDAP add operation or via
an LDIF import, are assigned an entryUUID operational attribute if
they do not already have one. The entryUUID attribute contains a
universally unique identifier that can be used to identify an entry
in a manner that does not change (even in the event of a modify DN
operation). This plug-in generates a random UUID for entries created
by an add operation, but the UUID is constructed from the DN of the
entry during an LDIF import (which means that the same LDIF file
can be imported on different systems but still get the same value
for the entryUUID attribute). This behavior is based on the
specification contained in RFC 4530. The implementation for the
entry UUID plug-in is contained in the
org.opends.server.plugins.EntryUUIDPlugin class. It must be
configured with the preOperationAdd and ldifImport plug-in types,
but it does not have any other custom configuration. This
plug-in must be enabled in any directory that is intended to be used
in a synchronization environment.
</adm:description>
<adm:profile name="ldap">
<ldap:object-class>
<ldap:name>ds-cfg-entry-uuid-plugin</ldap:name>
<ldap:superior>ds-cfg-plugin</ldap:superior>
</ldap:object-class>
</adm:profile>
<adm:property-override name="java-class" advanced="true">
<adm:default-behavior>
<adm:defined>
<adm:value>org.opends.server.plugins.EntryUUIDPlugin</adm:value>
</adm:defined>
</adm:default-behavior>
</adm:property-override>
<adm:property-override name="plugin-type" advanced="true">
<adm:default-behavior>
<adm:defined>
<adm:value>ldifimport</adm:value>
<adm:value>preoperationadd</adm:value>
</adm:defined>
</adm:default-behavior>
</adm:property-override>
</adm:managed-object>