Package org.forgerock.opendj.config.client

Interface ManagedObject<T extends ConfigurationClient>

  • Type Parameters:
    T - The type of client configuration represented by the client managed object.
    All Superinterfaces:
    PropertyProvider
    All Known Implementing Classes:
    AbstractManagedObject
    public interface ManagedObject<T extends ConfigurationClient>
extends PropertyProvider
    A generic interface for accessing client-side managed objects.

    A managed object comprises of zero or more properties. A property has associated with it three sets of property value(s). These are:

    • default value(s) - these value(s) represent the default behavior for the property when it has no active values. When a property inherits its default value(s) from elsewhere (i.e. a property in another managed object), the default value(s) represent the active value(s) of the inherited property at the time the managed object was retrieved
    • active value(s) - these value(s) represent the state of the property at the time the managed object was retrieved
    • pending value(s) - these value(s) represent any modifications made to the property's value(s) since the managed object object was retrieved and before the changes have been committed using the commit() method, the pending values can be empty indicating that the property should be modified back to its default values.
    In addition, a property has an effective state defined by its effective values which are derived by evaluating the following rules in the order presented:
    • the pending values if defined and non-empty
    • or, the default values if the pending values are defined but are empty
    • or, the active values if defined and non-empty
    • or, the default values if there are no active values
    • or, an empty set of values, if there are no default values.

    • Method Detail

      • isModified

        boolean isModified()
        Determines whether this managed object has been modified since it was constructed. In other words, whether the set of pending values differs from the set of active values.
        Returns:
        Returns true if this managed object has been modified since it was constructed.

      • isModified

        boolean isModified​(PropertyDefinition<?> pd)
        Determines whether the provided property has been modified since this managed object was constructed. In other words, whether the set of pending values differs from the set of active values for the given property.
        Parameters:
        pd - The property definition.
        Returns:
        Returns true if the provided property has been modified since this managed object was constructed.

      • createChild

        <C extends ConfigurationClient,​S extends Configuration,​C1 extends C> ManagedObject<C1> createChild​(InstantiableRelationDefinition<C,​S> r,
                                                                                                               ManagedObjectDefinition<C1,​? extends S> d,
                                                                                                               String name,
                                                                                                               Collection<PropertyException> exceptions)
                                                                                                        throws IllegalManagedObjectNameException
        Creates a new child managed object bound to the specified instantiable relation. The new managed object will initially not contain any property values (including mandatory properties). Once the managed object has been configured it can be added to the server using the commit() method.
        Type Parameters:
        C - The expected type of the child managed object configuration client.
        S - The expected type of the child managed object server configuration.
        C1 - The actual type of the added managed object configuration client.
        Parameters:
        r - The instantiable relation definition.
        d - The definition of the managed object to be created.
        name - The name of the child managed object.
        exceptions - A collection in which to place any PropertyExceptions that occurred whilst attempting to determine the managed object's default values.
        Returns:
        Returns a new child managed object bound to the specified instantiable relation.
        Throws:
        IllegalManagedObjectNameException - If the name of the child managed object is invalid.
        IllegalArgumentException - If the relation definition is not associated with this managed object's definition.

      • createChild

        <C extends ConfigurationClient,​S extends Configuration,​C1 extends C> ManagedObject<C1> createChild​(OptionalRelationDefinition<C,​S> r,
                                                                                                               ManagedObjectDefinition<C1,​? extends S> d,
                                                                                                               Collection<PropertyException> exceptions)
        Creates a new child managed object bound to the specified optional relation. The new managed object will initially not contain any property values (including mandatory properties). Once the managed object has been configured it can be added to the server using the commit() method.
        Type Parameters:
        C - The expected type of the child managed object configuration client.
        S - The expected type of the child managed object server configuration.
        C1 - The actual type of the added managed object configuration client.
        Parameters:
        r - The optional relation definition.
        d - The definition of the managed object to be created.
        exceptions - A collection in which to place any PropertyExceptions that occurred whilst attempting to determine the managed object's default values.
        Returns:
        Returns a new child managed object bound to the specified optional relation.
        Throws:
        IllegalArgumentException - If the relation definition is not associated with this managed object's definition.

      • createChild

        <C extends ConfigurationClient,​S extends Configuration,​C1 extends C> ManagedObject<C1> createChild​(SetRelationDefinition<C,​S> r,
                                                                                                               ManagedObjectDefinition<C1,​? extends S> d,
                                                                                                               Collection<PropertyException> exceptions)
        Creates a new child managed object bound to the specified set relation. The new managed object will initially not contain any property values (including mandatory properties). Once the managed object has been configured it can be added to the server using the commit() method.
        Type Parameters:
        C - The expected type of the child managed object configuration client.
        S - The expected type of the child managed object server configuration.
        C1 - The actual type of the added managed object configuration client.
        Parameters:
        r - The set relation definition.
        d - The definition of the managed object to be created.
        exceptions - A collection in which to place any PropertyExceptions that occurred whilst attempting to determine the managed object's default values.
        Returns:
        Returns a new child managed object bound to the specified set relation.
        Throws:
        IllegalArgumentException - If the relation definition is not associated with this managed object's definition.

      • getConfiguration

        T getConfiguration()
        Creates a client configuration view of this managed object. Modifications made to this managed object will be reflected in the client configuration view and vice versa.
        Returns:
        Returns a client configuration view of this managed object.

      • getManagedObjectDefinition

        ManagedObjectDefinition<T,​? extends Configuration> getManagedObjectDefinition()
        Gets the definition associated with this managed object.
        Returns:
        Returns the definition associated with this managed object.

      • getManagedObjectPath

        ManagedObjectPath<T,​? extends Configuration> getManagedObjectPath()
        Gets the path of this managed object.
        Returns:
        Returns the path of this managed object.

      • getPropertyDefaultValues

        <P> SortedSet<ValueOrExpression<P>> getPropertyDefaultValues​(PropertyDefinition<P> pd)
        Gets a mutable copy of the set of default values for the specified property.
        Type Parameters:
        P - The type of the property to be retrieved.
        Parameters:
        pd - The property to be retrieved.
        Returns:
        Returns the property's default values, or an empty set if there are no default values defined.
        Throws:
        IllegalArgumentException - If the property definition is not associated with this managed object's definition.

      • getPropertyValue

        <P> ValueOrExpression<P> getPropertyValue​(PropertyDefinition<P> pd)
        Gets the effective value of the specified property.

        See the class description for more information about how the effective property value is derived.

        Type Parameters:
        P - The type of the property to be retrieved.
        Parameters:
        pd - The property to be retrieved.
        Returns:
        Returns the property's effective value, or null if there is no effective value defined.
        Throws:
        IllegalArgumentException - If the property definition is not associated with this managed object's definition.

      • getPropertyValues

        <P> SortedSet<ValueOrExpression<P>> getPropertyValues​(PropertyDefinition<P> pd)
        Gets a mutable copy of the set of effective values for the specified property.

        See the class description for more information about how the effective property values are derived.

        Specified by:
        getPropertyValues in interface PropertyProvider
        Type Parameters:
        P - The type of the property to be retrieved.
        Parameters:
        pd - The property to be retrieved.
        Returns:
        Returns the property's effective values, or an empty set if there are no effective values defined.
        Throws:
        IllegalArgumentException - If the property definition is not associated with this managed object's definition.

      • isPropertyPresent

        boolean isPropertyPresent​(PropertyDefinition<?> pd)
        Determines whether the specified property is set. If the property is unset, then any default behavior associated with the property applies.
        Parameters:
        pd - The property definition.
        Returns:
        Returns true if the property has been set, or false if it is unset and any default behavior associated with the property applies.
        Throws:
        IllegalArgumentException - If the property definition is not associated with this managed object's definition.

      • hasChild

        <C extends ConfigurationClient,​S extends Configuration> boolean hasChild​(OptionalRelationDefinition<C,​S> r)
                                                                        throws ConcurrentModificationException,
                                                                               LdapException
        Determines whether the optional managed object associated with the specified optional relations exists.
        Type Parameters:
        C - The type of client managed object configuration that the relation definition refers to.
        S - The type of server managed object configuration that the relation definition refers to.
        Parameters:
        r - The optional relation definition.
        Returns:
        Returns true if the optional managed object exists, false otherwise.
        Throws:
        ConcurrentModificationException - If this managed object has been removed from the server by another client.
        LdapException - If there is any other error.

      • listChildren

        <C extends ConfigurationClient,​S extends Configuration> String[] listChildren​(InstantiableRelationDefinition<C,​S> r,
                                                                                    AbstractManagedObjectDefinition<? extends C,​? extends S> d)
                                                                             throws ConcurrentModificationException,
                                                                                    LdapException
        Lists the child managed objects associated with the specified instantiable relation which are a sub-type of the specified managed object definition.
        Type Parameters:
        C - The type of client managed object configuration that the relation definition refers to.
        S - The type of server managed object configuration that the relation definition refers to.
        Parameters:
        r - The instantiable relation definition.
        d - The managed object definition.
        Returns:
        Returns the names of the child managed objects which are a sub-type of the specified managed object definition.
        Throws:
        ConcurrentModificationException - If this managed object has been removed from the server by another client.
        LdapException - If any other error occurs.

      • listChildren

        <C extends ConfigurationClient,​S extends Configuration> String[] listChildren​(SetRelationDefinition<C,​S> r)
                                                                             throws ConcurrentModificationException,
                                                                                    LdapException
        Lists the child managed objects associated with the specified set relation.
        Type Parameters:
        C - The type of client managed object configuration that the relation definition refers to.
        S - The type of server managed object configuration that the relation definition refers to.
        Parameters:
        r - The set relation definition.
        Returns:
        Returns the names of the child managed objects which for set relations are the definition names of each managed object.
        Throws:
        ConcurrentModificationException - If this managed object has been removed from the server by another client.
        LdapException - If any other error occurs.

      • listChildren

        <C extends ConfigurationClient,​S extends Configuration> String[] listChildren​(SetRelationDefinition<C,​S> r,
                                                                                    AbstractManagedObjectDefinition<? extends C,​? extends S> d)
                                                                             throws ConcurrentModificationException,
                                                                                    LdapException
        Lists the child managed objects associated with the specified set relation which are a sub-type of the specified managed object definition.
        Type Parameters:
        C - The type of client managed object configuration that the relation definition refers to.
        S - The type of server managed object configuration that the relation definition refers to.
        Parameters:
        r - The set relation definition.
        d - The managed object definition.
        Returns:
        Returns the names of the child managed objects which for set relations are the definition names of each managed object.
        Throws:
        IllegalArgumentException - If the relation definition is not associated with this managed object's definition.
        ConcurrentModificationException - If this managed object has been removed from the server by another client.
        LdapException - If any other error occurs.

      • setPropertyValue

        <P> void setPropertyValue​(PropertyDefinition<P> pd,
                          ValueOrExpression<P> value)
        Sets a new pending value for the specified property.

        See the class description for more information regarding pending values.

        Type Parameters:
        P - The type of the property to be modified.
        Parameters:
        pd - The property to be modified.
        value - The new pending value for the property, or null if the property should be reset to its default behavior.
        Throws:
        PropertyException - If this is not a new managed object and the property is read-only or for monitoring purposes.
        PropertyException - If an attempt was made to remove a mandatory property.

      • setPropertyValues

        <P> void setPropertyValues​(PropertyDefinition<P> pd,
                           Collection<ValueOrExpression<P>> values)
        Sets a new pending values for the specified property.

        See the class description for more information regarding pending values.

        Type Parameters:
        P - The type of the property to be modified.
        Parameters:
        pd - The property to be modified.
        values - A non-null set of new pending values for the property (an empty set indicates that the property should be reset to its default behavior). The set will not be referenced by this managed object.
        Throws:
        PropertyException - If an attempt was made to add multiple pending values to a single-valued property.
        PropertyException - If this is not a new managed object and the property is read-only or for monitoring purposes.
        PropertyException - If an attempt was made to remove a mandatory property.