UniqueMemberEqualityMatchingRule.java revision 00870f7dc92907ec0b59c43b783cde7367071ff0
/*
* 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-2007 Sun Microsystems, Inc.
*/
/**
* This class implements the uniqueMemberMatch matching rule defined in X.520
* and referenced in RFC 2252. It is based on the name and optional UID syntax,
* and will compare values with a distinguished name and optional bit string
* suffix.
*/
public class UniqueMemberEqualityMatchingRule
extends EqualityMatchingRule
{
/**
* The tracer object for the debug logger.
*/
/**
* Creates a new instance of this uniqueMemberMatch matching rule.
*/
public UniqueMemberEqualityMatchingRule()
{
super();
}
/**
* {@inheritDoc}
*/
{
// 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.
*/
{
return EMR_UNIQUE_MEMBER_NAME;
}
/**
* Retrieves the OID for this matching rule.
*
* @return The OID for this matching rule.
*/
{
return EMR_UNIQUE_MEMBER_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_NAME_AND_OPTIONAL_UID_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.
*/
throws DirectoryException
{
// See if the value contains the "optional uid" portion. If we think it
// does, then mark its location.
int dnEndPos = valueLength;
int sharpPos = -1;
{
if (sharpPos > 0)
{
}
}
// Take the DN portion of the string and try to normalize it. If it fails,
// then this will throw an exception.
try
{
}
catch (Exception e)
{
if (debugEnabled())
{
}
// We couldn't normalize the DN for some reason. If we're supposed to use
// strict syntax enforcement, then throw an exception. Otherwise, log a
// message and just try our best.
switch (DirectoryServer.getSyntaxEnforcementPolicy())
{
case REJECT:
case WARN:
break;
default:
break;
}
}
// If there is an "optional uid", then normalize it and make sure it only
// contains valid binary digits.
if (sharpPos > 0)
{
boolean logged = false;
{
char c = valueString.charAt(i);
if ((c == '0') || (c == '1'))
{
valueBuffer.append(c);
}
else
{
// There was an invalid binary digit. We'll either throw an exception
// or log a message and continue, based on the server's configuration.
switch (DirectoryServer.getSyntaxEnforcementPolicy())
{
case REJECT:
case WARN:
if (! logged)
{
logged = true;
}
break;
}
}
}
}
}
/**
* 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.
*/
{
// Since the values are already normalized, we just need to compare the
// associated byte arrays.
}
}