LastModPlugin.java revision 54e2384a2c22191e7df5a2bbf25778dcbcf64368
/*
* 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
* 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
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. 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
*
*
* Portions Copyright 2006 Sun Microsystems, Inc.
*/
/**
* 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
{
/**
* The fully-qualified name of this class for debugging purposes.
*/
private static final String CLASS_NAME =
"org.opends.server.plugins.LastModPlugin";
// The attribute type for the "createTimestamp" attribute.
private final AttributeType createTimestampType;
// The attribute type for the "creatorsName" attribute.
private final AttributeType creatorsNameType;
// The attribute type for the "modifiersName" attribute.
private final AttributeType modifiersNameType;
// The attribute type for the "modifyTimestamp" attribute.
private final AttributeType modifyTimestampType;
/**
* 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();
assert debugConstructor(CLASS_NAME);
// 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}
*/
@Override()
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}
*/
@Override()
public final PreOperationPluginResult
{
// 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.
new ASN1OctetString()));
}
else
{
}
// Create the attribute list for the createTimestamp attribute.
new ASN1OctetString(getUTCTime())));
// We shouldn't ever need to return a non-success result.
return new PreOperationPluginResult();
}
/**
* {@inheritDoc}
*/
@Override()
public final PreOperationPluginResult
{
// 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.
new ASN1OctetString()));
}
else
{
}
try
{
nameAttr));
}
catch (DirectoryException de)
{
// This should never happen.
return new PreOperationPluginResult(false, false, true);
}
// Create the modifyTimestamp attribute.
new ASN1OctetString(getUTCTime())));
try
{
timeAttr));
}
catch (DirectoryException de)
{
// This should never happen.
return new PreOperationPluginResult(false, false, true);
}
// We shouldn't ever need to return a non-success result.
return new PreOperationPluginResult();
}
/**
* {@inheritDoc}
*/
@Override()
public final PreOperationPluginResult
{
// 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.
new ASN1OctetString()));
}
else
{
}
nameAttr));
// Create the modifyTimestamp attribute.
new ASN1OctetString(getUTCTime())));
timeAttr));
// We shouldn't ever need to return a non-success result.
return new PreOperationPluginResult();
}
}