Package org.forgerock.opendj.config

Class AggregationPropertyDefinition<C extends ConfigurationClient,​S extends Configuration>

  • Type Parameters:
    C - The type of client managed object configuration that this aggregation property definition refers to.
    S - The type of server managed object configuration that this aggregation property definition refers to.
    All Implemented Interfaces:
    Comparable<PropertyDefinition<?>>, Comparator<String>
    public final class AggregationPropertyDefinition<C extends ConfigurationClient,​S extends Configuration>
extends PropertyDefinition<String>
    Aggregation property definition.

    An aggregation property names one or more managed objects which are required by the managed object associated with this property. An aggregation property definition takes care to perform referential integrity checks: referenced managed objects cannot be deleted. Nor can an aggregation reference non-existent managed objects. Referential integrity checks are not performed during value validation. Instead they are performed when changes to the managed object are committed.

    An aggregation property definition can optionally identify two properties:

    • an enabled property in the aggregated managed object - the property must be a BooleanPropertyDefinition and indicate whether the aggregated managed object is enabled or not. If specified, the administration framework will prevent the aggregated managed object from being disabled while it is referenced
    • an enabled property in this property's managed object - the property must be a BooleanPropertyDefinition and indicate whether this property's managed object is enabled or not. If specified, and as long as there is an equivalent enabled property defined for the aggregated managed object, the enabled property in the aggregated managed object will only be checked when this property is true.
    In other words, these properties can be used to make sure that referenced managed objects are not disabled while they are referenced.

    • Method Detail

      • createBuilder

        public static <C extends ConfigurationClient,​S extends Configuration> AggregationPropertyDefinition.Builder<C,​S> createBuilder​(AbstractManagedObjectDefinition<?,​?> d,
                                                                                                                                           String propertyName)
        Creates an aggregation property definition builder.
        Type Parameters:
        C - The type of client managed object configuration that this aggregation property definition refers to.
        S - The type of server managed object configuration that this aggregation property definition refers to.
        Parameters:
        d - The managed object definition associated with this property definition.
        propertyName - The property name.
        Returns:
        Returns the new aggregation property definition builder.

      • accept

        public <R,​P> R accept​(PropertyDefinitionVisitor<R,​P> v,
                            P p)
        Description copied from class: PropertyDefinition
        Apply a visitor to this property definition.
        Specified by:
        accept in class PropertyDefinition<String>
        Type Parameters:
        R - The return type of the visitor's methods.
        P - The type of the additional parameters to the visitor's methods.
        Parameters:
        v - The property definition visitor.
        p - Optional additional visitor parameter.
        Returns:
        Returns a result as specified by the visitor.

      • accept

        public <R,​P> R accept​(PropertyValueVisitor<R,​P> v,
                            String value,
                            P p)
        Description copied from class: PropertyDefinition
        Apply a visitor to a property value associated with this property definition.
        Specified by:
        accept in class PropertyDefinition<String>
        Type Parameters:
        R - The return type of the visitor's methods.
        P - The type of the additional parameters to the visitor's methods.
        Parameters:
        v - The property value visitor.
        value - The property value.
        p - Optional additional visitor parameter.
        Returns:
        Returns a result as specified by the visitor.

      • decodeValue

        public String decodeValue​(String value)
        Description copied from class: PropertyDefinition
        Parse and validate a string representation of a property value.
        Specified by:
        decodeValue in class PropertyDefinition<String>
        Parameters:
        value - The property string value (must not be null).
        Returns:
        Returns the decoded property value.

      • getChildDN

        public final org.forgerock.opendj.ldap.DN getChildDN​(String name)
        Constructs a DN for a referenced managed object having the provided name. This method is implemented by first calling getChildPath(String) and then invoking ManagedObjectPath.toDN() on the returned path.
        Parameters:
        name - The name of the child managed object.
        Returns:
        Returns a DN for a referenced managed object having the provided name.

      • getChildPath

        public final ManagedObjectPath<C,​S> getChildPath​(String name)
        Constructs a managed object path for a referenced managed object having the provided name.
        Parameters:
        name - The name of the child managed object.
        Returns:
        Returns a managed object path for a referenced managed object having the provided name.

      • getParentPath

        public final ManagedObjectPath<?,​?> getParentPath()
        Gets the name of the managed object which is the parent of the aggregated managed objects.
        Returns:
        Returns the name of the managed object which is the parent of the aggregated managed objects.

      • getRelationDefinition

        public final InstantiableRelationDefinition<C,​S> getRelationDefinition()
        Gets the relation in the parent managed object which contains the aggregated managed objects.
        Returns:
        Returns the relation in the parent managed object which contains the aggregated managed objects.

      • getSourceConstraint

        public final Constraint getSourceConstraint()
        Gets the constraint which should be enforced on the aggregating managed object.
        Returns:
        Returns the constraint which should be enforced on the aggregating managed object.

      • getSourceConstraintSynopsis

        public final org.forgerock.i18n.LocalizableMessage getSourceConstraintSynopsis()
        Gets the optional constraint synopsis of this aggregation property definition in the default locale. The constraint synopsis describes when and how referenced managed objects must be enabled. When there are no constraints between the source managed object and the objects it references through this aggregation, null is returned.
        Returns:
        Returns the optional constraint synopsis of this aggregation property definition in the default locale, or null if there is no constraint synopsis.

      • getSourceConstraintSynopsis

        public final org.forgerock.i18n.LocalizableMessage getSourceConstraintSynopsis​(Locale locale)
        Gets the optional constraint synopsis of this aggregation property definition in the specified locale.The constraint synopsis describes when and how referenced managed objects must be enabled. When there are no constraints between the source managed object and the objects it references through this aggregation, null is returned.
        Parameters:
        locale - The locale.
        Returns:
        Returns the optional constraint synopsis of this aggregation property definition in the specified locale, or null if there is no constraint synopsis.

      • getTargetIsEnabledCondition

        public final Condition getTargetIsEnabledCondition()
        Gets the condition which is used to determine if a referenced managed object is enabled.
        Returns:
        Returns the condition which is used to determine if a referenced managed object is enabled.

      • getTargetNeedsEnablingCondition

        public final Condition getTargetNeedsEnablingCondition()
        Gets the condition which is used to determine whether referenced managed objects need to be enabled.
        Returns:
        Returns the condition which is used to determine whether referenced managed objects need to be enabled.

      • normalizeValue

        public String normalizeValue​(String value)
        Description copied from class: PropertyDefinition
        Get a normalized string representation of a property value. This can then be used for comparisons and for generating hash-codes.

        This method may throw an exception if the provided value is invalid. However, applications should not assume that implementations of this method will always validate a value. This task is the responsibility of PropertyDefinition.validateValue(Object).

        This default implementation simply returns the string representation of the provided value. Sub-classes might want to override this method if this behavior is insufficient (for example, a string property definition might strip white-space and convert characters to lower-case).

        Overrides:
        normalizeValue in class PropertyDefinition<String>
        Parameters:
        value - The property value to be normalized.
        Returns:
        Returns the normalized property value.

      • toString

        public void toString​(StringBuilder builder)
        Description copied from class: PropertyDefinition
        Append a string representation of the property definition to the provided string builder.

        This simple implementation just outputs the propertyName of the property definition. Sub-classes should override this method to provide more complete string representations.

        Overrides:
        toString in class PropertyDefinition<String>
        Parameters:
        builder - The string builder where the string representation should be appended.

      • validateValue

        public void validateValue​(String value)
        Description copied from class: PropertyDefinition
        Determine if the provided property value is valid according to this property definition.
        Specified by:
        validateValue in class PropertyDefinition<String>
        Parameters:
        value - The property value (must not be null).

      • initialize

        public void initialize()
                throws Exception
        Performs any run-time initialization required by this property definition. This may include resolving managed object paths and property names.
        Overrides:
        initialize in class PropertyDefinition<String>
        Throws:
        Exception - If this property definition could not be initialized.