mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git
opendj-server-legacy/src/main/java/org/opends/server/schema/DirectoryStringSyntax.java
@@ -25,22 +25,21 @@ * Portions Copyright 2012-2015 ForgeRock AS */ package org.opends.server.schema; import static org.opends.server.schema.SchemaConstants.*; import java.util.List; import org.forgerock.i18n.LocalizableMessage; import org.forgerock.i18n.LocalizableMessageBuilder; import org.forgerock.i18n.slf4j.LocalizedLogger; import org.forgerock.opendj.config.server.ConfigChangeResult; import org.forgerock.opendj.config.server.ConfigException; import org.forgerock.opendj.ldap.ByteSequence; import org.forgerock.opendj.ldap.Option; import org.forgerock.opendj.ldap.schema.Schema; import org.forgerock.opendj.ldap.schema.SchemaOptions; import org.forgerock.opendj.ldap.schema.Syntax; import org.opends.server.admin.server.ConfigurationChangeListener; import org.opends.server.admin.std.server.DirectoryStringAttributeSyntaxCfg; import org.forgerock.opendj.ldap.schema.MatchingRule; import org.opends.server.api.AttributeSyntax; import org.opends.server.core.DirectoryServer; import org.forgerock.opendj.config.server.ConfigChangeResult; import static org.opends.messages.SchemaMessages.*; import static org.opends.server.schema.SchemaConstants.*; import org.opends.server.core.ServerContext; /** @@ -54,26 +53,13 @@ implements ConfigurationChangeListener<DirectoryStringAttributeSyntaxCfg> { private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass(); /** The default approximate matching rule for this syntax. */ private MatchingRule defaultApproximateMatchingRule; /** Indicates whether we will allow zero-length values. */ private boolean allowZeroLengthValues; /** The reference to the configuration for this directory string syntax. */ private DirectoryStringAttributeSyntaxCfg currentConfig; /** The default equality matching rule for this syntax. */ private MatchingRule defaultEqualityMatchingRule; /** The default ordering matching rule for this syntax. */ private MatchingRule defaultOrderingMatchingRule; /** The default substring matching rule for this syntax. */ private MatchingRule defaultSubstringMatchingRule; private ServerContext serverContext; /** * Creates a new instance of this syntax. Note that the only thing that @@ -88,41 +74,10 @@ /** {@inheritDoc} */ @Override public void initializeSyntax(DirectoryStringAttributeSyntaxCfg configuration) public void initializeSyntax(DirectoryStringAttributeSyntaxCfg configuration, ServerContext serverContext) throws ConfigException { defaultApproximateMatchingRule = DirectoryServer.getMatchingRule(AMR_DOUBLE_METAPHONE_OID); if (defaultApproximateMatchingRule == null) { logger.error(ERR_ATTR_SYNTAX_UNKNOWN_APPROXIMATE_MATCHING_RULE, AMR_DOUBLE_METAPHONE_OID, SYNTAX_DIRECTORY_STRING_NAME); } defaultEqualityMatchingRule = DirectoryServer.getMatchingRule(EMR_CASE_IGNORE_OID); if (defaultEqualityMatchingRule == null) { logger.error(ERR_ATTR_SYNTAX_UNKNOWN_EQUALITY_MATCHING_RULE, EMR_CASE_IGNORE_OID, SYNTAX_DIRECTORY_STRING_NAME); } defaultOrderingMatchingRule = DirectoryServer.getMatchingRule(OMR_CASE_IGNORE_OID); if (defaultOrderingMatchingRule == null) { logger.error(ERR_ATTR_SYNTAX_UNKNOWN_ORDERING_MATCHING_RULE, OMR_CASE_IGNORE_OID, SYNTAX_DIRECTORY_STRING_NAME); } defaultSubstringMatchingRule = DirectoryServer.getMatchingRule(SMR_CASE_IGNORE_OID); if (defaultSubstringMatchingRule == null) { logger.error(ERR_ATTR_SYNTAX_UNKNOWN_SUBSTRING_MATCHING_RULE, SMR_CASE_IGNORE_OID, SYNTAX_DIRECTORY_STRING_NAME); } this.serverContext = serverContext; // 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 @@ -136,6 +91,26 @@ currentConfig = configuration; currentConfig.addDirectoryStringChangeListener(this); allowZeroLengthValues = currentConfig.isAllowZeroLengthValues(); updateNewSchema(); } /** Update the option in new schema if it changes from current value. */ private void updateNewSchema() { Option<Boolean> option = SchemaOptions.ALLOW_ZERO_LENGTH_DIRECTORY_STRINGS; if (allowZeroLengthValues != serverContext.getSchemaNG().getOption(option)) { SchemaUpdater schemaUpdater = serverContext.getSchemaUpdater(); schemaUpdater.updateSchema( schemaUpdater.getSchemaBuilder().setOption(option, allowZeroLengthValues).toSchema()); } } /** {@inheritDoc} */ @Override public Syntax getSDKSyntax(Schema schema) { return schema.getSyntax(SchemaConstants.SYNTAX_DIRECTORY_STRING_OID); } /** @@ -181,90 +156,6 @@ } /** * 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. */ @Override public MatchingRule getEqualityMatchingRule() { 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. */ @Override public MatchingRule getOrderingMatchingRule() { 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. */ @Override public MatchingRule getSubstringMatchingRule() { 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. */ @Override public MatchingRule getApproximateMatchingRule() { 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. */ @Override public boolean valueIsAcceptable(ByteSequence value, LocalizableMessageBuilder invalidReason) { if (allowZeroLengthValues || (value.length() > 0)) { return true; } else { invalidReason.append( ERR_ATTR_SYNTAX_DIRECTORYSTRING_INVALID_ZEROLENGTH_VALUE.get()); 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 @@ -296,22 +187,9 @@ { currentConfig = configuration; allowZeroLengthValues = configuration.isAllowZeroLengthValues(); updateNewSchema(); return new ConfigChangeResult(); } /** {@inheritDoc} */ @Override public boolean isBEREncodingRequired() { return false; } /** {@inheritDoc} */ @Override public boolean isHumanReadable() { return true; } }
