/*
|
* 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/opends/resource/legal-notices/OpenDS.LICENSE
|
* or https://OpenDS.dev.java.net/OpenDS.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/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
|
*
|
*
|
* Copyright 2009 Sun Microsystems, Inc.
|
*/
|
|
package org.opends.sdk.schema;
|
|
|
|
import static com.sun.opends.sdk.util.Messages.WARN_ATTR_SYNTAX_PRINTABLE_STRING_EMPTY_VALUE;
|
import static com.sun.opends.sdk.util.Messages.WARN_ATTR_SYNTAX_PRINTABLE_STRING_ILLEGAL_CHARACTER;
|
import static org.opends.sdk.schema.SchemaConstants.*;
|
|
import com.sun.opends.sdk.util.MessageBuilder;
|
import org.opends.sdk.util.ByteSequence;
|
|
|
|
/**
|
* This class implements the printable string attribute syntax, which is
|
* simply a string of characters from a limited ASCII character set
|
* (uppercase and lowercase letters, numeric digits, the space, and a
|
* set of various symbols). By default, they will be treated in a
|
* case-insensitive manner, and equality, ordering, substring, and
|
* approximate matching will be allowed.
|
*/
|
final class PrintableStringSyntaxImpl extends AbstractSyntaxImpl
|
{
|
|
/**
|
* Indicates whether the provided character is a valid printable
|
* character.
|
*
|
* @param c
|
* The character for which to make the determination.
|
* @return <CODE>true</CODE> if the provided character is a printable
|
* character, or <CODE>false</CODE> if not.
|
*/
|
static boolean isPrintableCharacter(char c)
|
{
|
switch (c)
|
{
|
case 'a':
|
case 'b':
|
case 'c':
|
case 'd':
|
case 'e':
|
case 'f':
|
case 'g':
|
case 'h':
|
case 'i':
|
case 'j':
|
case 'k':
|
case 'l':
|
case 'm':
|
case 'n':
|
case 'o':
|
case 'p':
|
case 'q':
|
case 'r':
|
case 's':
|
case 't':
|
case 'u':
|
case 'v':
|
case 'w':
|
case 'x':
|
case 'y':
|
case 'z':
|
case 'A':
|
case 'B':
|
case 'C':
|
case 'D':
|
case 'E':
|
case 'F':
|
case 'G':
|
case 'H':
|
case 'I':
|
case 'J':
|
case 'K':
|
case 'L':
|
case 'M':
|
case 'N':
|
case 'O':
|
case 'P':
|
case 'Q':
|
case 'R':
|
case 'S':
|
case 'T':
|
case 'U':
|
case 'V':
|
case 'W':
|
case 'X':
|
case 'Y':
|
case 'Z':
|
case '0':
|
case '1':
|
case '2':
|
case '3':
|
case '4':
|
case '5':
|
case '6':
|
case '7':
|
case '8':
|
case '9':
|
case '\'':
|
case '(':
|
case ')':
|
case '+':
|
case ',':
|
case '-':
|
case '.':
|
case '=':
|
case '/':
|
case ':':
|
case '?':
|
case ' ':
|
return true;
|
default:
|
return false;
|
}
|
}
|
|
|
|
@Override
|
public String getApproximateMatchingRule()
|
{
|
return AMR_DOUBLE_METAPHONE_OID;
|
}
|
|
|
|
@Override
|
public String getEqualityMatchingRule()
|
{
|
return EMR_CASE_IGNORE_OID;
|
}
|
|
|
|
public String getName()
|
{
|
return SYNTAX_PRINTABLE_STRING_NAME;
|
}
|
|
|
|
@Override
|
public String getOrderingMatchingRule()
|
{
|
return OMR_CASE_IGNORE_OID;
|
}
|
|
|
|
@Override
|
public String getSubstringMatchingRule()
|
{
|
return SMR_CASE_IGNORE_OID;
|
}
|
|
|
|
public boolean isHumanReadable()
|
{
|
return true;
|
}
|
|
|
|
/**
|
* Indicates whether the provided value is acceptable for use in an
|
* attribute with this syntax. If it is not, then the reason may be
|
* appended to the provided buffer.
|
*
|
* @param schema
|
* The schema in which this syntax is defined.
|
* @param value
|
* The value for which to make the determination.
|
* @param invalidReason
|
* The buffer to which the invalid reason should be appended.
|
* @return <CODE>true</CODE> if the provided value is acceptable for
|
* use with this syntax, or <CODE>false</CODE> if not.
|
*/
|
public boolean valueIsAcceptable(Schema schema, ByteSequence value,
|
MessageBuilder invalidReason)
|
{
|
// Check to see if the provided value was null. If so, then that's
|
// not acceptable.
|
if (value == null)
|
{
|
|
invalidReason
|
.append(WARN_ATTR_SYNTAX_PRINTABLE_STRING_EMPTY_VALUE.get());
|
return false;
|
}
|
|
// Get the value as a string and determine its length. If it is
|
// empty, then that's not acceptable.
|
final String valueString = value.toString();
|
final int valueLength = valueString.length();
|
if (valueLength == 0)
|
{
|
|
invalidReason
|
.append(WARN_ATTR_SYNTAX_PRINTABLE_STRING_EMPTY_VALUE.get());
|
return false;
|
}
|
|
// Iterate through all the characters and see if they are
|
// acceptable.
|
for (int i = 0; i < valueLength; i++)
|
{
|
final char c = valueString.charAt(i);
|
if (!isPrintableCharacter(c))
|
{
|
|
invalidReason
|
.append(WARN_ATTR_SYNTAX_PRINTABLE_STRING_ILLEGAL_CHARACTER
|
.get(valueString, String.valueOf(c), i));
|
return false;
|
}
|
}
|
|
// If we've gotten here, then the value is OK.
|
return true;
|
}
|
}
|
