OPENDJ-1235: Migrate configuration framework

Matthew Swift

06.24.2014 2d5b96b4f44bc2ac687fdb9718514d30add072e1

OPENDJ-1235: Migrate configuration framework

Remove dependency on server ACI support:

* use regular expression for basic validation. The RE is taken from the server's Aci class
* change value type of ACI properties from "Aci" to "String".

 opendj-config-maven-plugin/src/main/resources/config/stylesheets/property-types/aci.xsl

@@ -28,11 +28,8 @@
  <!-- 
    Templates for processing dseecompat ACI.
  -->
  <xsl:template match="adm:aci" mode="java-value-imports">
    <import>org.opends.server.authorization.dseecompat.Aci</import>
  </xsl:template>
  <xsl:template match="adm:aci" mode="java-value-type">
    <xsl:value-of select="'Aci'" />
    <xsl:value-of select="'String'" />
  </xsl:template>
  <xsl:template match="adm:aci" mode="java-definition-type">
    <xsl:value-of select="'ACIPropertyDefinition'" />

 opendj-config/src/main/java/org/forgerock/opendj/config/ACIPropertyDefinition.java

@@ -26,23 +26,20 @@

package org.forgerock.opendj.config;

import org.forgerock.util.Reject;
import org.opends.server.authorization.dseecompat.Aci;
import org.forgerock.i18n.LocalizedIllegalArgumentException;
import org.forgerock.opendj.ldap.ByteString;
import org.forgerock.opendj.ldap.DN;

import java.util.EnumSet;
import java.util.regex.Pattern;

import org.forgerock.util.Reject;

/**
 * ACI property definition.
 */
public final class ACIPropertyDefinition extends PropertyDefinition<Aci> {
public final class ACIPropertyDefinition extends PropertyDefinition<String> {

    /**
     * An interface for incrementally constructing ACI property definitions.
     */
    public static final class Builder extends AbstractBuilder<Aci, ACIPropertyDefinition> {
    public static final class Builder extends AbstractBuilder<String, ACIPropertyDefinition> {

        // Private constructor
        private Builder(AbstractManagedObjectDefinition<?, ?> d, String propertyName) {
@@ -53,9 +50,9 @@
         * {@inheritDoc}
         */
        @Override
        protected ACIPropertyDefinition buildInstance(AbstractManagedObjectDefinition<?, ?> d, String propertyName,
            EnumSet<PropertyOption> options, AdministratorAction adminAction,
            DefaultBehaviorProvider<Aci> defaultBehavior) {
        protected ACIPropertyDefinition buildInstance(AbstractManagedObjectDefinition<?, ?> d,
                String propertyName, EnumSet<PropertyOption> options,
                AdministratorAction adminAction, DefaultBehaviorProvider<String> defaultBehavior) {
            return new ACIPropertyDefinition(d, propertyName, options, adminAction, defaultBehavior);
        }
    }
@@ -74,18 +71,27 @@
        return new Builder(d, propertyName);
    }

    /**
     * Pattern used for performing basic ACI syntax validation. Taken from the
     * Aci class in the server.
     */
    private static final Pattern ACI_REGEX =
            Pattern.compile("^\\s*(\\(\\s*(\\w+)\\s*(!?=)\\s*\"([^\"]+)\"\\s*\\)\\s*)*\\s*\\"
                    + "(\\s*(?i)version(?-i)\\s*(\\d\\.\\d)\\s*;\\s*(?i)acl(?-i)\\s*\"([^\"]*)"
                    + "\"\\s*;\\s*\\s*(\\w+)\\s*\\(([^()]+)\\)\\s*(.+?\"[)]*)\\s*;\\s*\\s*\\)\\s*$");

    // Private constructor.
    private ACIPropertyDefinition(AbstractManagedObjectDefinition<?, ?> d, String propertyName,
        EnumSet<PropertyOption> options, AdministratorAction adminAction,
        DefaultBehaviorProvider<Aci> defaultBehavior) {
        super(d, Aci.class, propertyName, options, adminAction, defaultBehavior);
            EnumSet<PropertyOption> options, AdministratorAction adminAction,
            DefaultBehaviorProvider<String> defaultBehavior) {
        super(d, String.class, propertyName, options, adminAction, defaultBehavior);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void validateValue(Aci value) {
    public void validateValue(String value) {
        Reject.ifNull(value);

        // No additional validation required.
@@ -95,15 +101,20 @@
     * {@inheritDoc}
     */
    @Override
    public Aci decodeValue(String value) {
    public String decodeValue(String value) {
        Reject.ifNull(value);

        try {
            return Aci.decode(ByteString.valueOf(value), DN.rootDN());
        } catch (LocalizedIllegalArgumentException e) {
            // TODO: it would be nice to throw the cause.
            throw PropertyException.illegalPropertyValueException(this, value);
        /*
         * We don't have access to the ACI class from the server so do
         * best-effort using regular expressions. TODO: is it worth improving on
         * this? We could use reflection to get the appropriate parser which
         * would allow us to use full validation in OpenDJ whilst remaining
         * decoupled in other applications.
         */
        if (ACI_REGEX.matcher(value).matches()) {
            return value;
        }
        throw PropertyException.illegalPropertyValueException(this, value);
    }

    /**
@@ -118,7 +129,7 @@
     * {@inheritDoc}
     */
    @Override
    public <R, P> R accept(PropertyValueVisitor<R, P> v, Aci value, P p) {
    public <R, P> R accept(PropertyValueVisitor<R, P> v, String value, P p) {
        return v.visitACI(this, value, p);
    }

@@ -126,7 +137,7 @@
     * {@inheritDoc}
     */
    @Override
    public int compare(Aci o1, Aci o2) {
    public int compare(String o1, String o2) {
        return o1.toString().compareTo(o2.toString());
    }
}

 opendj-config/src/main/java/org/forgerock/opendj/config/PropertyValueVisitor.java

@@ -31,7 +31,6 @@
import org.forgerock.opendj.ldap.AddressMask;
import org.forgerock.opendj.ldap.DN;
import org.forgerock.opendj.ldap.schema.AttributeType;
import org.opends.server.authorization.dseecompat.Aci;

/**
 * A visitor of property values, in the style of the visitor design pattern.
@@ -75,7 +74,7 @@
     *            A visitor specified parameter.
     * @return Returns a visitor specified result.
     */
    public R visitACI(ACIPropertyDefinition pd, Aci v, P p) {
    public R visitACI(ACIPropertyDefinition pd, String v, P p) {
        return visitUnknown(pd, v, p);
    }


 opendj-config/src/main/java/org/opends/server/authorization/dseecompat/Aci.java

File was deleted

 opendj-config/src/main/java/org/opends/server/authorization/dseecompat/package-info.java

File was deleted