/*
* 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/nasutekds/resource/legal-notices/NasuTekDS.LICENSE
* or https://NasuTekDS.dev.java.net/NasuTekDS.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/nasutekds/resource/legal-notices/NasuTekDS.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
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
*/
package org.nasutekds.server.schema;
import static org.nasutekds.messages.SchemaMessages.*;
import static org.nasutekds.server.loggers.ErrorLogger.*;
import static org.nasutekds.server.schema.SchemaConstants.*;
import java.util.Collection;
import java.util.Collections;
import org.nasutekds.messages.Message;
import org.nasutekds.server.api.EqualityMatchingRule;
import org.nasutekds.server.core.DirectoryServer;
import org.nasutekds.server.types.ByteSequence;
import org.nasutekds.server.types.ByteString;
import org.nasutekds.server.types.DirectoryException;
import org.nasutekds.server.types.ResultCode;
/**
* This class defines the bitStringMatch matching rule defined in X.520 and
* referenced in RFC 2252.
*/
class BitStringEqualityMatchingRule
extends EqualityMatchingRule
{
/**
* Creates a new instance of this bitStringMatch matching rule.
*/
public BitStringEqualityMatchingRule()
{
super();
}
/**
* {@inheritDoc}
*/
@Override
public Collection<String> getAllNames()
{
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_BIT_STRING_NAME;
}
/**
* Retrieves the OID for this matching rule.
*
* @return The OID for this matching rule.
*/
@Override
public String getOID()
{
return EMR_BIT_STRING_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_BIT_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
{
String valueString = value.toString().toUpperCase();
int length = valueString.length();
if (length < 3)
{
Message message = WARN_ATTR_SYNTAX_BIT_STRING_TOO_SHORT.get(
value.toString());
switch (DirectoryServer.getSyntaxEnforcementPolicy())
{
case REJECT:
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
message);
case WARN:
logError(message);
return ByteString.valueOf(valueString);
default:
return ByteString.valueOf(valueString);
}
}
if ((valueString.charAt(0) != '\'') ||
(valueString.charAt(length-2) != '\'') ||
(valueString.charAt(length-1) != 'B'))
{
Message message = WARN_ATTR_SYNTAX_BIT_STRING_NOT_QUOTED.get(
value.toString());
switch (DirectoryServer.getSyntaxEnforcementPolicy())
{
case REJECT:
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
message);
case WARN:
logError(
message);
return ByteString.valueOf(valueString);
default:
return ByteString.valueOf(valueString);
}
}
for (int i=1; i < (length-2); i++)
{
switch (valueString.charAt(i))
{
case '0':
case '1':
// These characters are fine.
break;
default:
Message message = WARN_ATTR_SYNTAX_BIT_STRING_INVALID_BIT.get(
value.toString(), String.valueOf(valueString.charAt(i)));
switch (DirectoryServer.getSyntaxEnforcementPolicy())
{
case REJECT:
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
message);
case WARN:
logError(message);
return ByteString.valueOf(valueString);
default:
return ByteString.valueOf(valueString);
}
}
}
return ByteString.valueOf(valueString);
}
}