EntryUUIDVirtualAttributeProvider.java revision a395dd575518d9e5280fc5d5d5ef47c61b174647
/*
* 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
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
* 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
*
*
* Copyright 2008 Sun Microsystems, Inc.
*/
package org.opends.server.extensions;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.UUID;
import org.opends.messages.Message;
import org.opends.server.admin.std.server.EntryUUIDVirtualAttributeCfg;
import org.opends.server.api.VirtualAttributeProvider;
import org.opends.server.config.ConfigException;
import org.opends.server.core.SearchOperation;
import org.opends.server.loggers.debug.DebugTracer;
import org.opends.server.types.AttributeValue;
import org.opends.server.types.ByteString;
import org.opends.server.types.ByteStringFactory;
import org.opends.server.types.ConditionResult;
import org.opends.server.types.DebugLogLevel;
import org.opends.server.types.Entry;
import org.opends.server.types.InitializationException;
import org.opends.server.types.ResultCode;
import org.opends.server.types.VirtualAttributeRule;
import static org.opends.messages.ExtensionMessages.*;
import static org.opends.server.loggers.debug.DebugLogger.*;
import static org.opends.server.util.ServerConstants.*;
import static org.opends.server.util.StaticUtils.*;
/**
* This class implements a virtual attribute provider that is meant to serve the
* entryUUID operational attribute as described in RFC 4530. Note that this
* should only be used for entries used in conjuntion with data in private
* backends (e.g., those holding the configuration, schema, monitor, and root
* DSE entries). Real user data should have entry UUID values generated at the
* time the entries are added or imported.
*/
public class EntryUUIDVirtualAttributeProvider
extends VirtualAttributeProvider<EntryUUIDVirtualAttributeCfg>
{
/**
* The tracer object for the debug logger.
*/
private static final DebugTracer TRACER = getTracer();
/**
* Creates a new instance of this entryUUID virtual attribute provider.
*/
public EntryUUIDVirtualAttributeProvider()
{
super();
// All initialization should be performed in the
// initializeVirtualAttributeProvider method.
}
/**
* {@inheritDoc}
*/
@Override()
public void initializeVirtualAttributeProvider(
EntryUUIDVirtualAttributeCfg configuration)
throws ConfigException, InitializationException
{
// No initialization is required.
}
/**
* {@inheritDoc}
*/
@Override()
public boolean isMultiValued()
{
return false;
}
/**
* {@inheritDoc}
*/
@Override()
public LinkedHashSet<AttributeValue> getValues(Entry entry,
VirtualAttributeRule rule)
{
LinkedHashSet<AttributeValue> values = new LinkedHashSet<AttributeValue>(1);
String normDNString = entry.getDN().toNormalizedString();
String uuidString =
UUID.nameUUIDFromBytes(getBytes(normDNString)).toString();
values.add(new AttributeValue(ByteStringFactory.create(uuidString),
ByteStringFactory.create(uuidString)));
return values;
}
/**
* {@inheritDoc}
*/
@Override()
public boolean hasValue(Entry entry, VirtualAttributeRule rule)
{
// This virtual attribute provider will always generate a value.
return true;
}
/**
* {@inheritDoc}
*/
@Override()
public boolean hasValue(Entry entry, VirtualAttributeRule rule,
AttributeValue value)
{
try
{
String normalizedDN = entry.getDN().toNormalizedString();
String uuidString =
UUID.nameUUIDFromBytes(getBytes(normalizedDN)).toString();
String normalizedValue = value.getNormalizedStringValue();
return uuidString.equals(normalizedValue);
}
catch (Exception e)
{
if (debugEnabled())
{
TRACER.debugCaught(DebugLogLevel.ERROR, e);
}
return false;
}
}
/**
* {@inheritDoc}
*/
@Override()
public ConditionResult matchesSubstring(Entry entry,
VirtualAttributeRule rule,
ByteString subInitial,
List<ByteString> subAny,
ByteString subFinal)
{
// DNs cannot be used in substring matching.
return ConditionResult.UNDEFINED;
}
/**
* {@inheritDoc}
*/
@Override()
public ConditionResult greaterThanOrEqualTo(Entry entry,
VirtualAttributeRule rule,
AttributeValue value)
{
// DNs cannot be used in ordering matching.
return ConditionResult.UNDEFINED;
}
/**
* {@inheritDoc}
*/
@Override()
public ConditionResult lessThanOrEqualTo(Entry entry,
VirtualAttributeRule rule,
AttributeValue value)
{
// DNs cannot be used in ordering matching.
return ConditionResult.UNDEFINED;
}
/**
* {@inheritDoc}
*/
@Override()
public ConditionResult approximatelyEqualTo(Entry entry,
VirtualAttributeRule rule,
AttributeValue value)
{
// DNs cannot be used in approximate matching.
return ConditionResult.UNDEFINED;
}
/**
* {@inheritDoc}. This virtual attribute will support search operations only
* if one of the following is true about the search filter:
* <UL>
* <LI>It is an equality filter targeting the associated attribute
* type.</LI>
* <LI>It is an AND filter in which at least one of the components is an
* equality filter targeting the associated attribute type.</LI>
* <LI>It is an OR filter in which all of the components are equality
* filters targeting the associated attribute type.</LI>
* </UL>
*/
@Override()
public boolean isSearchable(VirtualAttributeRule rule,
SearchOperation searchOperation)
{
return false;
}
/**
* {@inheritDoc}
*/
@Override()
public void processSearch(VirtualAttributeRule rule,
SearchOperation searchOperation)
{
searchOperation.setResultCode(ResultCode.UNWILLING_TO_PERFORM);
Message message = ERR_ENTRYUUID_VATTR_NOT_SEARCHABLE.get(
rule.getAttributeType().getNameOrOID());
searchOperation.appendErrorMessage(message);
}
}