CaseIgnoreListEqualityMatchingRule.java revision a395dd575518d9e5280fc5d5d5ef47c61b174647
1216N/A/*
1216N/A * CDDL HEADER START
1216N/A *
1216N/A * The contents of this file are subject to the terms of the
1216N/A * Common Development and Distribution License, Version 1.0 only
1216N/A * (the "License"). You may not use this file except in compliance
1216N/A * with the License.
1216N/A *
1216N/A * You can obtain a copy of the license at
1216N/A * trunk/opends/resource/legal-notices/OpenDS.LICENSE
1216N/A * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
1216N/A * See the License for the specific language governing permissions
1216N/A * and limitations under the License.
1216N/A *
1216N/A * When distributing Covered Code, include this CDDL HEADER in each
1216N/A * file and include the License file at
1216N/A * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
1216N/A * add the following below this CDDL HEADER, with the fields enclosed
1216N/A * by brackets "[]" replaced with your own identifying information:
1216N/A * Portions Copyright [yyyy] [name of copyright owner]
1216N/A *
1216N/A * CDDL HEADER END
3232N/A *
1216N/A *
1216N/A * Copyright 2006-2008 Sun Microsystems, Inc.
1216N/A */
1216N/Apackage org.opends.server.schema;
1216N/A
1216N/A
1216N/A
1216N/Aimport java.util.Arrays;
1216N/A
1216N/Aimport org.opends.server.admin.std.server.EqualityMatchingRuleCfg;
1216N/Aimport org.opends.server.api.EqualityMatchingRule;
1216N/Aimport org.opends.server.config.ConfigException;
import org.opends.server.protocols.asn1.ASN1OctetString;
import org.opends.server.types.ByteString;
import org.opends.server.types.DirectoryException;
import org.opends.server.types.InitializationException;
import static org.opends.server.schema.SchemaConstants.*;
import static org.opends.server.util.StaticUtils.*;
/**
* This class implements the caseIgnoreListMatch matching rule defined in X.520
* and referenced in RFC 2252.
*/
public class CaseIgnoreListEqualityMatchingRule
extends EqualityMatchingRule
{
/**
* Creates a new instance of this caseIgnoreListMatch matching rule.
*/
public CaseIgnoreListEqualityMatchingRule()
{
super();
}
/**
* {@inheritDoc}
*/
public void initializeMatchingRule(EqualityMatchingRuleCfg configuration)
throws ConfigException, InitializationException
{
// No initialization is required.
}
/**
* Retrieves the common name for this matching rule.
*
* @return The common name for this matching rule, or <CODE>null</CODE> if
* it does not have a name.
*/
public String getName()
{
return EMR_CASE_IGNORE_LIST_NAME;
}
/**
* Retrieves the OID for this matching rule.
*
* @return The OID for this matching rule.
*/
public String getOID()
{
return EMR_CASE_IGNORE_LIST_OID;
}
/**
* Retrieves the description for this matching rule.
*
* @return The description for this matching rule, or <CODE>null</CODE> if
* there is none.
*/
public String getDescription()
{
// There is no standard description for this matching rule.
return null;
}
/**
* 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 String getSyntaxOID()
{
return SYNTAX_POSTAL_ADDRESS_OID;
}
/**
* Retrieves the normalized form of the provided value, which is best suited
* for efficiently performing matching operations on that value.
*
* @param value The value to be normalized.
*
* @return The normalized version of the provided value.
*
* @throws DirectoryException If the provided value is invalid according to
* the associated attribute syntax.
*/
public ByteString normalizeValue(ByteString value)
throws DirectoryException
{
StringBuilder buffer = new StringBuilder();
toLowerCase(value.value(), buffer, true);
int bufferLength = buffer.length();
if (bufferLength == 0)
{
if (value.value().length > 0)
{
// This should only happen if the value is composed entirely of spaces.
// In that case, the normalized value is a single space.
return new ASN1OctetString(" ");
}
else
{
// The value is empty, so it is already normalized.
return new ASN1OctetString();
}
}
// Replace any consecutive spaces with a single space. Any spaces around a
// dollar sign will also be removed.
for (int pos = bufferLength-1; pos > 0; pos--)
{
if (buffer.charAt(pos) == ' ')
{
char c = buffer.charAt(pos-1);
if (c == ' ')
{
buffer.delete(pos, pos+1);
}
else if (c == '$')
{
if ((pos <= 1) || (buffer.charAt(pos-2) != '\\'))
{
buffer.delete(pos, pos+1);
}
}
else if (buffer.charAt(pos+1) == '$')
{
buffer.delete(pos, pos+1);
}
}
}
return new ASN1OctetString(buffer.toString());
}
/**
* Indicates whether the two provided normalized values are equal to each
* other.
*
* @param value1 The normalized form of the first value to compare.
* @param value2 The normalized form of the second value to compare.
*
* @return <CODE>true</CODE> if the provided values are equal, or
* <CODE>false</CODE> if not.
*/
public boolean areEqual(ByteString value1, ByteString value2)
{
// Since the values are already normalized, we just need to compare the
// associated byte arrays.
return Arrays.equals(value1.value(), value2.value());
}
}