MatchingRuleUseSyntax.java revision f4d85fde4c95d5f49f683641815e0463d6166720
/*
* 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 matching rule use description syntax, which is used
* to hold matching rule use definitions in the server schema. The format of
* this syntax is defined in RFC 2252.
*/
public class MatchingRuleUseSyntax
extends AttributeSyntax
{
// The default equality matching rule for this syntax.
// The default ordering matching rule for this syntax.
// The default substring matching rule for this syntax.
/**
* Creates a new instance of this syntax. Note that the only thing that
* should be done here is to invoke the default constructor for the
* superclass. All initialization should be performed in the
* <CODE>initializeSyntax</CODE> method.
*/
public MatchingRuleUseSyntax()
{
super();
}
/**
* {@inheritDoc}
*/
{
if (defaultEqualityMatchingRule == null)
{
}
if (defaultOrderingMatchingRule == null)
{
}
if (defaultSubstringMatchingRule == null)
{
}
}
/**
* {@inheritDoc}
*/
public String getSyntaxName()
{
return SYNTAX_MATCHING_RULE_USE_NAME;
}
/**
* {@inheritDoc}
*/
{
return SYNTAX_MATCHING_RULE_USE_OID;
}
/**
* {@inheritDoc}
*/
public String getDescription()
{
}
/**
* {@inheritDoc}
*/
{
return defaultEqualityMatchingRule;
}
/**
* {@inheritDoc}
*/
{
return defaultOrderingMatchingRule;
}
/**
* {@inheritDoc}
*/
{
return defaultSubstringMatchingRule;
}
/**
* {@inheritDoc}
*/
{
// There is no approximate matching rule by default.
return null;
}
/**
* {@inheritDoc}
*/
{
// We'll use the decodeMatchingRuleUse method to determine if the value is
// acceptable.
try
{
return true;
}
catch (DirectoryException de)
{
if (debugEnabled())
{
}
return false;
}
}
/**
* Decodes the contents of the provided ASN.1 octet string as a matching rule
* use definition according to the rules of this syntax. Note that the
* provided octet string value does not need to be normalized (and in fact, it
* should not be in order to allow the desired capitalization to be
* preserved).
*
* @param value The ASN.1 octet string containing the value
* to decode (it does not need to be
* normalized).
* @param schema The schema to use to resolve references to
* other schema elements.
* @param allowUnknownElements Indicates whether to allow values that
* which are not defined in the server schema.
* This should only be true when called by
* {@code valueIsAcceptable}.
*
* @return The decoded matching rule use definition.
*
* @throws DirectoryException If the provided value cannot be decoded as a
* matching rule use definition.
*/
boolean allowUnknownElements)
throws DirectoryException
{
// Get string representations of the provided value using the provided form
// and with all lowercase characters.
// We'll do this a character at a time. First, skip over any leading
// whitespace.
int pos = 0;
{
pos++;
}
{
// This means that the value was empty or contained only whitespace. That
// is illegal.
msgID);
}
// The next character must be an open parenthesis. If it is not, then that
// is an error.
if (c != '(')
{
msgID);
}
// Skip over any spaces immediately following the opening parenthesis.
{
pos++;
}
{
// This means that the end of the value was reached before we could find
// the OID. Ths is illegal.
msgID);
}
// The next set of characters must be the OID. Strictly speaking, this
// should only be a numeric OID, but we'll also allow for the
// "ocname-oid" case as well. Look at the first character to figure out
// which we will be using.
int oidStartPos = pos;
if (isDigit(c))
{
// This must be a numeric OID. In that case, we will accept only digits
// and periods, but not consecutive periods.
boolean lastWasPeriod = false;
{
if (c == '.')
{
if (lastWasPeriod)
{
}
else
{
lastWasPeriod = true;
}
}
else if (! isDigit(c))
{
// This must have been an illegal character.
}
else
{
lastWasPeriod = false;
}
}
}
else
{
// This must be a "fake" OID. In this case, we will only accept
// alphabetic characters, numeric digits, and the hyphen.
{
{
// This is fine. It is an acceptable character.
}
else
{
// This must have been an illegal character.
}
}
}
// If we're at the end of the value, then it isn't a valid matching rule use
// description. Otherwise, parse out the OID.
{
msgID);
}
else
{
}
// Get the matching rule with the specified OID.
if (matchingRule == null)
{
// This is bad because the matching rule use is associated with a matching
// rule that we don't know anything about.
msgID);
}
// Skip over the space(s) after the OID.
{
pos++;
}
{
// This means that the end of the value was reached before we could find
// the OID. Ths is illegal.
msgID);
}
// At this point, we should have a pretty specific syntax that describes
// what may come next, but some of the components are optional and it would
// be pretty easy to put something in the wrong order, so we will be very
// flexible about what we can accept. Just look at the next token, figure
// out what it is and how to treat what comes after it, then repeat until
// we get to the end of the value. But before we start, set default values
// for everything else we might need to know.
boolean isObsolete = false;
while (true)
{
{
// We must be at the end of the value. If not, then that's a problem.
{
}
break;
}
{
// This specifies the set of names for the matching rule use. It may be
// a single name in single quotes, or it may be an open parenthesis
// followed by one or more names in single quotes separated by spaces.
if (c == '\'')
{
(pos-1));
}
else if (c == '(')
{
pos);
while (true)
{
{
// Skip over any spaces after the parenthesis.
pos++;
{
pos++;
}
break;
}
else
{
userBuffer = new StringBuilder();
lowerBuffer = new StringBuilder();
lowerBuffer, pos);
}
}
}
else
{
// This is an illegal character.
}
}
{
// This specifies the description for the matching rule use. It is an
// arbitrary string of characters enclosed in single quotes.
}
{
// This indicates whether the matching rule use should be considered
// obsolete. We do not need to do any more parsing for this token.
isObsolete = true;
}
{
// This specifies the set of attribute types that may be used with the
// associated matching rule. It may be a single name or OID (not in
// quotes), or it may be an open parenthesis followed by one or more
// names separated by spaces and the dollar sign character, followed
// by a closing parenthesis.
if (c == '(')
{
while (true)
{
{
// This isn't good because it means that the matching rule use
// specifies an attribute type that we don't know anything about.
if (allowUnknownElements)
{
woidBuffer.toString());
}
else
{
}
}
// The next character must be either a dollar sign or a closing
// parenthesis.
if (c == ')')
{
// This denotes the end of the list.
break;
}
else if (c != '$')
{
}
}
}
else
{
{
// This isn't good because it means that the matching rule use
// specifies an attribute type that we don't know anything about.
if (allowUnknownElements)
{
woidBuffer.toString());
}
else
{
}
}
}
}
else
{
// This must be a non-standard property and it must be followed by
// either a single value in single quotes or an open parenthesis
// followed by one or more values in single quotes separated by spaces
// followed by a close parenthesis.
}
}
// Make sure that the set of attributes was defined.
if (attributes == null)
{
msgID);
}
}
/**
* Reads the next token name from the matching rule use definition, skipping
* over any leading or trailing spaces, and appends it to the provided buffer.
*
* @param valueStr The string representation of the matching rule use
* definition.
* @param tokenName The buffer into which the token name will be written.
* @param startPos The position in the provided string at which to start
* reading the token name.
*
* @return The position of the first character that is not part of the token
* name or one of the trailing spaces after it.
*
* @throws DirectoryException If a problem is encountered while reading the
* token name.
*/
int startPos)
throws DirectoryException
{
// Skip over any spaces at the beginning of the value.
char c = '\u0000';
{
startPos++;
}
{
msgID);
}
// Read until we find the next space.
{
}
// Skip over any trailing spaces after the value.
{
startPos++;
}
// Return the position of the first non-space character after the token.
return startPos;
}
/**
* Reads the value of a string enclosed in single quotes, skipping over the
* quotes and any leading or trailing spaces, and appending the string to the
* provided buffer.
*
* @param valueStr The user-provided representation of the matching rule
* use definition.
* @param valueBuffer The buffer into which the user-provided representation
* of the value will be placed.
* @param startPos The position in the provided string at which to start
* reading the quoted string.
*
* @return The position of the first character that is not part of the quoted
* string or one of the trailing spaces after it.
*
* @throws DirectoryException If a problem is encountered while reading the
* quoted string.
*/
throws DirectoryException
{
// Skip over any spaces at the beginning of the value.
char c = '\u0000';
{
startPos++;
}
{
msgID);
}
// The next character must be a single quote.
if (c != '\'')
{
msgID);
}
// Read until we find the closing quote.
startPos++;
{
valueBuffer.append(c);
startPos++;
}
// Skip over any trailing spaces after the value.
startPos++;
{
startPos++;
}
// If we're at the end of the value, then that's illegal.
{
msgID);
}
// Return the position of the first non-space character after the token.
return startPos;
}
/**
* Reads the value of a string enclosed in single quotes, skipping over the
* quotes and any leading or trailing spaces, and appending the string to the
* provided buffer.
*
* @param valueStr The user-provided representation of the matching rule
* use definition.
* @param lowerStr The all-lowercase representation of the matching rule
* use definition.
* @param userBuffer The buffer into which the user-provided representation
* of the value will be placed.
* @param lowerBuffer The buffer into which the all-lowercase representation
* of the value will be placed.
* @param startPos The position in the provided string at which to start
* reading the quoted string.
*
* @return The position of the first character that is not part of the quoted
* string or one of the trailing spaces after it.
*
* @throws DirectoryException If a problem is encountered while reading the
* quoted string.
*/
throws DirectoryException
{
// Skip over any spaces at the beginning of the value.
char c = '\u0000';
{
startPos++;
}
{
msgID);
}
// The next character must be a single quote.
if (c != '\'')
{
msgID);
}
// Read until we find the closing quote.
startPos++;
{
lowerBuffer.append(c);
startPos++;
}
// Skip over any trailing spaces after the value.
startPos++;
{
startPos++;
}
// If we're at the end of the value, then that's illegal.
{
msgID);
}
// Return the position of the first non-space character after the token.
return startPos;
}
/**
* Reads the attribute type description or numeric OID from the provided
* string, skipping over any leading or trailing spaces, and appending the
* value to the provided buffer.
*
* @param lowerStr The string from which the name or OID is to be read.
* @param woidBuffer The buffer into which the name or OID should be
* appended.
* @param startPos The position at which to start reading.
*
* @return The position of the first character after the name or OID that is
* not a space.
*
* @throws DirectoryException If a problem is encountered while reading the
* name or OID.
*/
int startPos)
throws DirectoryException
{
// Skip over any spaces at the beginning of the value.
char c = '\u0000';
{
startPos++;
}
{
msgID);
}
// The next character must be either numeric (for an OID) or alphabetic (for
// an attribute type description).
if (isDigit(c))
{
// This must be a numeric OID. In that case, we will accept only digits
// and periods, but not consecutive periods.
boolean lastWasPeriod = false;
{
if (c == '.')
{
if (lastWasPeriod)
{
}
else
{
woidBuffer.append(c);
lastWasPeriod = true;
}
}
else if (! isDigit(c))
{
// Technically, this must be an illegal character. However, it is
// possible that someone just got sloppy and did not include a space
// we'll assume it's the end of the value. What's more, we'll have
// to prematurely return to nasty side effects from stripping off
// additional characters.
if (c == ')')
{
return (startPos-1);
}
// This must have been an illegal character.
}
else
{
woidBuffer.append(c);
lastWasPeriod = false;
}
}
}
else if (isAlpha(c))
{
// This must be an attribute type description. In this case, we will only
// accept alphabetic characters, numeric digits, and the hyphen.
{
{
woidBuffer.append(c);
}
else
{
// Technically, this must be an illegal character. However, it is
// possible that someone just got sloppy and did not include a space
// we'll assume it's the end of the value. What's more, we'll have
// to prematurely return to nasty side effects from stripping off
// additional characters.
if (c == ')')
{
return (startPos-1);
}
// This must have been an illegal character.
}
}
}
else
{
msgID);
}
// Skip over any trailing spaces after the value.
{
startPos++;
}
// If we're at the end of the value, then that's illegal.
{
msgID);
}
// Return the position of the first non-space character after the token.
return startPos;
}
/**
* Reads the value for an "extra" parameter. It will handle a single unquoted
* word (which is technically illegal, but we'll allow it), a single quoted
* string, or an open parenthesis followed by a space-delimited set of quoted
* strings or unquoted words followed by a close parenthesis.
*
* @param valueStr The string containing the information to be read.
* @param valueList The list of "extra" parameter values read so far.
* @param startPos The position in the value string at which to start
* reading.
*
* @return The "extra" parameter value that was read.
*
* @throws DirectoryException If a problem occurs while attempting to read
* the value.
*/
throws DirectoryException
{
// Skip over any leading spaces.
{
}
{
msgID);
}
// Look at the next character. If it is a quote, then parse until the next
// quote and end. If it is an open parenthesis, then parse individual
// values until the close parenthesis and end. Otherwise, parse until the
// next space and end.
if (c == '\'')
{
// Parse until the closing quote.
{
valueBuffer.append(c);
}
}
else if (c == '(')
{
while (true)
{
// Skip over any leading spaces;
startPos++;
{
startPos++;
}
{
}
if (c == ')')
{
// This is the end of the list.
break;
}
else if (c == '(')
{
// This is an illegal character.
}
else
{
// We'll recursively call this method to deal with this.
}
}
}
else
{
// Parse until the next space.
{
valueBuffer.append(c);
}
}
// Skip over any trailing spaces.
{
startPos++;
}
{
msgID);
}
return startPos;
}
}