/*
|
* 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
|
*
|
*
|
* Portions Copyright 2006-2007 Sun Microsystems, Inc.
|
*/
|
package org.opends.server.api;
|
|
|
|
import java.util.ArrayList;
|
import java.util.Collection;
|
import java.util.LinkedHashSet;
|
import java.util.List;
|
|
import org.opends.server.admin.std.server.VirtualAttributeCfg;
|
import org.opends.server.config.ConfigException;
|
import org.opends.server.core.SearchOperation;
|
import org.opends.server.types.AttributeValue;
|
import org.opends.server.types.ByteString;
|
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.VirtualAttributeRule;
|
|
import static org.opends.server.loggers.debug.DebugLogger.*;
|
|
|
|
/**
|
* This class defines the set of methods and structures that must be
|
* implemented by a Directory Server module that implements the
|
* functionality required for one or more virtual attributes.
|
*
|
* @param <T> The type of configuration handled by this virtual
|
* attribute provider.
|
*/
|
public abstract class VirtualAttributeProvider
|
<T extends VirtualAttributeCfg>
|
{
|
/**
|
* Initializes this virtual attribute based on the information in
|
* the provided configuration entry.
|
*
|
* @param configuration The configuration to use to initialize
|
* this virtual attribute provider.
|
*
|
* @throws ConfigException If an unrecoverable problem arises in
|
* the process of performing the
|
* initialization.
|
*
|
* @throws InitializationException If a problem occurs during
|
* initialization that is not
|
* related to the server
|
* configuration.
|
*/
|
public abstract void initializeVirtualAttributeProvider(
|
T configuration)
|
throws ConfigException, InitializationException;
|
|
|
|
/**
|
* Performs any finalization that may be necessary whenever this
|
* virtual attribute provider is taken out of service.
|
*/
|
public void finalizeVirtualAttributeProvider()
|
{
|
// No implementation required by default.
|
}
|
|
|
|
/**
|
* Indicates whether this virtual attribute provider may generate
|
* multiple values.
|
*
|
* @return {@code true} if this virtual attribute provider may
|
* generate multiple values, or {@code false} if not.
|
*/
|
public abstract boolean isMultiValued();
|
|
|
|
/**
|
* Generates a set of values for the provided entry.
|
*
|
* @param entry The entry for which the values are to be
|
* generated.
|
* @param rule The virtual attribute rule which defines the
|
* constraints for the virtual attribute.
|
*
|
* @return The set of values generated for the provided entry. It
|
* may be empty, but it must not be {@code null}.
|
*/
|
public abstract LinkedHashSet<AttributeValue>
|
getValues(Entry entry,
|
VirtualAttributeRule rule);
|
|
|
|
/**
|
* Indicates whether this virtual attribute provider will generate
|
* at least one value for the provided entry.
|
*
|
* @param entry The entry for which to make the determination.
|
* @param rule The virtual attribute rule which defines the
|
* constraints for the virtual attribute.
|
*
|
* @return {@code true} if this virtual attribute provider will
|
* generate at least one value for the provided entry, or
|
* {@code false} if not.
|
*/
|
public boolean hasValue(Entry entry, VirtualAttributeRule rule)
|
{
|
return (! getValues(entry, rule).isEmpty());
|
}
|
|
|
|
/**
|
* Indicates whether this virtual attribute provider will generate
|
* the provided value.
|
*
|
* @param entry The entry for which to make the determination.
|
* @param rule The virtual attribute rule which defines the
|
* constraints for the virtual attribute.
|
* @param value The value for which to make the determination.
|
*
|
* @return {@code true} if this virtual attribute provider will
|
* generate the specified vaule for the provided entry, or
|
* {@code false} if not.
|
*/
|
public boolean hasValue(Entry entry, VirtualAttributeRule rule,
|
AttributeValue value)
|
{
|
return getValues(entry, rule).contains(value);
|
}
|
|
|
|
/**
|
* Indicates whether this virtual attribute provider will generate
|
* all of the values in the provided collection.
|
*
|
* @param entry The entry for which to make the determination.
|
* @param rule The virtual attribute rule which defines the
|
* constraints for the virtual attribute.
|
* @param values The set of values for which to make the
|
* determination.
|
*
|
* @return {@code true} if this attribute provider will generate
|
* all of the values in the provided collection, or
|
* {@code false} if it will not generate at least one of
|
* them.
|
*/
|
public boolean hasAllValues(Entry entry, VirtualAttributeRule rule,
|
Collection<AttributeValue> values)
|
{
|
for (AttributeValue value : values)
|
{
|
if (! getValues(entry, rule).contains(value))
|
{
|
return false;
|
}
|
}
|
|
return true;
|
}
|
|
|
|
/**
|
* Indicates whether this virutal attribute provider will generate
|
* any of the values in the provided collection.
|
*
|
* @param entry The entry for which to make the determination.
|
* @param rule The virtual attribute rule which defines the
|
* constraints for the virtual attribute.
|
* @param values The set of values for which to make the
|
* determination.
|
*
|
* @return {@code true} if this attribute provider will generate
|
* at least one of the values in the provided collection,
|
* or {@code false} if it will not generate any of them.
|
*/
|
public boolean hasAnyValue(Entry entry, VirtualAttributeRule rule,
|
Collection<AttributeValue> values)
|
{
|
for (AttributeValue value : values)
|
{
|
if (getValues(entry, rule).contains(value))
|
{
|
return true;
|
}
|
}
|
|
return false;
|
}
|
|
|
|
/**
|
* Indicates whether this virtual attribute provider will generate
|
* any value which matches the provided substring.
|
*
|
* @param entry The entry for which to make the
|
* determination.
|
* @param rule The virtual attribute rule which defines the
|
* constraints for the virtual attribute.
|
* @param subInitial The subInitial component to use in the
|
* determination.
|
* @param subAny The subAny components to use in the
|
* determination.
|
* @param subFinal The subFinal component to use in the
|
* determination.
|
*
|
* @return <CODE>UNDEFINED</CODE> if this attribute does not have a
|
* substring matching rule, <CODE>TRUE</CODE> if at least
|
* one value matches the provided substring, or
|
* <CODE>FALSE</CODE> otherwise.
|
*/
|
public ConditionResult matchesSubstring(Entry entry,
|
VirtualAttributeRule rule,
|
ByteString subInitial,
|
List<ByteString> subAny,
|
ByteString subFinal)
|
{
|
SubstringMatchingRule matchingRule =
|
rule.getAttributeType().getSubstringMatchingRule();
|
if (matchingRule == null)
|
{
|
return ConditionResult.UNDEFINED;
|
}
|
|
|
ByteString normalizedSubInitial;
|
if (subInitial == null)
|
{
|
normalizedSubInitial = null;
|
}
|
else
|
{
|
try
|
{
|
normalizedSubInitial =
|
matchingRule.normalizeSubstring(subInitial);
|
}
|
catch (Exception e)
|
{
|
if (debugEnabled())
|
{
|
debugCaught(DebugLogLevel.ERROR, e);
|
}
|
|
// The substring couldn't be normalized. We have to return
|
// "undefined".
|
return ConditionResult.UNDEFINED;
|
}
|
}
|
|
|
ArrayList<ByteString> normalizedSubAny;
|
if (subAny == null)
|
{
|
normalizedSubAny = null;
|
}
|
else
|
{
|
normalizedSubAny =
|
new ArrayList<ByteString>(subAny.size());
|
for (ByteString subAnyElement : subAny)
|
{
|
try
|
{
|
normalizedSubAny.add(matchingRule.normalizeSubstring(
|
subAnyElement));
|
}
|
catch (Exception e)
|
{
|
if (debugEnabled())
|
{
|
debugCaught(DebugLogLevel.ERROR, e);
|
}
|
|
// The substring couldn't be normalized. We have to return
|
// "undefined".
|
return ConditionResult.UNDEFINED;
|
}
|
}
|
}
|
|
|
ByteString normalizedSubFinal;
|
if (subFinal == null)
|
{
|
normalizedSubFinal = null;
|
}
|
else
|
{
|
try
|
{
|
normalizedSubFinal =
|
matchingRule.normalizeSubstring(subFinal);
|
}
|
catch (Exception e)
|
{
|
if (debugEnabled())
|
{
|
debugCaught(DebugLogLevel.ERROR, e);
|
}
|
|
// The substring couldn't be normalized. We have to return
|
// "undefined".
|
return ConditionResult.UNDEFINED;
|
}
|
}
|
|
|
ConditionResult result = ConditionResult.FALSE;
|
for (AttributeValue value : getValues(entry, rule))
|
{
|
try
|
{
|
if (matchingRule.valueMatchesSubstring(
|
value.getNormalizedValue(),
|
normalizedSubInitial,
|
normalizedSubAny,
|
normalizedSubFinal))
|
{
|
return ConditionResult.TRUE;
|
}
|
}
|
catch (Exception e)
|
{
|
if (debugEnabled())
|
{
|
debugCaught(DebugLogLevel.ERROR, e);
|
}
|
|
// The value couldn't be normalized. If we can't find a
|
// definite match, then we should return "undefined".
|
result = ConditionResult.UNDEFINED;
|
}
|
}
|
|
return result;
|
}
|
|
|
|
/**
|
* Indicates whether this virtual attribute provider will generate
|
* any value for the provided entry that is greater than or equal to
|
* the given value.
|
*
|
* @param entry The entry for which to make the determination.
|
* @param rule The virtual attribute rule which defines the
|
* constraints for the virtual attribute.
|
* @param value The value for which to make the determination.
|
*
|
* @return {@code UNDEFINED} if the associated attribute type does
|
* not have an ordering matching rule, {@code TRUE} if at
|
* least one of the generated values will be greater than
|
* or equal to the specified value, or {@code FALSE} if
|
* none of the generated values will be greater than or
|
* equal to the specified value.
|
*/
|
public ConditionResult greaterThanOrEqualTo(Entry entry,
|
VirtualAttributeRule rule,
|
AttributeValue value)
|
{
|
OrderingMatchingRule matchingRule =
|
rule.getAttributeType().getOrderingMatchingRule();
|
if (matchingRule == null)
|
{
|
return ConditionResult.UNDEFINED;
|
}
|
|
ByteString normalizedValue;
|
try
|
{
|
normalizedValue = value.getNormalizedValue();
|
}
|
catch (Exception e)
|
{
|
if (debugEnabled())
|
{
|
debugCaught(DebugLogLevel.ERROR, e);
|
}
|
|
// We couldn't normalize the provided value. We should return
|
// "undefined".
|
return ConditionResult.UNDEFINED;
|
}
|
|
ConditionResult result = ConditionResult.FALSE;
|
for (AttributeValue v : getValues(entry, rule))
|
{
|
try
|
{
|
ByteString nv = v.getNormalizedValue();
|
int comparisonResult =
|
matchingRule.compareValues(nv, normalizedValue);
|
if (comparisonResult >= 0)
|
{
|
return ConditionResult.TRUE;
|
}
|
}
|
catch (Exception e)
|
{
|
if (debugEnabled())
|
{
|
debugCaught(DebugLogLevel.ERROR, e);
|
}
|
|
// We couldn't normalize one of the attribute values. If we
|
// can't find a definite match, then we should return
|
// "undefined".
|
result = ConditionResult.UNDEFINED;
|
}
|
}
|
|
return result;
|
}
|
|
|
|
/**
|
* Indicates whether this virtual attribute provider will generate
|
* any value for the provided entry that is less than or equal to
|
* the given value.
|
*
|
* @param entry The entry for which to make the determination.
|
* @param rule The virtual attribute rule which defines the
|
* constraints for the virtual attribute.
|
* @param value The value for which to make the determination.
|
*
|
* @return {@code UNDEFINED} if the associated attribute type does
|
* not have an ordering matching rule, {@code TRUE} if at
|
* least one of the generated values will be less than or
|
* equal to the specified value, or {@code FALSE} if none
|
* of the generated values will be greater than or equal to
|
* the specified value.
|
*/
|
public ConditionResult lessThanOrEqualTo(Entry entry,
|
VirtualAttributeRule rule,
|
AttributeValue value)
|
{
|
OrderingMatchingRule matchingRule =
|
rule.getAttributeType().getOrderingMatchingRule();
|
if (matchingRule == null)
|
{
|
return ConditionResult.UNDEFINED;
|
}
|
|
ByteString normalizedValue;
|
try
|
{
|
normalizedValue = value.getNormalizedValue();
|
}
|
catch (Exception e)
|
{
|
if (debugEnabled())
|
{
|
debugCaught(DebugLogLevel.ERROR, e);
|
}
|
|
// We couldn't normalize the provided value. We should return
|
// "undefined".
|
return ConditionResult.UNDEFINED;
|
}
|
|
ConditionResult result = ConditionResult.FALSE;
|
for (AttributeValue v : getValues(entry, rule))
|
{
|
try
|
{
|
ByteString nv = v.getNormalizedValue();
|
int comparisonResult =
|
matchingRule.compareValues(nv, normalizedValue);
|
if (comparisonResult <= 0)
|
{
|
return ConditionResult.TRUE;
|
}
|
}
|
catch (Exception e)
|
{
|
if (debugEnabled())
|
{
|
debugCaught(DebugLogLevel.ERROR, e);
|
}
|
|
// We couldn't normalize one of the attribute values. If we
|
// can't find a definite match, then we should return
|
// "undefined".
|
result = ConditionResult.UNDEFINED;
|
}
|
}
|
|
return result;
|
}
|
|
|
|
/**
|
* Indicates whether this virtual attribute provider will generate
|
* any value for the provided entry that is approximately equal to
|
* the given value.
|
*
|
* @param entry The entry for which to make the determination.
|
* @param rule The virtual attribute rule which defines the
|
* constraints for the virtual attribute.
|
* @param value The value for which to make the determination.
|
*
|
* @return {@code UNDEFINED} if the associated attribute type does
|
* not have an aproximate matching rule, {@code TRUE} if at
|
* least one of the generated values will be approximately
|
* equal to the specified value, or {@code FALSE} if none
|
* of the generated values will be approximately equal to
|
* the specified value.
|
*/
|
public ConditionResult approximatelyEqualTo(Entry entry,
|
VirtualAttributeRule rule,
|
AttributeValue value)
|
{
|
ApproximateMatchingRule matchingRule =
|
rule.getAttributeType().getApproximateMatchingRule();
|
if (matchingRule == null)
|
{
|
return ConditionResult.UNDEFINED;
|
}
|
|
ByteString normalizedValue;
|
try
|
{
|
normalizedValue = matchingRule.normalizeValue(value.getValue());
|
}
|
catch (Exception e)
|
{
|
if (debugEnabled())
|
{
|
debugCaught(DebugLogLevel.ERROR, e);
|
}
|
|
// We couldn't normalize the provided value. We should return
|
// "undefined".
|
return ConditionResult.UNDEFINED;
|
}
|
|
ConditionResult result = ConditionResult.FALSE;
|
for (AttributeValue v : getValues(entry, rule))
|
{
|
try
|
{
|
ByteString nv = matchingRule.normalizeValue(v.getValue());
|
if (matchingRule.approximatelyMatch(nv, normalizedValue))
|
{
|
return ConditionResult.TRUE;
|
}
|
}
|
catch (Exception e)
|
{
|
if (debugEnabled())
|
{
|
debugCaught(DebugLogLevel.ERROR, e);
|
}
|
|
// We couldn't normalize one of the attribute values. If we
|
// can't find a definite match, then we should return
|
// "undefined".
|
result = ConditionResult.UNDEFINED;
|
}
|
}
|
|
return result;
|
}
|
|
|
|
/**
|
* Indicates whether this attribute may be included in search
|
* filters as part of the criteria for locating entries.
|
*
|
* @param rule The virtual attribute rule which defines
|
* the constraints for the virtual
|
* attribute.
|
* @param searchOperation The search operation for which to make
|
* the determination.
|
*
|
* @return <CODE>true</CODE> if this attribute may be included in
|
* search filters, or <CODE>false</CODE> if not.
|
*/
|
public abstract boolean isSearchable(VirtualAttributeRule rule,
|
SearchOperation
|
searchOperation);
|
|
|
|
/**
|
* Processes the provided search operation in which the search
|
* criteria includes an operation targeted at this virtual
|
* attribute. This method should only be called if
|
* <CODE>isSearchable</CODE> returns true and it is not possible to
|
* construct a manageable candidate list by processing other
|
* elements of the search criteria.
|
*
|
* @param rule The virtual attribute rule which defines
|
* the constraints for the virtual
|
* attribute.
|
* @param searchOperation The search operation to be processed.
|
*/
|
public abstract void processSearch(VirtualAttributeRule rule,
|
SearchOperation searchOperation);
|
}
|
