/*
* 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.
* Portions Copyright 2014-2015 ForgeRock AS
*/
/**
* This class implements a Directory Server plugin that will add the
* creatorsName and createTimestamp attributes to an entry whenever it is added
* to the server, and will add the modifiersName and modifyTimestamp attributes
* whenever the entry is modified or renamed.
*/
public final class LastModPlugin
extends DirectoryServerPlugin<LastModPluginCfg>
implements ConfigurationChangeListener<LastModPluginCfg>
{
/** The attribute type for the "createTimestamp" attribute. */
/** The attribute type for the "creatorsName" attribute. */
/** The attribute type for the "modifiersName" attribute. */
/** The attribute type for the "modifyTimestamp" 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 LastModPlugin()
{
super();
// Get the attribute types for the attributes that we will use. This needs
// to be done in the constructor in order to make the associated variables "final".
}
/** {@inheritDoc} */
throws ConfigException
{
// Make sure that the plugin has been enabled for the appropriate types.
for (PluginType t : pluginTypes)
{
switch (t)
{
case PRE_OPERATION_ADD:
case PRE_OPERATION_MODIFY:
case PRE_OPERATION_MODIFY_DN:
// These are acceptable.
break;
default:
}
}
}
/** {@inheritDoc} */
public final void finalizePlugin()
{
}
/** {@inheritDoc} */
public final PluginResult.PreOperation
{
// Create the attribute list for the creatorsName attribute, if appropriate.
{
// This must mean that the operation was performed anonymously.
// Even so, we still need to update the creatorsName attribute.
}
else
{
}
// Create the attribute list for the createTimestamp attribute.
// We shouldn't ever need to return a non-success result.
}
/** {@inheritDoc} */
public final PluginResult.PreOperation
{
// Create the modifiersName attribute.
if (modifierDN == null)
{
// This must mean that the operation was performed anonymously.
// Even so, we still need to update the modifiersName attribute.
}
else
{
}
try
{
nameAttr, true));
}
catch (DirectoryException de)
{
// This should never happen.
}
// Create the modifyTimestamp attribute.
try
{
timeAttr, true));
}
catch (DirectoryException de)
{
// This should never happen.
}
// We shouldn't ever need to return a non-success result.
}
/** {@inheritDoc} */
public final PluginResult.PreOperation
{
// Create the modifiersName attribute.
if (modifierDN == null)
{
// This must mean that the operation was performed anonymously.
// Even so, we still need to update the modifiersName attribute.
}
else
{
}
// Create the modifyTimestamp attribute.
// We shouldn't ever need to return a non-success result.
}
/** {@inheritDoc} */
{
}
/** {@inheritDoc} */
{
boolean configAcceptable = true;
// Ensure that the set of plugin types contains only pre-operation add,
// pre-operation modify, and pre-operation modify DN.
{
switch (pluginType)
{
case PREOPERATIONADD:
case PREOPERATIONMODIFY:
case PREOPERATIONMODIFYDN:
// These are acceptable.
break;
default:
configAcceptable = false;
}
}
return configAcceptable;
}
/** {@inheritDoc} */
{
return new ConfigChangeResult();
}
}