From 19004a003b3e4387de43f8c399971187156f3d54 Mon Sep 17 00:00:00 2001
From: Nicolas Capponi <nicolas.capponi@forgerock.com>
Date: Mon, 30 May 2016 10:43:11 +0000
Subject: [PATCH] OPENDJ-2987 Remove object class parsing in ObjectClassSyntax class - now responsability of Schema class
---
opendj-server-legacy/src/main/java/org/opends/guitools/controlpanel/util/RemoteSchemaLoader.java | 3
opendj-server-legacy/src/main/java/org/opends/server/backends/SchemaBackend.java | 89 +-
opendj-server-legacy/src/main/java/org/opends/server/schema/ObjectClassSyntax.java | 1184 -------------------------------------------
opendj-server-legacy/src/test/java/org/opends/server/schema/GenericSchemaTestCase.java | 41
opendj-server-legacy/src/main/java/org/opends/server/types/Schema.java | 231 ++++++--
opendj-server-legacy/src/main/java/org/opends/server/core/SchemaConfigManager.java | 69 -
opendj-server-legacy/src/messages/org/opends/messages/schema.properties | 2
7 files changed, 268 insertions(+), 1,351 deletions(-)
diff --git a/opendj-server-legacy/src/main/java/org/opends/guitools/controlpanel/util/RemoteSchemaLoader.java b/opendj-server-legacy/src/main/java/org/opends/guitools/controlpanel/util/RemoteSchemaLoader.java
index fcf0f19..d1cc4f2 100644
--- a/opendj-server-legacy/src/main/java/org/opends/guitools/controlpanel/util/RemoteSchemaLoader.java
+++ b/opendj-server-legacy/src/main/java/org/opends/guitools/controlpanel/util/RemoteSchemaLoader.java
@@ -39,7 +39,6 @@
import org.opends.server.core.ServerContext;
import org.opends.server.replication.plugin.HistoricalCsnOrderingMatchingRuleImpl;
import org.opends.server.schema.AciSyntax;
-import org.opends.server.schema.ObjectClassSyntax;
import org.opends.server.schema.SchemaConstants;
import org.opends.server.schema.SubtreeSpecificationSyntax;
import org.opends.server.types.DirectoryException;
@@ -174,7 +173,7 @@
schema.registerAttributeType(sb.toString(), null, true);
break;
case ConfigConstants.ATTR_OBJECTCLASSES_LC:
- schema.registerObjectClass(ObjectClassSyntax.decodeObjectClass(sb, schema, false), true);
+ schema.registerObjectClass(sb.toString(), null, true);
break;
}
registered.add(definition);
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/backends/SchemaBackend.java b/opendj-server-legacy/src/main/java/org/opends/server/backends/SchemaBackend.java
index f2f2874..2f59cf4 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/backends/SchemaBackend.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/backends/SchemaBackend.java
@@ -16,6 +16,7 @@
*/
package org.opends.server.backends;
+import static org.forgerock.opendj.ldap.ResultCode.*;
import static org.forgerock.util.Reject.*;
import static org.opends.messages.BackendMessages.*;
import static org.opends.messages.ConfigMessages.*;
@@ -48,6 +49,7 @@
import java.util.TreeSet;
import org.forgerock.i18n.LocalizableMessage;
+import org.forgerock.i18n.LocalizableMessageDescriptor.Arg2;
import org.forgerock.i18n.slf4j.LocalizedLogger;
import org.forgerock.opendj.config.server.ConfigChangeResult;
import org.forgerock.opendj.config.server.ConfigException;
@@ -85,7 +87,6 @@
import org.opends.server.schema.DITStructureRuleSyntax;
import org.opends.server.schema.GeneralizedTimeSyntax;
import org.opends.server.schema.NameFormSyntax;
-import org.opends.server.schema.ObjectClassSyntax;
import org.opends.server.schema.ServerSchemaElement;
import org.opends.server.schema.SomeSchemaElement;
import org.opends.server.types.Attribute;
@@ -762,22 +763,8 @@
{
for (ByteString v : a)
{
- ObjectClass oc;
- try
- {
- oc = ObjectClassSyntax.decodeObjectClass(v, newSchema, false);
- }
- catch (DirectoryException de)
- {
- logger.traceException(de);
-
- LocalizableMessage message = ERR_SCHEMA_MODIFY_CANNOT_DECODE_OBJECTCLASS.
- get(v, de.getMessageObject());
- throw new DirectoryException(
- ResultCode.INVALID_ATTRIBUTE_SYNTAX, message, de);
- }
-
- addObjectClass(oc, newSchema, modifiedSchemaFiles);
+ ObjectClass objectClass = newSchema.parseObjectClass(v.toString());
+ addObjectClass(objectClass, newSchema, modifiedSchemaFiles);
}
}
else if (at.equals(nameFormsType))
@@ -900,21 +887,7 @@
{
for (ByteString v : a)
{
- ObjectClass oc;
- try
- {
- oc = ObjectClassSyntax.decodeObjectClass(v, newSchema, false);
- }
- catch (DirectoryException de)
- {
- logger.traceException(de);
-
- LocalizableMessage message = ERR_SCHEMA_MODIFY_CANNOT_DECODE_OBJECTCLASS.
- get(v, de.getMessageObject());
- throw new DirectoryException(
- ResultCode.INVALID_ATTRIBUTE_SYNTAX, message, de);
- }
-
+ ObjectClass oc = newSchema.parseObjectClass(v.toString());
removeObjectClass(oc, newSchema, mods, pos, modifiedSchemaFiles);
}
}
@@ -1194,7 +1167,7 @@
String schemaFile = replaceExistingSchemaElement(
modifiedSchemaFiles, new SomeSchemaElement(attributeType), new SomeSchemaElement(existingType));
schema.registerAttributeType(attributeType, schemaFile, false);
- schema.rebuildDependentElements(new SomeSchemaElement(existingType));
+ schema.rebuildDependentElements(existingType);
}
}
@@ -1545,15 +1518,14 @@
// Otherwise, we're replacing an existing one.
if (existingClass.isPlaceHolder())
{
- schema.registerObjectClass(objectClass, false);
- addNewSchemaElement(modifiedSchemaFiles, objectClass);
+ String schemaFile = addNewSchemaElement(modifiedSchemaFiles, new SomeSchemaElement(objectClass));
+ schema.registerObjectClass(objectClass, schemaFile, false);
}
else
{
- schema.deregisterObjectClass(existingClass);
- schema.registerObjectClass(objectClass, false);
- schema.rebuildDependentElements(existingClass);
- replaceExistingSchemaElement(modifiedSchemaFiles, objectClass, existingClass);
+ final String schemaFile = replaceExistingSchemaElement(
+ modifiedSchemaFiles, new SomeSchemaElement(objectClass), new SomeSchemaElement(existingClass));
+ schema.replaceObjectClass(objectClass, existingClass, schemaFile);
}
}
@@ -1618,7 +1590,7 @@
ObjectClass oc;
try
{
- oc = ObjectClassSyntax.decodeObjectClass(v, schema, true);
+ oc = schema.parseObjectClass(v.toString());
}
catch (DirectoryException de)
{
@@ -3448,7 +3420,7 @@
{
// It IS important here to allow the unknown elements that could
// appear in the new config schema.
- ObjectClass newObjectClass = ObjectClassSyntax.decodeObjectClass(v, newSchema, true);
+ ObjectClass newObjectClass = newSchema.parseObjectClass(v.toString());
String schemaFile = getSchemaFile(newObjectClass);
if (CONFIG_SCHEMA_ELEMENTS_FILE.equals(schemaFile))
{
@@ -3458,10 +3430,8 @@
continue;
}
- // Now we know we are not in the config schema, let's check
- // the unknown elements ... sadly but simply by redoing the
- // whole decoding.
- newObjectClass = ObjectClassSyntax.decodeObjectClass(v, newSchema, false);
+ // Now we know we are not in the config schema, let's check the unknown elements ...
+ validateNoUnknownElements(newObjectClass);
oidList.add(newObjectClass.getOID());
try
{
@@ -3517,6 +3487,35 @@
}
}
+ private void validateNoUnknownElements(ObjectClass oc) throws DirectoryException
+ {
+ validateNoUnknownElements(oc.getDeclaredOptionalAttributes(), oc.getOID(),
+ WARN_ATTR_SYNTAX_OBJECTCLASS_UNKNOWN_OPTIONAL_ATTR);
+ validateNoUnknownElements(oc.getDeclaredRequiredAttributes(), oc.getOID(),
+ WARN_ATTR_SYNTAX_OBJECTCLASS_UNKNOWN_REQUIRED_ATTR);
+ for (ObjectClass superiorClass : oc.getSuperiorClasses())
+ {
+ if (superiorClass.isPlaceHolder())
+ {
+ LocalizableMessage message =
+ WARN_ATTR_SYNTAX_OBJECTCLASS_UNKNOWN_SUPERIOR_CLASS.get(oc.getOID(), superiorClass.getOID());
+ throw new DirectoryException(ResultCode.CONSTRAINT_VIOLATION, message);
+ }
+ }
+ }
+
+ private void validateNoUnknownElements(Set<AttributeType> attributeTypes, String oid, Arg2<Object, Object> msg)
+ throws DirectoryException
+ {
+ for (AttributeType attributeType : attributeTypes)
+ {
+ if (attributeType.isPlaceHolder())
+ {
+ throw new DirectoryException(CONSTRAINT_VIOLATION, msg.get(oid, attributeType.getOID()));
+ }
+ }
+ }
+
@Override
public void createBackup(BackupConfig backupConfig) throws DirectoryException
{
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/core/SchemaConfigManager.java b/opendj-server-legacy/src/main/java/org/opends/server/core/SchemaConfigManager.java
index 086c3cf..adf6089 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/core/SchemaConfigManager.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/core/SchemaConfigManager.java
@@ -35,7 +35,6 @@
import org.opends.server.schema.DITContentRuleSyntax;
import org.opends.server.schema.DITStructureRuleSyntax;
import org.opends.server.schema.NameFormSyntax;
-import org.opends.server.schema.ObjectClassSyntax;
import org.opends.server.types.Attribute;
import org.opends.server.types.DITContentRule;
import org.opends.server.types.DITStructureRule;
@@ -45,7 +44,6 @@
import org.opends.server.types.LDIFImportConfig;
import org.opends.server.types.Modification;
import org.opends.server.types.NameForm;
-import org.forgerock.opendj.ldap.schema.ObjectClass;
import org.opends.server.types.Schema;
import org.opends.server.util.LDIFReader;
import org.opends.server.util.StaticUtils;
@@ -671,62 +669,43 @@
{
if (ocList != null)
{
+ List<String> definitions = new ArrayList<>();
for (Attribute a : ocList)
{
for (ByteString v : a)
{
- // Parse the objectclass.
- ObjectClass oc;
- try
- {
- oc = ObjectClassSyntax.decodeObjectClass(v, schema, false);
- setExtraProperty(oc, SCHEMA_PROPERTY_FILENAME, null);
- setSchemaFile(oc, schemaFile);
- }
- catch (DirectoryException de)
- {
- logger.traceException(de);
+ definitions.add(v.toString());
+ }
+ }
+ try
+ {
+ schema.registerObjectClasses(definitions, schemaFile, !failOnError);
+ }
+ catch (DirectoryException de)
+ {
+ logger.traceException(de);
- LocalizableMessage message = WARN_CONFIG_SCHEMA_CANNOT_PARSE_OC.get(
- schemaFile,
- de.getMessageObject());
- reportError(failOnError, de, message);
- continue;
- }
- catch (Exception e)
- {
- logger.traceException(e);
-
- LocalizableMessage message = WARN_CONFIG_SCHEMA_CANNOT_PARSE_OC.get(
- schemaFile, v + ": " + getExceptionMessage(e));
- reportError(failOnError, e, message);
- continue;
- }
-
- // Register it with the schema. We will allow duplicates, with the
+ if (de.getResultCode().equals(ResultCode.CONSTRAINT_VIOLATION))
+ {
+ // Register it with the schema. We will allow duplicates, with the
// later definition overriding any earlier definition, but we want
// to trap them and log a warning.
+ logger.warn(WARN_CONFIG_SCHEMA_CONFLICTING_OC, schemaFile, de.getMessageObject());
try
{
- schema.registerObjectClass(oc, failOnError);
+ schema.registerObjectClasses(definitions, schemaFile, true);
}
- catch (DirectoryException de)
+ catch (DirectoryException e)
{
- logger.traceException(de);
-
- logger.warn(WARN_CONFIG_SCHEMA_CONFLICTING_OC, schemaFile, de.getMessageObject());
-
- try
- {
- schema.registerObjectClass(oc, true);
- }
- catch (Exception e)
- {
- // This should never happen.
- logger.traceException(e);
- }
+ // This should never happen
+ logger.traceException(e);
}
}
+ else
+ {
+ LocalizableMessage message = WARN_CONFIG_SCHEMA_CANNOT_PARSE_OC.get(schemaFile, de.getMessageObject());
+ reportError(failOnError, de, message);
+ }
}
}
}
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/schema/ObjectClassSyntax.java b/opendj-server-legacy/src/main/java/org/opends/server/schema/ObjectClassSyntax.java
index 57b50fd..83d20e1 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/schema/ObjectClassSyntax.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/schema/ObjectClassSyntax.java
@@ -16,33 +16,12 @@
*/
package org.opends.server.schema;
-import static org.opends.messages.SchemaMessages.*;
-import static org.opends.server.config.ConfigConstants.*;
import static org.opends.server.schema.SchemaConstants.*;
-import static org.opends.server.util.ServerConstants.*;
-import static org.opends.server.util.StaticUtils.*;
-import java.util.LinkedHashMap;
-import java.util.LinkedHashSet;
-import java.util.LinkedList;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-
-import org.forgerock.i18n.LocalizableMessage;
-import org.forgerock.i18n.LocalizableMessageDescriptor.Arg2;
-import org.forgerock.opendj.ldap.ByteSequence;
-import org.forgerock.opendj.ldap.ResultCode;
-import org.forgerock.opendj.ldap.schema.AttributeType;
-import org.forgerock.opendj.ldap.schema.ObjectClassType;
+import org.forgerock.opendj.ldap.schema.Schema;
import org.forgerock.opendj.ldap.schema.Syntax;
import org.forgerock.opendj.server.config.server.AttributeSyntaxCfg;
import org.opends.server.api.AttributeSyntax;
-import org.opends.server.core.DirectoryServer;
-import org.opends.server.types.CommonSchemaElements;
-import org.opends.server.types.DirectoryException;
-import org.forgerock.opendj.ldap.schema.ObjectClass;
-import org.opends.server.types.Schema;
/**
* This class implements the object class description syntax, which is used to
@@ -52,1191 +31,36 @@
public class ObjectClassSyntax
extends AttributeSyntax<AttributeSyntaxCfg>
{
-
/**
* 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.
+ * should be done here is to invoke the default constructor for the superclass.
*/
public ObjectClassSyntax()
{
super();
}
- /** {@inheritDoc} */
@Override
- public Syntax getSDKSyntax(org.forgerock.opendj.ldap.schema.Schema schema)
+ public Syntax getSDKSyntax(Schema schema)
{
return schema.getSyntax(SchemaConstants.SYNTAX_OBJECTCLASS_OID);
}
- /** {@inheritDoc} */
@Override
public String getName()
{
return SYNTAX_OBJECTCLASS_NAME;
}
- /** {@inheritDoc} */
@Override
public String getOID()
{
return SYNTAX_OBJECTCLASS_OID;
}
- /** {@inheritDoc} */
@Override
public String getDescription()
{
return SYNTAX_OBJECTCLASS_DESCRIPTION;
}
-
- /**
- * Decodes the contents of the provided ASN.1 octet string as an objectclass
- * 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
- * reference a superior class or required or
- * optional attribute types which are not
- * defined in the server schema. This should
- * only be true when called by
- * {@code valueIsAcceptable}.
- *
- * @return The decoded objectclass definition.
- *
- * @throws DirectoryException If the provided value cannot be decoded as an
- * objectclass definition.
- */
- public static ObjectClass decodeObjectClass(ByteSequence value, Schema schema,
- boolean allowUnknownElements)
- throws DirectoryException
- {
- // Get string representations of the provided value using the provided form
- // and with all lowercase characters.
- String valueStr = value.toString();
- String lowerStr = toLowerCase(valueStr);
- boolean allowExceptions = DirectoryServer.isRunning()?
- DirectoryServer.allowAttributeNameExceptions():true;
- // We'll do this a character at a time. First, skip over any leading
- // whitespace.
- int pos = 0;
- int length = valueStr.length();
- while (pos < length && valueStr.charAt(pos) == ' ')
- {
- pos++;
- }
-
- if (pos >= length)
- {
- // This means that the value was empty or contained only whitespace. That
- // is illegal.
- LocalizableMessage message = ERR_ATTR_SYNTAX_OBJECTCLASS_EMPTY_VALUE.get();
- throw new DirectoryException(
- ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
-
-
- // The next character must be an open parenthesis. If it is not, then that
- // is an error.
- char c = valueStr.charAt(pos++);
- if (c != '(')
- {
- LocalizableMessage message = ERR_ATTR_SYNTAX_OBJECTCLASS_EXPECTED_OPEN_PARENTHESIS.
- get(valueStr, pos-1, c);
- throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
-
-
- // Skip over any spaces immediately following the opening parenthesis.
- while (pos < length && ((c = valueStr.charAt(pos)) == ' '))
- {
- pos++;
- }
-
- if (pos >= length)
- {
- // This means that the end of the value was reached before we could find
- // the OID. Ths is illegal.
- LocalizableMessage message =
- ERR_ATTR_SYNTAX_OBJECTCLASS_TRUNCATED_VALUE.get(valueStr);
- throw new DirectoryException(
- ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
-
-
- // 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;
- while (pos < length && ((c = valueStr.charAt(pos++)) != ' '))
- {
- if (c == '.')
- {
- if (lastWasPeriod)
- {
- LocalizableMessage message =
- ERR_ATTR_SYNTAX_OBJECTCLASS_DOUBLE_PERIOD_IN_NUMERIC_OID.
- get(valueStr, pos-1);
- throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
- lastWasPeriod = true;
- }
- else if (! isDigit(c))
- {
- // This must have been an illegal character.
- LocalizableMessage message =
- ERR_ATTR_SYNTAX_OBJECTCLASS_ILLEGAL_CHAR_IN_NUMERIC_OID.
- get(valueStr, c, pos-1);
- throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
- else
- {
- lastWasPeriod = false;
- }
- }
- }
- else
- {
- // This must be a "fake" OID. In this case, we will only accept
- // alphabetic characters, numeric digits, and the hyphen.
- while (pos < length && ((c = valueStr.charAt(pos++)) != ' '))
- {
- if (isAlpha(c) || isDigit(c) || c == '-' ||
- (c == '_' && allowExceptions))
- {
- // This is fine. It is an acceptable character.
- }
- else
- {
- // This must have been an illegal character.
- LocalizableMessage message =
- ERR_ATTR_SYNTAX_OBJECTCLASS_ILLEGAL_CHAR_IN_STRING_OID.
- get(valueStr, c, pos-1);
- throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
- message);
- }
- }
- }
-
-
- // If we're at the end of the value, then it isn't a valid objectclass
- // description. Otherwise, parse out the OID.
- if (pos >= length)
- {
- LocalizableMessage message =
- ERR_ATTR_SYNTAX_OBJECTCLASS_TRUNCATED_VALUE.get(valueStr);
- throw new DirectoryException(
- ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
-
- String oid = lowerStr.substring(oidStartPos, pos-1);
-
- // Skip over the space(s) after the OID.
- while (pos < length && ((c = valueStr.charAt(pos)) == ' '))
- {
- pos++;
- }
-
- if (pos >= length)
- {
- // This means that the end of the value was reached before we could find
- // the OID. Ths is illegal.
- LocalizableMessage message =
- ERR_ATTR_SYNTAX_OBJECTCLASS_TRUNCATED_VALUE.get(valueStr);
- throw new DirectoryException(
- ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
-
-
- // 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.
- String primaryName = oid;
- List<String> names = new LinkedList<>();
- String description = null;
- boolean isObsolete = false;
- Set<AttributeType> requiredAttributes = new LinkedHashSet<>();
- Set<AttributeType> optionalAttributes = new LinkedHashSet<>();
- Set<ObjectClass> superiorClasses = new LinkedHashSet<>();
- //Default OC Type is STRUCTURAL ( RFC 4512 4.1.1)
- ObjectClassType objectClassType = ObjectClassType.STRUCTURAL;
- Map<String, List<String>> extraProperties = new LinkedHashMap<>();
-
-
- while (true)
- {
- StringBuilder tokenNameBuffer = new StringBuilder();
- pos = readTokenName(valueStr, tokenNameBuffer, pos);
- String tokenName = tokenNameBuffer.toString();
- String lowerTokenName = toLowerCase(tokenName);
- if (tokenName.equals(")"))
- {
- // We must be at the end of the value. If not, then that's a problem.
- if (pos < length)
- {
- LocalizableMessage message =
- ERR_ATTR_SYNTAX_OBJECTCLASS_UNEXPECTED_CLOSE_PARENTHESIS.
- get(valueStr, pos-1);
- throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
- message);
- }
-
- break;
- }
- else if (lowerTokenName.equals("name"))
- {
- // This specifies the set of names for the objectclass. 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.
- c = valueStr.charAt(pos++);
- if (c == '\'')
- {
- StringBuilder userBuffer = new StringBuilder();
- StringBuilder lowerBuffer = new StringBuilder();
- pos = readQuotedString(valueStr, lowerStr, userBuffer, lowerBuffer, pos-1);
- primaryName = userBuffer.toString();
- names.add(primaryName);
- }
- else if (c == '(')
- {
- StringBuilder userBuffer = new StringBuilder();
- StringBuilder lowerBuffer = new StringBuilder();
- pos = readQuotedString(valueStr, lowerStr, userBuffer, lowerBuffer,
- pos);
- primaryName = userBuffer.toString();
- names.add(primaryName);
-
-
- while (true)
- {
- if (valueStr.charAt(pos) == ')')
- {
- // Skip over any spaces after the parenthesis.
- pos++;
- while (pos < length && ((c = valueStr.charAt(pos)) == ' '))
- {
- pos++;
- }
-
- break;
- }
- else
- {
- userBuffer = new StringBuilder();
- lowerBuffer = new StringBuilder();
-
- pos = readQuotedString(valueStr, lowerStr, userBuffer,
- lowerBuffer, pos);
- names.add(userBuffer.toString());
- }
- }
- }
- else
- {
- // This is an illegal character.
- LocalizableMessage message = ERR_ATTR_SYNTAX_OBJECTCLASS_ILLEGAL_CHAR.get(valueStr, c, pos-1);
- throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
- message);
- }
- //RFC 2251: A specification may also assign one or more textual names
- //for an attribute type. These names MUST begin with a letter, and
- //only contain ASCII letters, digit characters and hyphens.
- //Iterate over all the names and throw an exception if it is invalid.
- for(String name : names)
- {
- for(int index=0; index < name.length(); index++)
- {
- char ch = name.charAt(index);
- switch(ch)
- {
- case '-':
- //hyphen is allowed but not as the first byte.
- if (index==0)
- {
- throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
- ERR_OC_SYNTAX_ATTR_ILLEGAL_INITIAL_DASH.get(value));
- }
- break;
- case '_':
- // This will never be allowed as the first character. It
- // may be allowed for subsequent characters if the attribute
- // name exceptions option is enabled.
- if (index==0)
- {
- LocalizableMessage msg = ERR_OC_SYNTAX_ATTR_ILLEGAL_INITIAL_UNDERSCORE
- .get(value, ATTR_ALLOW_ATTRIBUTE_NAME_EXCEPTIONS);
- throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, msg);
- }
- else if (!allowExceptions)
- {
- LocalizableMessage msg = ERR_OC_SYNTAX_ATTR_ILLEGAL_UNDERSCORE_CHAR.
- get(value, ATTR_ALLOW_ATTRIBUTE_NAME_EXCEPTIONS);
- throw new DirectoryException(
- ResultCode.INVALID_ATTRIBUTE_SYNTAX, msg);
- }
- break;
-
- default:
- //Only digits and ascii letters are allowed but the first byte
- //can not be a digit.
- if(index ==0 && isDigit(ch) && !allowExceptions)
- {
- LocalizableMessage message = ERR_OC_SYNTAX_ATTR_ILLEGAL_INITIAL_DIGIT.
- get(value, ch, ATTR_ALLOW_ATTRIBUTE_NAME_EXCEPTIONS);
- throw new DirectoryException(
- ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
- else if (!(('0'<=ch && ch<='9')
- || ('A'<=ch && ch<='Z')
- || ('a'<=ch && ch<='z')))
- {
- throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
- ERR_OC_SYNTAX_ATTR_ILLEGAL_CHAR.get(value, ch, index));
- }
- break;
- }
- }
-
- }
- }
- else if (lowerTokenName.equals("desc"))
- {
- // This specifies the description for the objectclass. It is an
- // arbitrary string of characters enclosed in single quotes.
- StringBuilder descriptionBuffer = new StringBuilder();
- pos = readQuotedString(valueStr, descriptionBuffer, pos);
- description = descriptionBuffer.toString();
- }
- else if (lowerTokenName.equals("obsolete"))
- {
- // This indicates whether the objectclass should be considered obsolete.
- // We do not need to do any more parsing for this token.
- isObsolete = true;
- }
- else if (lowerTokenName.equals("sup"))
- {
- // This specifies the name or OID of the superior objectclass from
- // which this objectclass should inherit its properties. As per
- // RFC 4512 (4.1.1), expect an oidlist here. 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.
- c = valueStr.charAt(pos++);
- LinkedList<ObjectClass> listSupOCs = new LinkedList<>();
- if(c == '(')
- {
- while(true)
- {
- StringBuilder woidBuffer = new StringBuilder();
- pos = readWOID(lowerStr, woidBuffer, pos);
- String oidStr = woidBuffer.toString();
- ObjectClass supOC = schema.getObjectClass(oidStr);
- if (supOC == null)
- {
- if (allowUnknownElements)
- {
- supOC =
- DirectoryServer.getDefaultObjectClass(woidBuffer.toString());
- }
- else
- {
- // This is bad because we don't know what the superior oc
- // is so we can't base this objectclass on it.
- LocalizableMessage message =
- WARN_ATTR_SYNTAX_OBJECTCLASS_UNKNOWN_SUPERIOR_CLASS.get(oid, woidBuffer);
- throw new DirectoryException(ResultCode.CONSTRAINT_VIOLATION, message);
- }
- }
-
- listSupOCs.add(supOC);
- // The next character must be either a dollar sign or a closing
- // parenthesis.
- c = valueStr.charAt(pos++);
- if (c == ')')
- {
- // This denotes the end of the list.
- break;
- }
- else if (c != '$')
- {
- LocalizableMessage message = ERR_ATTR_SYNTAX_OBJECTCLASS_ILLEGAL_CHAR.get(valueStr, c, pos-1);
- throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
- message);
- }
- }
- }
- else
- {
- StringBuilder woidBuffer = new StringBuilder();
- pos = readWOID(lowerStr, woidBuffer, pos-1);
- ObjectClass superiorClass =
- schema.getObjectClass(woidBuffer.toString());
- if (superiorClass == null)
- {
- if (allowUnknownElements)
- {
- superiorClass =
- DirectoryServer.getDefaultObjectClass(woidBuffer.toString());
- }
- else
- {
- // This is bad because we don't know what the superior oc
- // is so we can't base this objectclass on it.
- LocalizableMessage message =
- WARN_ATTR_SYNTAX_OBJECTCLASS_UNKNOWN_SUPERIOR_CLASS.get(oid, woidBuffer);
- throw new DirectoryException(ResultCode.CONSTRAINT_VIOLATION, message);
- }
- }
- listSupOCs.add(superiorClass);
- }
- superiorClasses.addAll(listSupOCs);
- }
- else if (lowerTokenName.equals("abstract"))
- {
- // This indicates that entries must not include this objectclass unless
- // they also include a non-abstract objectclass that inherits from this
- // class. We do not need any more parsing for this token.
- objectClassType = ObjectClassType.ABSTRACT;
- }
- else if (lowerTokenName.equals("structural"))
- {
- // This indicates that this is a structural objectclass. We do not need
- // any more parsing for this token.
- objectClassType = ObjectClassType.STRUCTURAL;
- }
- else if (lowerTokenName.equals("auxiliary"))
- {
- // This indicates that this is an auxiliary objectclass. We do not need
- // any more parsing for this token.
- objectClassType = ObjectClassType.AUXILIARY;
- }
- else if (lowerTokenName.equals("must"))
- {
- LinkedList<AttributeType> attrs = new LinkedList<>();
-
- // This specifies the set of required attributes for the objectclass.
- // 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.
- c = valueStr.charAt(pos++);
- if (c == '(')
- {
- while (true)
- {
- StringBuilder woidBuffer = new StringBuilder();
- pos = readWOID(lowerStr, woidBuffer, pos);
- attrs.add(getAttributeType(schema, allowUnknownElements, oid, woidBuffer,
- WARN_ATTR_SYNTAX_OBJECTCLASS_UNKNOWN_REQUIRED_ATTR));
-
- // The next character must be either a dollar sign or a closing parenthesis.
- c = valueStr.charAt(pos++);
- if (c == ')')
- {
- // This denotes the end of the list.
- break;
- }
- else if (c != '$')
- {
- LocalizableMessage message = ERR_ATTR_SYNTAX_OBJECTCLASS_ILLEGAL_CHAR.get(valueStr, c, pos-1);
- throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
- message);
- }
- }
- }
- else
- {
- StringBuilder woidBuffer = new StringBuilder();
- pos = readWOID(lowerStr, woidBuffer, pos-1);
- attrs.add(getAttributeType(schema, allowUnknownElements, oid, woidBuffer,
- WARN_ATTR_SYNTAX_OBJECTCLASS_UNKNOWN_REQUIRED_ATTR));
- }
-
- requiredAttributes.addAll(attrs);
- }
- else if (lowerTokenName.equals("may"))
- {
- LinkedList<AttributeType> attrs = new LinkedList<>();
-
- // This specifies the set of optional attributes for the objectclass.
- // 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.
- c = valueStr.charAt(pos++);
- if (c == '(')
- {
- while (true)
- {
- StringBuilder woidBuffer = new StringBuilder();
- pos = readWOID(lowerStr, woidBuffer, pos);
- attrs.add(getAttributeType(schema, allowUnknownElements, oid, woidBuffer,
- WARN_ATTR_SYNTAX_OBJECTCLASS_UNKNOWN_OPTIONAL_ATTR));
-
- // The next character must be either a dollar sign or a closing parenthesis.
- c = valueStr.charAt(pos++);
- if (c == ')')
- {
- // This denotes the end of the list.
- break;
- }
- else if (c != '$')
- {
- LocalizableMessage message = ERR_ATTR_SYNTAX_OBJECTCLASS_ILLEGAL_CHAR.get(valueStr, c, pos-1);
- throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
- message);
- }
- }
- }
- else
- {
- StringBuilder woidBuffer = new StringBuilder();
- pos = readWOID(lowerStr, woidBuffer, pos-1);
- attrs.add(getAttributeType(schema, allowUnknownElements, oid, woidBuffer,
- WARN_ATTR_SYNTAX_OBJECTCLASS_UNKNOWN_OPTIONAL_ATTR));
- }
-
- optionalAttributes.addAll(attrs);
- }
- 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.
- List<String> valueList = new LinkedList<>();
- pos = readExtraParameterValues(valueStr, valueList, pos);
- extraProperties.put(tokenName, valueList);
- }
- }
-
- //If SUP is not specified, use TOP.
- ObjectClass top = DirectoryServer.getTopObjectClass();
- if(superiorClasses.isEmpty() && !top.getOID().equals(oid))
- {
- superiorClasses.add(top);
- }
- else
- {
- for(ObjectClass superiorClass : superiorClasses)
- {
- // Make sure that the inheritance configuration is acceptable.
- ObjectClassType superiorType = superiorClass.getObjectClassType();
- switch (objectClassType)
- {
- case ABSTRACT:
- // Abstract classes may only inherit from other abstract classes.
- if (superiorType != ObjectClassType.ABSTRACT)
- {
- LocalizableMessage message =
- WARN_ATTR_SYNTAX_OBJECTCLASS_INVALID_SUPERIOR_TYPE.
- get(oid, objectClassType, superiorType, superiorClass.getNameOrOID());
- throw new DirectoryException(ResultCode.CONSTRAINT_VIOLATION,
- message);
- }
- break;
-
- case AUXILIARY:
- // Auxiliary classes may only inherit from abstract classes or other
- // auxiliary classes.
- if (superiorType != ObjectClassType.ABSTRACT &&
- superiorType != ObjectClassType.AUXILIARY)
- {
- LocalizableMessage message =
- WARN_ATTR_SYNTAX_OBJECTCLASS_INVALID_SUPERIOR_TYPE.
- get(oid, objectClassType, superiorType,
- superiorClass.getNameOrOID());
- throw new DirectoryException(ResultCode.CONSTRAINT_VIOLATION,
- message);
- }
- break;
-
- case STRUCTURAL:
- // Structural classes may only inherit from abstract classes or
- // other structural classes.
- if (superiorType != ObjectClassType.ABSTRACT &&
- superiorType != ObjectClassType.STRUCTURAL)
- {
- LocalizableMessage message =
- WARN_ATTR_SYNTAX_OBJECTCLASS_INVALID_SUPERIOR_TYPE.
- get(oid, objectClassType, superiorType,
- superiorClass.getNameOrOID());
- throw new DirectoryException(ResultCode.CONSTRAINT_VIOLATION,
- message);
- }
-
- // Structural classes must have the "top" objectclass somewhere in
- // the superior chain.
- if (! superiorChainIncludesTop(superiorClass))
- {
- LocalizableMessage message =
- WARN_ATTR_SYNTAX_OBJECTCLASS_STRUCTURAL_SUPERIOR_NOT_TOP.
- get(oid);
- throw new DirectoryException(ResultCode.CONSTRAINT_VIOLATION,
- message);
- }
- break;
- }
- }
- }
-
- CommonSchemaElements.checkSafeProperties(extraProperties);
-
- return new ObjectClass(value.toString(), primaryName, names, oid,
- description, superiorClasses, requiredAttributes,
- optionalAttributes, objectClassType, isObsolete,
- extraProperties);
- }
-
- private static AttributeType getAttributeType(Schema schema, boolean allowUnknownElements, String oid,
- StringBuilder woidBuffer, Arg2<Object, Object> msg) throws DirectoryException
- {
- String woidString = woidBuffer.toString();
- AttributeType attr = schema.getAttributeType(woidString);
- if (attr.isPlaceHolder() && !allowUnknownElements)
- {
- LocalizableMessage message = msg.get(oid, woidString);
- throw new DirectoryException(ResultCode.CONSTRAINT_VIOLATION, message);
- }
- return attr;
- }
-
- /**
- * Reads the next token name from the objectclass definition, skipping over
- * any leading or trailing spaces, and appends it to the provided buffer.
- *
- * @param valueStr The string representation of the objectclass 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.
- */
- private static int readTokenName(String valueStr, StringBuilder tokenName,
- int startPos)
- throws DirectoryException
- {
- // Skip over any spaces at the beginning of the value.
- char c = '\u0000';
- int length = valueStr.length();
- while (startPos < length && ((c = valueStr.charAt(startPos)) == ' '))
- {
- startPos++;
- }
-
- if (startPos >= length)
- {
- LocalizableMessage message =
- ERR_ATTR_SYNTAX_OBJECTCLASS_TRUNCATED_VALUE.get(valueStr);
- throw new DirectoryException(
- ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
-
-
- // Read until we find the next space.
- while (startPos < length && ((c = valueStr.charAt(startPos++)) != ' '))
- {
- tokenName.append(c);
- }
-
-
- // Skip over any trailing spaces after the value.
- while (startPos < length && ((c = valueStr.charAt(startPos)) == ' '))
- {
- 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 objectclass
- * 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.
- */
- private static int readQuotedString(String valueStr,
- StringBuilder valueBuffer, int startPos)
- throws DirectoryException
- {
- // Skip over any spaces at the beginning of the value.
- char c = '\u0000';
- int length = valueStr.length();
- while (startPos < length && ((c = valueStr.charAt(startPos)) == ' '))
- {
- startPos++;
- }
-
- if (startPos >= length)
- {
- LocalizableMessage message =
- ERR_ATTR_SYNTAX_OBJECTCLASS_TRUNCATED_VALUE.get(valueStr);
- throw new DirectoryException(
- ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
-
-
- // The next character must be a single quote.
- if (c != '\'')
- {
- LocalizableMessage message = WARN_ATTR_SYNTAX_OBJECTCLASS_EXPECTED_QUOTE_AT_POS.get(
- valueStr,startPos, c);
- throw new DirectoryException(
- ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
-
-
- // Read until we find the closing quote.
- startPos++;
- while (startPos < length && ((c = valueStr.charAt(startPos)) != '\''))
- {
- valueBuffer.append(c);
- startPos++;
- }
-
-
- // Skip over any trailing spaces after the value.
- startPos++;
- while (startPos < length && ((c = valueStr.charAt(startPos)) == ' '))
- {
- startPos++;
- }
-
-
- // If we're at the end of the value, then that's illegal.
- if (startPos >= length)
- {
- LocalizableMessage message =
- ERR_ATTR_SYNTAX_OBJECTCLASS_TRUNCATED_VALUE.get(valueStr);
- throw new DirectoryException(
- ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
-
-
- // 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 objectclass
- * definition.
- * @param lowerStr The all-lowercase representation of the objectclass
- * 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.
- */
- private static int readQuotedString(String valueStr, String lowerStr,
- StringBuilder userBuffer,
- StringBuilder lowerBuffer, int startPos)
- throws DirectoryException
- {
- // Skip over any spaces at the beginning of the value.
- char c = '\u0000';
- int length = lowerStr.length();
- while (startPos < length && ((c = lowerStr.charAt(startPos)) == ' '))
- {
- startPos++;
- }
-
- if (startPos >= length)
- {
- LocalizableMessage message =
- ERR_ATTR_SYNTAX_OBJECTCLASS_TRUNCATED_VALUE.get(lowerStr);
- throw new DirectoryException(
- ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
-
-
- // The next character must be a single quote.
- if (c != '\'')
- {
- LocalizableMessage message = WARN_ATTR_SYNTAX_OBJECTCLASS_EXPECTED_QUOTE_AT_POS.get(
- valueStr,startPos, c);
- throw new DirectoryException(
- ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
-
-
- // Read until we find the closing quote.
- startPos++;
- while (startPos < length && ((c = lowerStr.charAt(startPos)) != '\''))
- {
- lowerBuffer.append(c);
- userBuffer.append(valueStr.charAt(startPos));
- startPos++;
- }
-
-
- // Skip over any trailing spaces after the value.
- startPos++;
- while (startPos < length && ((c = lowerStr.charAt(startPos)) == ' '))
- {
- startPos++;
- }
-
-
- // If we're at the end of the value, then that's illegal.
- if (startPos >= length)
- {
- LocalizableMessage message =
- ERR_ATTR_SYNTAX_OBJECTCLASS_TRUNCATED_VALUE.get(lowerStr);
- throw new DirectoryException(
- ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
-
-
- // Return the position of the first non-space character after the token.
- return startPos;
- }
-
- /**
- * Reads the attribute type/objectclass 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.
- */
- private static int readWOID(String lowerStr, StringBuilder woidBuffer,
- int startPos)
- throws DirectoryException
- {
- // Skip over any spaces at the beginning of the value.
- char c = '\u0000';
- int length = lowerStr.length();
- boolean allowExceptions = DirectoryServer.isRunning()?
- DirectoryServer.allowAttributeNameExceptions():true;
- while (startPos < length && ((c = lowerStr.charAt(startPos)) == ' '))
- {
- startPos++;
- }
-
- if (startPos >= length)
- {
- LocalizableMessage message =
- ERR_ATTR_SYNTAX_OBJECTCLASS_TRUNCATED_VALUE.get(lowerStr);
- throw new DirectoryException(
- ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
-
-
- // The next character must be either numeric (for an OID) or alphabetic (for
- // an objectclass 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;
- while (startPos < length && ((c = lowerStr.charAt(startPos++)) != ' '))
- {
- if (c == '.')
- {
- if (lastWasPeriod)
- {
- LocalizableMessage message =
- ERR_ATTR_SYNTAX_OBJECTCLASS_DOUBLE_PERIOD_IN_NUMERIC_OID.
- get(lowerStr, startPos-1);
- throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
- woidBuffer.append(c);
- lastWasPeriod = true;
- }
- else if (!isDigit(c) && (!allowExceptions || (!isAlpha(c) && c != '-' && c != '_')))
- {
- // Technically, this must be an illegal character. However, it is
- // possible that someone just got sloppy and did not include a space
- // between the name/OID and a closing parenthesis. In that case,
- // 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.
- LocalizableMessage message =
- ERR_ATTR_SYNTAX_OBJECTCLASS_ILLEGAL_CHAR_IN_NUMERIC_OID.
- get(lowerStr, c, startPos-1);
- throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
- else
- {
- woidBuffer.append(c);
- lastWasPeriod = false;
- }
- }
- }
- else if (isAlpha(c))
- {
- // This must be an objectclass description. In this case, we will only
- // accept alphabetic characters, numeric digits, and the hyphen.
- while (startPos < length && ((c = lowerStr.charAt(startPos++)) != ' '))
- {
- if (isAlpha(c) || isDigit(c) || c == '-' ||
- (c == '_' && allowExceptions))
- {
- 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
- // between the name/OID and a closing parenthesis. In that case,
- // 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.
- LocalizableMessage message =
- ERR_ATTR_SYNTAX_OBJECTCLASS_ILLEGAL_CHAR_IN_STRING_OID.
- get(lowerStr, c, startPos-1);
- throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
- }
- }
- else
- {
- LocalizableMessage message =
- ERR_ATTR_SYNTAX_OBJECTCLASS_ILLEGAL_CHAR.get(lowerStr, c, startPos);
- throw new DirectoryException(
- ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
-
-
- // Skip over any trailing spaces after the value.
- while (startPos < length && ((c = lowerStr.charAt(startPos)) == ' '))
- {
- startPos++;
- }
-
-
- // If we're at the end of the value, then that's illegal.
- if (startPos >= length)
- {
- LocalizableMessage message =
- ERR_ATTR_SYNTAX_OBJECTCLASS_TRUNCATED_VALUE.get(lowerStr);
- throw new DirectoryException(
- ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
-
-
- // 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.
- */
- private static int readExtraParameterValues(String valueStr,
- List<String> valueList, int startPos)
- throws DirectoryException
- {
- // Skip over any leading spaces.
- int length = valueStr.length();
- char c = valueStr.charAt(startPos++);
- while (startPos < length && c == ' ')
- {
- c = valueStr.charAt(startPos++);
- }
-
- if (startPos >= length)
- {
- LocalizableMessage message =
- ERR_ATTR_SYNTAX_OBJECTCLASS_TRUNCATED_VALUE.get(valueStr);
- throw new DirectoryException(
- ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
-
-
- // 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.
- StringBuilder valueBuffer = new StringBuilder();
- while (startPos < length && ((c = valueStr.charAt(startPos++)) != '\''))
- {
- valueBuffer.append(c);
- }
-
- valueList.add(valueBuffer.toString());
- }
- else if (c == '(')
- {
- startPos++;
- while (true)
- {
- // Skip over any leading spaces;
- while (startPos < length && ((c = valueStr.charAt(startPos)) == ' '))
- {
- startPos++;
- }
-
- if (startPos >= length)
- {
- LocalizableMessage message =
- ERR_ATTR_SYNTAX_OBJECTCLASS_TRUNCATED_VALUE.get(valueStr);
- throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
- message);
- }
-
-
- if (c == ')')
- {
- // This is the end of the list.
- startPos++;
- break;
- }
- else if (c == '(')
- {
- // This is an illegal character.
- LocalizableMessage message = ERR_ATTR_SYNTAX_OBJECTCLASS_ILLEGAL_CHAR.get(valueStr, c, startPos);
- throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
- message);
- }
- else
- {
- // We'll recursively call this method to deal with this.
- startPos = readExtraParameterValues(valueStr, valueList, startPos);
- }
- }
- }
- else
- {
- // Parse until the next space.
- StringBuilder valueBuffer = new StringBuilder();
- while (startPos < length && ((c = valueStr.charAt(startPos++)) != ' '))
- {
- valueBuffer.append(c);
- }
-
- valueList.add(valueBuffer.toString());
- }
-
- // Skip over any trailing spaces.
- while (startPos < length && valueStr.charAt(startPos) == ' ')
- {
- startPos++;
- }
-
- if (startPos >= length)
- {
- LocalizableMessage message =
- ERR_ATTR_SYNTAX_OBJECTCLASS_TRUNCATED_VALUE.get(valueStr);
- throw new DirectoryException(
- ResultCode.INVALID_ATTRIBUTE_SYNTAX, message);
- }
-
-
- return startPos;
- }
-
- /**
- * Indicates whether the provided objectclass or any of its superiors is equal
- * to the "top" objectclass.
- *
- * @param superiorClass The objectclass for which to make the determination.
- *
- * @return {@code true} if the provided class or any of its superiors is
- * equal to the "top" objectclass, or {@code false} if not.
- */
- private static boolean superiorChainIncludesTop(ObjectClass superiorClass)
- {
- if (superiorClass == null)
- {
- return false;
- }
- else if (superiorClass.hasName(OC_TOP))
- {
- return true;
- }
- else
- {
- for(ObjectClass oc : superiorClass.getSuperiorClasses())
- {
- if(superiorChainIncludesTop(oc))
- {
- return true;
- }
- }
- }
- return false;
- }
-}
-
+}
\ No newline at end of file
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/types/Schema.java b/opendj-server-legacy/src/main/java/org/opends/server/types/Schema.java
index a52445f..c04aeea 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/types/Schema.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/types/Schema.java
@@ -67,8 +67,6 @@
import org.opends.server.schema.DITContentRuleSyntax;
import org.opends.server.schema.DITStructureRuleSyntax;
import org.opends.server.schema.NameFormSyntax;
-import org.opends.server.schema.ObjectClassSyntax;
-import org.opends.server.schema.SomeSchemaElement;
import org.opends.server.util.Base64;
import org.opends.server.util.ServerConstants;
import org.opends.server.util.StaticUtils;
@@ -281,6 +279,37 @@
}
/**
+ * Parses an object class from its provided definition.
+ *
+ * @param definition
+ * The definition of the object class
+ * @return the object class
+ * @throws DirectoryException
+ * If an error occurs
+ */
+ public ObjectClass parseObjectClass(final String definition) throws DirectoryException
+ {
+ try
+ {
+ SchemaBuilder builder = new SchemaBuilder(schemaNG);
+ builder.addObjectClass(definition, true);
+ org.forgerock.opendj.ldap.schema.Schema newSchema = builder.toSchema();
+ rejectSchemaWithWarnings(newSchema);
+ return newSchema.getObjectClass(parseObjectClassOID(definition));
+ }
+ catch (UnknownSchemaElementException e)
+ {
+ // this should never happen
+ LocalizableMessage msg = ERR_OBJECT_CLASS_CANNOT_REGISTER.get(definition);
+ throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM, msg, e);
+ }
+ catch (LocalizedIllegalArgumentException e)
+ {
+ throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, e.getMessageObject(), e);
+ }
+ }
+
+ /**
* Parses an attribute type from its provided definition.
*
* @param definition
@@ -478,6 +507,11 @@
}
}
+ private String parseObjectClassOID(String definition) throws DirectoryException
+ {
+ return parseOID(definition, ResultCode.INVALID_ATTRIBUTE_SYNTAX, ERR_ATTR_SYNTAX_OBJECTCLASS_EMPTY_VALUE);
+ }
+
private String parseAttributeTypeOID(String definition) throws DirectoryException
{
return parseOID(definition, ResultCode.INVALID_ATTRIBUTE_SYNTAX, ERR_ATTR_SYNTAX_ATTRTYPE_EMPTY_VALUE);
@@ -694,46 +728,110 @@
return getSchemaNG().getObjectClass(lowerName);
}
-
+ /**
+ * Registers the provided objectclass definition with this schema.
+ *
+ * @param objectClass
+ * The objectclass to register with this schema.
+ * @param overwriteExisting
+ * Indicates whether to overwrite an existing mapping if there are any conflicts (i.e.,
+ * another objectclass with the same OID or name).
+ * @throws DirectoryException
+ * If a conflict is encountered and the {@code overwriteExisting} flag is set to
+ * {@code false}.
+ */
+ public void registerObjectClass(ObjectClass objectClass, boolean overwriteExisting) throws DirectoryException
+ {
+ String schemaFile = getSchemaFileName(objectClass);
+ registerObjectClass(objectClass, schemaFile, overwriteExisting);
+ }
/**
* Registers the provided objectclass definition with this schema.
*
- * @param objectClass The objectclass to register with this
- * schema.
- * @param overwriteExisting Indicates whether to overwrite an
- * existing mapping if there are any
- * conflicts (i.e., another objectclass
- * with the same OID or name).
- *
- * @throws DirectoryException If a conflict is encountered and the
- * <CODE>overwriteExisting</CODE> flag
- * is set to <CODE>false</CODE>.
+ * @param objectClass
+ * The objectclass to register with this schema.
+ * @param schemaFile
+ * The schema file where this definition belongs, maybe {@code null}
+ * @param overwriteExisting
+ * Indicates whether to overwrite an existing mapping if there are any conflicts (i.e.,
+ * another objectclass with the same OID or name).
+ * @throws DirectoryException
+ * If a conflict is encountered and the {@code overwriteExisting} flag is set to
+ * {@code false}.
*/
- public void registerObjectClass(ObjectClass objectClass,
- boolean overwriteExisting)
+ public void registerObjectClass(ObjectClass objectClass, String schemaFile, boolean overwriteExisting)
throws DirectoryException
{
exclusiveLock.lock();
try
{
SchemaBuilder builder = new SchemaBuilder(schemaNG);
- ObjectClass.Builder b = builder.buildObjectClass(objectClass);
- String schemaFile = getSchemaFileName(objectClass);
- if (schemaFile != null)
+ registerObjectClass0(builder, objectClass, schemaFile, overwriteExisting);
+ switchSchema(builder.toSchema());
+ }
+ finally
+ {
+ exclusiveLock.unlock();
+ }
+ }
+
+ private void registerObjectClass0(SchemaBuilder builder, ObjectClass objectClass, String schemaFile,
+ boolean overwriteExisting)
+ {
+ ObjectClass.Builder b = builder.buildObjectClass(objectClass);
+ if (schemaFile != null)
+ {
+ b.removeExtraProperty(SCHEMA_PROPERTY_FILENAME).extraProperties(SCHEMA_PROPERTY_FILENAME, schemaFile);
+ }
+ if (overwriteExisting)
+ {
+ b.addToSchemaOverwrite();
+ }
+ else
+ {
+ b.addToSchema();
+ }
+ }
+
+ /**
+ * Registers a list of object classes from their provided definitions.
+ * <p>
+ * This method allows to do only one schema change for multiple definitions,
+ * thus avoiding the cost (and the issue of stale schema references) of rebuilding a new schema for each definition.
+ *
+ * @param definitions
+ * The definitions of the object classes
+ * @param schemaFile
+ * The schema file where these definitions belong, can be {@code null}
+ * @param overwrite
+ * Indicates whether to overwrite the attribute
+ * type if it already exists based on OID or name
+ * @throws DirectoryException
+ * If an error occurs
+ */
+ public void registerObjectClasses(final List<String> definitions, final String schemaFile, final boolean overwrite)
+ throws DirectoryException
+ {
+ exclusiveLock.lock();
+ try
+ {
+ SchemaBuilder builder = new SchemaBuilder(schemaNG);
+ for (String definition : definitions)
{
- b.removeExtraProperty(SCHEMA_PROPERTY_FILENAME).extraProperties(SCHEMA_PROPERTY_FILENAME, schemaFile);
- }
- if (overwriteExisting)
- {
- b.addToSchemaOverwrite();
- }
- else
- {
- b.addToSchema();
+ String defWithFile = getDefinitionWithSchemaFile(definition, schemaFile);
+ builder.addObjectClass(defWithFile, overwrite);
}
switchSchema(builder.toSchema());
}
+ catch (ConflictingSchemaElementException | UnknownSchemaElementException e)
+ {
+ throw new DirectoryException(ResultCode.CONSTRAINT_VIOLATION, e.getMessageObject(), e);
+ }
+ catch (LocalizedIllegalArgumentException e)
+ {
+ throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX, e.getMessageObject(), e);
+ }
finally
{
exclusiveLock.unlock();
@@ -1836,13 +1934,9 @@
// increase the depth for each level of recursion to protect against errors due to circular references.
final int depth = 0;
- if (element instanceof SomeSchemaElement)
+ if (element instanceof AttributeType)
{
- SomeSchemaElement elt = (SomeSchemaElement) element;
- if (elt.isAttributeType())
- {
- rebuildDependentElements(elt.getAttributeType(), depth);
- }
+ rebuildDependentElements((AttributeType) element, depth);
}
else if (element instanceof ObjectClass)
{
@@ -1903,9 +1997,8 @@
{
if (oc.getDeclaredRequiredAttributes().contains(type) || oc.getDeclaredOptionalAttributes().contains(type))
{
- ObjectClass newOC = recreateFromDefinition(oc);
deregisterObjectClass(oc);
- registerObjectClass(newOC, true);
+ registerObjectClass(oc.toString(), getSchemaFile(oc), true);
rebuildDependentElements(oc, depth + 1);
}
}
@@ -1945,19 +2038,28 @@
}
}
+ /**
+ * Registers an object class from its provided definition.
+ *
+ * @param definition
+ * The definition of the object class
+ * @param schemaFile
+ * The schema file where this definition belongs, may be {@code null}
+ * @param overwriteExisting
+ * Indicates whether to overwrite the object class
+ * if it already exists based on OID or name
+ * @throws DirectoryException
+ * If an error occurs
+ */
+ public void registerObjectClass(String definition, String schemaFile, boolean overwriteExisting)
+ throws DirectoryException
+ {
+ registerObjectClasses(Collections.singletonList(definition), schemaFile, overwriteExisting);
+ }
+
private void rebuildDependentElements(ObjectClass c, int depth) throws DirectoryException
{
circularityCheck(depth, c);
- for (ObjectClass oc : getObjectClasses())
- {
- if (oc.getSuperiorClasses().contains(c))
- {
- ObjectClass newOC = recreateFromDefinition(oc);
- deregisterObjectClass(oc);
- registerObjectClass(newOC, true);
- rebuildDependentElements(oc, depth + 1);
- }
- }
List<NameForm> mappedForms = nameFormsByOC.get(c);
if (mappedForms != null)
@@ -2048,15 +2150,6 @@
return copy;
}
- private ObjectClass recreateFromDefinition(ObjectClass oc)
- throws DirectoryException
- {
- ByteString value = ByteString.valueOfUtf8(oc.toString());
- ObjectClass copy = ObjectClassSyntax.decodeObjectClass(value, this, false);
- setSchemaFile(copy, getSchemaFile(oc));
- return copy;
- }
-
/**
* Creates a new {@link Schema} object that is a duplicate of this one. It elements may be added
* and removed from the duplicate without impacting this version.
@@ -2674,4 +2767,34 @@
ERR_SCHEMA_HAS_WARNINGS.get(warnings.size(), Utils.joinAsString("; ", warnings)));
}
}
+
+ /**
+ * Replaces an existing object class by another object class.
+ *
+ * @param objectClass
+ * Object class to register to the schema.
+ * @param existingClass
+ * Object class to remove from the schema.
+ * @param schemaFile
+ * The schema file which the new object class belongs to.
+ * @throws DirectoryException
+ * If an errors occurs.
+ */
+ public void replaceObjectClass(ObjectClass objectClass, ObjectClass existingClass, String schemaFile)
+ throws DirectoryException
+ {
+ exclusiveLock.lock();
+ try
+ {
+ SchemaBuilder builder = new SchemaBuilder(schemaNG);
+ builder.removeObjectClass(existingClass.getNameOrOID());
+ registerObjectClass0(builder, objectClass, schemaFile, false);
+ switchSchema(builder.toSchema());
+ }
+ finally
+ {
+ exclusiveLock.unlock();
+ }
+ rebuildDependentElements(existingClass);
+ }
}
diff --git a/opendj-server-legacy/src/messages/org/opends/messages/schema.properties b/opendj-server-legacy/src/messages/org/opends/messages/schema.properties
index 1ba08c8..b6a1466 100644
--- a/opendj-server-legacy/src/messages/org/opends/messages/schema.properties
+++ b/opendj-server-legacy/src/messages/org/opends/messages/schema.properties
@@ -499,4 +499,6 @@
ERR_SCHEMA_HAS_WARNINGS_341=There should be no warnings on the schema, \
but instead got %d warnings: %s
ERR_MATCHING_RULE_USE_CANNOT_REGISTER_342=Matching rule use could not be \
+ registered from definition: %s
+ERR_OBJECT_CLASS_CANNOT_REGISTER_343=Object class could not be \
registered from definition: %s
\ No newline at end of file
diff --git a/opendj-server-legacy/src/test/java/org/opends/server/schema/GenericSchemaTestCase.java b/opendj-server-legacy/src/test/java/org/opends/server/schema/GenericSchemaTestCase.java
index b0d1f03..e67153b 100644
--- a/opendj-server-legacy/src/test/java/org/opends/server/schema/GenericSchemaTestCase.java
+++ b/opendj-server-legacy/src/test/java/org/opends/server/schema/GenericSchemaTestCase.java
@@ -24,6 +24,7 @@
import org.forgerock.opendj.ldap.ByteString;
import org.forgerock.opendj.ldap.schema.AttributeType;
import org.forgerock.opendj.ldap.schema.MatchingRule;
+import org.forgerock.opendj.ldap.schema.ObjectClass;
import org.forgerock.opendj.ldap.schema.Syntax;
import org.opends.server.TestCaseUtils;
import org.opends.server.core.DirectoryServer;
@@ -31,7 +32,6 @@
import org.opends.server.types.Entry;
import org.opends.server.types.LDIFImportConfig;
import org.opends.server.types.NameForm;
-import org.forgerock.opendj.ldap.schema.ObjectClass;
import org.opends.server.types.Schema;
import org.opends.server.util.LDIFReader;
import org.testng.annotations.BeforeClass;
@@ -40,10 +40,7 @@
import static org.opends.server.util.ServerConstants.*;
import static org.testng.Assert.*;
-/**
- * This class defines a set of generic tests that may be used to examine the
- * server schema.
- */
+/** This class defines a set of generic tests that may be used to examine the server schema. */
public class GenericSchemaTestCase
extends SchemaTestCase
{
@@ -230,19 +227,18 @@
}
LDIFImportConfig importConfig = new LDIFImportConfig(f.getAbsolutePath());
- LDIFReader reader = new LDIFReader(importConfig);
- Entry e = reader.readEntry();
- reader.close();
-
- if (e == null)
+ Entry e;
+ try (LDIFReader reader = new LDIFReader(importConfig))
{
- // An empty schema file. This is OK.
- continue;
+ e = reader.readEntry();
+ if (e == null)
+ {
+ // An empty schema file. This is OK.
+ continue;
+ }
}
- AttributeType attrType = DirectoryServer.getAttributeType("objectclasses");
- assertNotNull(attrType);
- List<Attribute> attrList = e.getAttribute(attrType);
+ List<Attribute> attrList = e.getAttribute("objectclasses");
if (attrList.isEmpty())
{
// No attribute types in the schema file. This is OK.
@@ -253,8 +249,7 @@
{
for (ByteString v : a)
{
- ObjectClass oc = ObjectClassSyntax.decodeObjectClass(
- v, DirectoryServer.getSchema(), true);
+ ObjectClass oc = DirectoryServer.getSchema().parseObjectClass(v.toString());
if (! isNumericOID(oc.getOID()))
{
invalidOIDs.add(oc.getNameOrOID());
@@ -265,17 +260,13 @@
if (! invalidOIDs.isEmpty())
{
- StringBuilder message = new StringBuilder();
- message.append("All object classes defined in OpenDS must have valid ").append("OIDs assigned.");
- message.append(EOL);
- message.append("Object classes without valid OIDs:");
- message.append(EOL);
+ StringBuilder message = new StringBuilder()
+ .append("All object classes defined in OpenDS must have valid OIDs assigned.").append(EOL)
+ .append("Object classes without valid OIDs:").append(EOL);
for (String s : invalidOIDs)
{
- message.append("- ").append(s);
- message.append(EOL);
+ message.append("- ").append(s).append(EOL);
}
-
throw new AssertionError(message.toString());
}
}
--
Gitblit v1.10.0