/*
|
* 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
|
* or http://forgerock.org/license/CDDLv1.0.html.
|
* 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 2009 Sun Microsystems, Inc.
|
* Portions Copyright 2014 ForgeRock AS
|
*/
|
package org.opends.server.api;
|
|
|
|
import java.util.Collection;
|
|
import org.forgerock.opendj.ldap.ByteSequence;
|
import org.forgerock.opendj.ldap.ByteString;
|
import org.forgerock.opendj.ldap.schema.Schema;
|
import org.forgerock.opendj.ldap.schema.Syntax;
|
import org.opends.server.types.ConditionResult;
|
import org.opends.server.types.DirectoryException;
|
|
|
|
/**
|
* This class provides default implementation of MatchingRule. A
|
* matching rule implemented by a Directory Server module must extend
|
* this class.
|
*/
|
@org.opends.server.types.PublicAPI(
|
stability = org.opends.server.types.StabilityLevel.VOLATILE,
|
mayInstantiate = false,
|
mayExtend = true,
|
mayInvoke = false)
|
public abstract class AbstractMatchingRule implements MatchingRule
|
{
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override
|
public ByteString normalizeAssertionValue(ByteSequence value)
|
throws DirectoryException
|
{
|
// Default implementation is to use attribute value normalization.
|
return normalizeValue(value);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override
|
public final String getNameOrOID()
|
{
|
Collection<String> names = getNames();
|
if (names != null && !names.isEmpty())
|
{
|
return names.iterator().next();
|
}
|
return getOID();
|
}
|
|
/**
|
* Retrieves the OID of the syntax with which this matching rule is
|
* associated.
|
*
|
* @return The OID of the syntax with which this matching rule is
|
* associated.
|
*/
|
public abstract String getSyntaxOID();
|
|
/** {@inheritDoc} */
|
@Override
|
public Syntax getSyntax()
|
{
|
return Schema.getCoreSchema().getSyntax(getSyntaxOID());
|
}
|
|
/** {@inheritDoc} */
|
@Override
|
public boolean isObsolete()
|
{
|
return false;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override
|
public abstract ByteString normalizeValue(ByteSequence value)
|
throws DirectoryException;
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override
|
public ConditionResult valuesMatch(
|
ByteSequence attributeValue, ByteSequence assertionValue)
|
{
|
//Default implementation of most rule types.
|
return ConditionResult.UNDEFINED;
|
}
|
|
|
|
/**
|
* Retrieves the hash code for this matching rule. It will be
|
* calculated as the sum of the characters in the OID.
|
*
|
* @return The hash code for this matching rule.
|
*/
|
@Override
|
public final int hashCode()
|
{
|
int hashCode = 0;
|
|
String oidString = getOID();
|
int oidLength = oidString.length();
|
for (int i = 0; i < oidLength; i++)
|
{
|
hashCode += oidString.charAt(i);
|
}
|
|
return hashCode;
|
}
|
|
|
|
/**
|
* Indicates whether the provided object is equal to this matching
|
* rule. The provided object will be considered equal to this
|
* matching rule only if it is a matching rule with the same OID.
|
*
|
* @param o
|
* The object for which to make the determination.
|
* @return {@code true} if the provided object is equal to this
|
* matching rule, or {@code false} if it is not.
|
*/
|
@Override
|
public final boolean equals(Object o)
|
{
|
if (o == null)
|
{
|
return false;
|
}
|
|
if (this == o)
|
{
|
return true;
|
}
|
|
if (!(o instanceof MatchingRule))
|
{
|
return false;
|
}
|
|
return getOID().equals(((MatchingRule) o).getOID());
|
}
|
|
|
|
/**
|
* Retrieves a string representation of this matching rule in the
|
* format defined in RFC 2252.
|
*
|
* @return A string representation of this matching rule in the
|
* format defined in RFC 2252.
|
*/
|
@Override
|
public final String toString()
|
{
|
StringBuilder buffer = new StringBuilder();
|
toString(buffer);
|
return buffer.toString();
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override
|
public final void toString(StringBuilder buffer)
|
{
|
buffer.append("( ");
|
buffer.append(getOID());
|
buffer.append(" NAME ");
|
Collection<String> names = getNames();
|
if(names.size()>1)
|
{
|
buffer.append("(");
|
for(String name: names)
|
{
|
buffer.append(" '");
|
buffer.append(name);
|
buffer.append('\'');
|
}
|
buffer.append(" )");
|
}
|
else if (names.size() == 1)
|
{
|
buffer.append('\'');
|
buffer.append(names.iterator().next());
|
buffer.append('\'');
|
}
|
|
String description = getDescription();
|
if ((description != null) && (description.length() > 0))
|
{
|
buffer.append(" DESC '");
|
buffer.append(description);
|
buffer.append('\'');
|
}
|
|
if (isObsolete())
|
{
|
buffer.append("' OBSOLETE SYNTAX ");
|
}
|
else
|
{
|
buffer.append(" SYNTAX ");
|
}
|
|
buffer.append(getSyntax().getOID());
|
buffer.append(" )");
|
}
|
}
|
