/*
* 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
* 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 2006-2008 Sun Microsystems, Inc.
*/
/**
* This class implements a Directory Server plugin that will add the entryUUID
* attribute to an entry whenever it is added or imported as per RFC 4530. For
* entries added over LDAP, the entryUUID will be based on a semi-random UUID
* (which is still guaranteed to be unique). For entries imported from LDIF,
* the UUID will be constructed from the entry DN using a repeatable algorithm.
* This will ensure that LDIF files imported in parallel across multiple systems
* will have identical entryUUID values.
*/
public final class EntryUUIDPlugin
extends DirectoryServerPlugin<EntryUUIDPluginCfg>
implements ConfigurationChangeListener<EntryUUIDPluginCfg>
{
/**
* The name of the entryUUID attribute type.
*/
// The attribute type for the "entryUUID" attribute.
// The current configuration for this plugin.
/**
* Creates a new instance of this Directory Server plugin. Every plugin must
* implement a default constructor (it is the only one that will be used to
* create plugins defined in the configuration), and every plugin constructor
* must call <CODE>super()</CODE> as its first element.
*/
public EntryUUIDPlugin()
{
super();
// Get the entryUUID attribute type. This needs to be done in the
// constructor in order to make the associated variables "final".
{
"( 1.3.6.1.1.16.4 NAME 'entryUUID' DESC 'UUID of the entry' " +
"EQUALITY uuidMatch ORDERING uuidOrderingMatch " +
"SYNTAX 1.3.6.1.1.16.1 SINGLE-VALUE NO-USER-MODIFICATION " +
"USAGE directoryOperation X-ORIGIN 'RFC 4530' )";
AttributeUsage.DIRECTORY_OPERATION, false, true,
false, true);
}
entryUUIDType = at;
}
/**
* {@inheritDoc}
*/
@Override()
throws ConfigException
{
// Make sure that the plugin has been enabled for the appropriate types.
for (PluginType t : pluginTypes)
{
switch (t)
{
case LDIF_IMPORT:
case PRE_OPERATION_ADD:
// These are acceptable.
break;
default:
throw new ConfigException(message);
}
}
}
/**
* {@inheritDoc}
*/
@Override()
public final void finalizePlugin()
{
}
/**
* {@inheritDoc}
*/
@Override()
public final PluginResult.ImportLDIF
{
// See if the entry being imported already contains an entryUUID attribute.
// If so, then leave it alone.
{
}
// Construct a new UUID. In order to make sure that UUIDs are consistent
// when the same LDIF is generated on multiple servers, we'll base the UUID
// on the byte representation of the normalized DN.
// We shouldn't ever need to return a non-success result.
}
/**
* {@inheritDoc}
*/
@Override()
public final PluginResult.PreOperation
{
// See if the entry being added already contains an entryUUID attribute.
// It shouldn't, since it's NO-USER-MODIFICATION, but if it does then leave
// it alone.
{
}
// Construct a new random UUID.
// Add the attribute to the entry and return.
}
/**
* {@inheritDoc}
*/
@Override()
{
}
/**
* {@inheritDoc}
*/
public boolean isConfigurationChangeAcceptable(
{
boolean configAcceptable = true;
// Ensure that the set of plugin types contains only LDIF import and
// pre-operation add.
{
switch (pluginType)
{
case LDIFIMPORT:
case PREOPERATIONADD:
// These are acceptable.
break;
default:
pluginType.toString());
configAcceptable = false;
}
}
return configAcceptable;
}
/**
* {@inheritDoc}
*/
{
}
}