DirectoryStringSyntax.java revision 99faa045b6241c1d2843cce1b7a9d9c97055beae
/*
* 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 defines the directory string attribute syntax, which is simply a
* set of UTF-8 characters. By default, they will be treated in a
* case-insensitive manner, and equality, ordering, substring, and approximate
* matching will be allowed.
*/
public class DirectoryStringSyntax
extends AttributeSyntax
implements ConfigurableComponent
{
// The default approximate matching rule for this syntax.
// Indicates whether we will allow zero-length values.
private boolean allowZeroLengthValues;
// The DN of the configuration entry for this syntax.
private DN configEntryDN;
// The default equality matching rule for this syntax.
// The default ordering matching rule for this syntax.
// The default substring matching rule for this syntax.
/**
* A {@link String} attribute value decoder for this syntax.
*/
new AttributeValueDecoder<String>()
{
/**
* {@inheritDoc}
*/
{
// Make sure that the value is valid.
return value.getStringValue();
}
};
/**
* 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 DirectoryStringSyntax()
{
super();
}
/**
* Initializes this attribute syntax based on the information in the provided
* configuration entry.
*
* @param configEntry The configuration entry that contains the information
* to use to initialize this attribute syntax.
*
* @throws ConfigException If an unrecoverable problem arises in the
* process of performing the initialization.
*/
throws ConfigException
{
if (defaultApproximateMatchingRule == null)
{
}
if (defaultEqualityMatchingRule == null)
{
}
if (defaultOrderingMatchingRule == null)
{
}
if (defaultSubstringMatchingRule == null)
{
}
// This syntax is one of the Directory Server's core syntaxes and therefore
// it may be instantiated at times without a configuration entry. If that
// is the case, then we'll exit now before doing anything that could require
// access to that entry.
if (configEntry == null)
{
return;
}
getMessage(msgID), false);
try
{
if (allowZeroLengthAttr != null)
{
}
}
catch (Exception e)
{
if (debugEnabled())
{
}
getExceptionMessage(e));
}
}
/**
* Performs any finalization that may be necessary for this attribute syntax.
*/
public void finalizeSyntax()
{
}
/**
* Retrieves the common name for this attribute syntax.
*
* @return The common name for this attribute syntax.
*/
public String getSyntaxName()
{
return SYNTAX_DIRECTORY_STRING_NAME;
}
/**
* Retrieves the OID for this attribute syntax.
*
* @return The OID for this attribute syntax.
*/
{
return SYNTAX_DIRECTORY_STRING_OID;
}
/**
* Retrieves a description for this attribute syntax.
*
* @return A description for this attribute syntax.
*/
public String getDescription()
{
}
/**
* Retrieves the default equality matching rule that will be used for
* attributes with this syntax.
*
* @return The default equality matching rule that will be used for
* attributes with this syntax, or <CODE>null</CODE> if equality
* matches will not be allowed for this type by default.
*/
{
return defaultEqualityMatchingRule;
}
/**
* Retrieves the default ordering matching rule that will be used for
* attributes with this syntax.
*
* @return The default ordering matching rule that will be used for
* attributes with this syntax, or <CODE>null</CODE> if ordering
* matches will not be allowed for this type by default.
*/
{
return defaultOrderingMatchingRule;
}
/**
* Retrieves the default substring matching rule that will be used for
* attributes with this syntax.
*
* @return The default substring matching rule that will be used for
* attributes with this syntax, or <CODE>null</CODE> if substring
* matches will not be allowed for this type by default.
*/
{
return defaultSubstringMatchingRule;
}
/**
* Retrieves the default approximate matching rule that will be used for
* attributes with this syntax.
*
* @return The default approximate matching rule that will be used for
* attributes with this syntax, or <CODE>null</CODE> if approximate
* matches will not be allowed for this type by default.
*/
{
return defaultApproximateMatchingRule;
}
/**
* 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 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.
*/
{
{
return true;
}
else
{
return false;
}
}
/**
* Indicates whether zero-length values will be allowed. This is technically
* forbidden by the LDAP specification, but it was allowed in earlier versions
* of the server, and the discussion of the directory string syntax in RFC
* 2252 does not explicitly state that they are not allowed.
*
* @return <CODE>true</CODE> if zero-length values should be allowed for
* attributes with a directory string syntax, or <CODE>false</CODE>
* if not.
*/
public boolean allowZeroLengthValues()
{
return allowZeroLengthValues;
}
/**
* Retrieves the DN of the configuration entry with which this component is
* associated.
*
* @return The DN of the configuration entry with which this component is
* associated.
*/
public DN getConfigurableComponentEntryDN()
{
return configEntryDN;
}
/**
* Retrieves the set of configuration attributes that are associated with this
* configurable component.
*
* @return The set of configuration attributes that are associated with this
* configurable component.
*/
{
return configAttrs;
}
/**
* Indicates whether the provided configuration entry has an acceptable
* configuration for this component. If it does not, then detailed
* information about the problem(s) should be added to the provided list.
*
* @param configEntry The configuration entry for which to make the
* determination.
* @param unacceptableReasons A list that can be used to hold messages about
* why the provided entry does not have an
* acceptable configuration.
*
* @return <CODE>true</CODE> if the provided entry has an acceptable
* configuration for this component, or <CODE>false</CODE> if not.
*/
{
boolean configValid = true;
getMessage(msgID), false);
try
{
}
catch (Exception e)
{
if (debugEnabled())
{
}
configValid = false;
getExceptionMessage(e)));
}
return configValid;
}
/**
* Makes a best-effort attempt to apply the configuration contained in the
* provided entry. Information about the result of this processing should be
* added to the provided message list. Information should always be added to
* this list if a configuration change could not be applied. If detailed
* results are requested, then information about the changes applied
* successfully (and optionally about parameters that were not changed) should
* also be included.
*
* @param configEntry The entry containing the new configuration to
* apply for this component.
* @param detailedResults Indicates whether detailed information about the
* processing should be added to the list.
*
* @return Information about the result of the configuration update.
*/
boolean detailedResults)
{
boolean adminActionRequired = false;
boolean newAllowZeroLengthValues = false;
getMessage(msgID), false);
try
{
if (allowZeroLengthAttr != null)
{
}
}
catch (Exception e)
{
if (debugEnabled())
{
}
getExceptionMessage(e)));
}
{
{
if (detailedResults)
{
}
}
}
}
}