/*
|
* 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 2006-2009 Sun Microsystems, Inc.
|
* Portions Copyright 2014 ForgeRock AS
|
*/
|
package org.opends.server.schema;
|
|
|
|
import static org.opends.messages.SchemaMessages.*;
|
import org.forgerock.i18n.slf4j.LocalizedLogger;
|
import static org.opends.server.schema.SchemaConstants.*;
|
import static org.opends.server.schema.StringPrepProfile.*;
|
|
import java.util.Collection;
|
import java.util.Collections;
|
|
import org.forgerock.i18n.LocalizableMessage;
|
import org.opends.server.api.EqualityMatchingRule;
|
import org.opends.server.core.DirectoryServer;
|
import org.forgerock.opendj.ldap.ByteSequence;
|
import org.forgerock.opendj.ldap.ByteString;
|
import org.opends.server.types.DirectoryException;
|
import org.opends.server.types.ResultCode;
|
import org.opends.server.util.ServerConstants;
|
|
|
|
/**
|
* This class implements the caseIgnoreIA5Match matching rule defined in RFC
|
* 2252.
|
*/
|
class CaseIgnoreIA5EqualityMatchingRule
|
extends EqualityMatchingRule
|
{
|
|
private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
|
|
/**
|
* Creates a new instance of this caseIgnoreIA5Match matching rule.
|
*/
|
public CaseIgnoreIA5EqualityMatchingRule()
|
{
|
super();
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override
|
public Collection<String> getNames()
|
{
|
return Collections.singleton(getName());
|
}
|
|
|
|
/**
|
* 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.
|
*/
|
@Override
|
public String getName()
|
{
|
return EMR_CASE_IGNORE_IA5_NAME;
|
}
|
|
|
|
/**
|
* Retrieves the OID for this matching rule.
|
*
|
* @return The OID for this matching rule.
|
*/
|
@Override
|
public String getOID()
|
{
|
return EMR_CASE_IGNORE_IA5_OID;
|
}
|
|
|
|
/**
|
* Retrieves the description for this matching rule.
|
*
|
* @return The description for this matching rule, or <CODE>null</CODE> if
|
* there is none.
|
*/
|
@Override
|
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.
|
*/
|
@Override
|
public String getSyntaxOID()
|
{
|
return SYNTAX_IA5_STRING_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.
|
*/
|
@Override
|
public ByteString normalizeValue(ByteSequence value)
|
throws DirectoryException
|
{
|
StringBuilder buffer = new StringBuilder();
|
prepareUnicode(buffer, value, TRIM, CASE_FOLD);
|
|
int bufferLength = buffer.length();
|
if (bufferLength == 0)
|
{
|
if (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 ServerConstants.SINGLE_SPACE_VALUE;
|
}
|
else
|
{
|
// The value is empty, so it is already normalized.
|
return ByteString.empty();
|
}
|
}
|
|
|
// Replace any consecutive spaces with a single space, and watch out for
|
// non-ASCII characters.
|
boolean logged = false;
|
for (int pos = bufferLength-1; pos > 0; pos--)
|
{
|
char c = buffer.charAt(pos);
|
if (c == ' ')
|
{
|
if (buffer.charAt(pos-1) == ' ')
|
{
|
buffer.delete(pos, pos+1);
|
}
|
}
|
else if ((c & 0x7F) != c)
|
{
|
// This is not a valid character for an IA5 string. If strict syntax
|
// enforcement is enabled, then we'll throw an exception. Otherwise,
|
// we'll get rid of the character.
|
|
LocalizableMessage message = WARN_ATTR_SYNTAX_IA5_ILLEGAL_CHARACTER.get(value, c);
|
|
switch (DirectoryServer.getSyntaxEnforcementPolicy())
|
{
|
case REJECT:
|
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
|
message);
|
case WARN:
|
if (! logged)
|
{
|
logger.error(message);
|
logged = true;
|
}
|
|
buffer.delete(pos, pos+1);
|
break;
|
|
default:
|
buffer.delete(pos, pos+1);
|
break;
|
}
|
}
|
}
|
|
return ByteString.valueOf(buffer.toString());
|
}
|
}
|
