T
- The type of client configuration represented by the client managed
object.public interface ManagedObject<T extends ConfigurationClient> extends PropertyProvider
A managed object comprises of zero or more properties. A property has associated with it three sets of property value(s). These are:
commit()
method,
the pending values can be empty indicating that the property should be
modified back to its default values.
Modifier and Type | Method and Description |
---|---|
void |
commit()
Adds this managed object to the server or commits any changes made to it
depending on whether the managed object already exists on the
server.
|
<C extends ConfigurationClient,S extends Configuration,C1 extends C> |
createChild(InstantiableRelationDefinition<C,S> r,
ManagedObjectDefinition<C1,? extends S> d,
String name,
Collection<PropertyException> exceptions)
Creates a new child managed object bound to the specified instantiable
relation.
|
<C extends ConfigurationClient,S extends Configuration,C1 extends C> |
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.
|
<C extends ConfigurationClient,S extends Configuration,C1 extends C> |
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.
|
<C extends ConfigurationClient,S extends Configuration> |
getChild(InstantiableRelationDefinition<C,S> r,
String name)
Retrieves an instantiable child managed object.
|
<C extends ConfigurationClient,S extends Configuration> |
getChild(OptionalRelationDefinition<C,S> r)
Retrieves an optional child managed object.
|
<C extends ConfigurationClient,S extends Configuration> |
getChild(SetRelationDefinition<C,S> r,
String name)
Retrieves a set child managed object.
|
<C extends ConfigurationClient,S extends Configuration> |
getChild(SingletonRelationDefinition<C,S> r)
Retrieves a singleton child managed object.
|
T |
getConfiguration()
Creates a client configuration view of this managed object.
|
ManagedObjectDefinition<T,? extends Configuration> |
getManagedObjectDefinition()
Gets the definition associated with this managed object.
|
ManagedObjectPath<T,? extends Configuration> |
getManagedObjectPath()
Gets the path of this managed object.
|
<P> SortedSet<ValueOrExpression<P>> |
getPropertyDefaultValues(PropertyDefinition<P> pd)
Gets a mutable copy of the set of default values for the specified
property.
|
<P> ValueOrExpression<P> |
getPropertyValue(PropertyDefinition<P> pd)
Gets the effective value of the specified property.
|
<P> SortedSet<ValueOrExpression<P>> |
getPropertyValues(PropertyDefinition<P> pd)
Gets a mutable copy of the set of effective values for the specified
property.
|
<C extends ConfigurationClient,S extends Configuration> |
hasChild(OptionalRelationDefinition<C,S> r)
Determines whether the optional managed object associated with the
specified optional relations exists.
|
boolean |
isModified()
Determines whether this managed object has been modified since it
was constructed.
|
boolean |
isModified(PropertyDefinition<?> pd)
Determines whether the provided property has been modified since this managed object was constructed.
|
boolean |
isPropertyPresent(PropertyDefinition<?> pd)
Determines whether the specified property is set.
|
<C extends ConfigurationClient,S extends Configuration> |
listChildren(InstantiableRelationDefinition<C,S> r)
Lists the child managed objects associated with the specified
instantiable relation.
|
<C extends ConfigurationClient,S extends Configuration> |
listChildren(InstantiableRelationDefinition<C,S> r,
AbstractManagedObjectDefinition<? extends C,? extends S> d)
Lists the child managed objects associated with the specified
instantiable relation which are a sub-type of the specified managed
object definition.
|
<C extends ConfigurationClient,S extends Configuration> |
listChildren(SetRelationDefinition<C,S> r)
Lists the child managed objects associated with the specified set
relation.
|
<C extends ConfigurationClient,S extends Configuration> |
listChildren(SetRelationDefinition<C,S> r,
AbstractManagedObjectDefinition<? extends C,? extends S> d)
Lists the child managed objects associated with the specified set
relation which are a sub-type of the specified managed object definition.
|
<C extends ConfigurationClient,S extends Configuration> |
removeChild(InstantiableRelationDefinition<C,S> r,
String name)
Removes the named instantiable child managed object.
|
<C extends ConfigurationClient,S extends Configuration> |
removeChild(OptionalRelationDefinition<C,S> r)
Removes an optional child managed object.
|
<C extends ConfigurationClient,S extends Configuration> |
removeChild(SetRelationDefinition<C,S> r,
String name)
Removes s set child managed object.
|
<P> void |
setPropertyValue(PropertyDefinition<P> pd,
ValueOrExpression<P> value)
Sets a new pending value for the specified property.
|
<P> void |
setPropertyValues(PropertyDefinition<P> pd,
Collection<ValueOrExpression<P>> values)
Sets a new pending values for the specified property.
|
void commit() throws ManagedObjectAlreadyExistsException, MissingMandatoryPropertiesException, ConcurrentModificationException, OperationRejectedException, LdapException
See the class description for more information regarding pending and active values.
ManagedObjectAlreadyExistsException
- If the managed object cannot be added to the server because
it already exists.MissingMandatoryPropertiesException
- If the managed object contains some mandatory properties
which have been left undefined.ConcurrentModificationException
- If the managed object is being added to the server but its
parent has been removed by another client, or if this managed
object is being modified but it has been removed from the
server by another client.OperationRejectedException
- If this managed object cannot be added or modified due to
some client-side or server-side constraint which cannot be
satisfied.LdapException
- If any other error occurs.boolean isModified()
true
if this managed object has been
modified since it was constructed.boolean isModified(PropertyDefinition<?> pd)
pd
- The property definition.true
if the provided property has been modified since this managed object was
constructed.<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
commit()
method.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.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
PropertyException
s that occurred whilst
attempting to determine the managed object's default values.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.<C extends ConfigurationClient,S extends Configuration,C1 extends C> ManagedObject<C1> createChild(OptionalRelationDefinition<C,S> r, ManagedObjectDefinition<C1,? extends S> d, Collection<PropertyException> exceptions)
commit()
method.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.r
- The optional relation definition.d
- The definition of the managed object to be created.exceptions
- A collection in which to place any
PropertyException
s that occurred whilst
attempting to determine the managed object's default values.IllegalArgumentException
- If the relation definition is not associated with this
managed object's definition.<C extends ConfigurationClient,S extends Configuration,C1 extends C> ManagedObject<C1> createChild(SetRelationDefinition<C,S> r, ManagedObjectDefinition<C1,? extends S> d, Collection<PropertyException> exceptions)
commit()
method.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.r
- The set relation definition.d
- The definition of the managed object to be created.exceptions
- A collection in which to place any
PropertyException
s that occurred whilst
attempting to determine the managed object's default values.IllegalArgumentException
- If the relation definition is not associated with this
managed object's definition.<C extends ConfigurationClient,S extends Configuration> ManagedObject<? extends C> getChild(InstantiableRelationDefinition<C,S> r, String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
C
- The requested type of the child managed object configuration
client.S
- The type of server managed object configuration that the
relation definition refers to.r
- The instantiable relation definition.name
- The name of the child managed object.IllegalArgumentException
- If the relation definition is not associated with this
managed object's definition.DefinitionDecodingException
- If the managed object was found but its type could not be
determined.ManagedObjectDecodingException
- If the managed object was found but one or more of its
properties could not be decoded.ManagedObjectNotFoundException
- If the requested managed object could not be found on the
server.ConcurrentModificationException
- If this managed object has been removed from the server by
another client.LdapException
- If any other error occurs.<C extends ConfigurationClient,S extends Configuration> ManagedObject<? extends C> getChild(OptionalRelationDefinition<C,S> r) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
C
- The requested type of the child managed object configuration
client.S
- The type of server managed object configuration that the
relation definition refers to.r
- The optional relation definition.IllegalArgumentException
- If the relation definition is not associated with this
managed object's definition.DefinitionDecodingException
- If the managed object was found but its type could not be
determined.ManagedObjectDecodingException
- If the managed object was found but one or more of its
properties could not be decoded.ManagedObjectNotFoundException
- If the requested managed object could not be found on the
server.ConcurrentModificationException
- If this managed object has been removed from the server by
another client.LdapException
- If any other error occurs.<C extends ConfigurationClient,S extends Configuration> ManagedObject<? extends C> getChild(SingletonRelationDefinition<C,S> r) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
C
- The requested type of the child managed object configuration
client.S
- The type of server managed object configuration that the
relation definition refers to.r
- The singleton relation definition.IllegalArgumentException
- If the relation definition is not associated with this
managed object's definition.DefinitionDecodingException
- If the managed object was found but its type could not be
determined.ManagedObjectDecodingException
- If the managed object was found but one or more of its
properties could not be decoded.ManagedObjectNotFoundException
- If the requested managed object could not be found on the
server.ConcurrentModificationException
- If this managed object has been removed from the server by
another client.LdapException
- If any other error occurs.<C extends ConfigurationClient,S extends Configuration> ManagedObject<? extends C> getChild(SetRelationDefinition<C,S> r, String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
C
- The requested type of the child managed object configuration
client.S
- The type of server managed object configuration that the
relation definition refers to.r
- The set relation definition.name
- The name of the child managed object.IllegalArgumentException
- If the relation definition is not associated with this
managed object's definition.DefinitionDecodingException
- If the managed object was found but its type could not be
determined.ManagedObjectDecodingException
- If the managed object was found but one or more of its
properties could not be decoded.ManagedObjectNotFoundException
- If the requested managed object could not be found on the
server.ConcurrentModificationException
- If this managed object has been removed from the server by
another client.LdapException
- If any other error occurs.T getConfiguration()
ManagedObjectDefinition<T,? extends Configuration> getManagedObjectDefinition()
ManagedObjectPath<T,? extends Configuration> getManagedObjectPath()
<P> SortedSet<ValueOrExpression<P>> getPropertyDefaultValues(PropertyDefinition<P> pd)
P
- The type of the property to be retrieved.pd
- The property to be retrieved.IllegalArgumentException
- If the property definition is not associated with this
managed object's definition.<P> ValueOrExpression<P> getPropertyValue(PropertyDefinition<P> pd)
See the class description for more information about how the effective property value is derived.
P
- The type of the property to be retrieved.pd
- The property to be retrieved.null
if
there is no effective value defined.IllegalArgumentException
- If the property definition is not associated with this
managed object's definition.<P> SortedSet<ValueOrExpression<P>> getPropertyValues(PropertyDefinition<P> pd)
See the class description for more information about how the effective property values are derived.
getPropertyValues
in interface PropertyProvider
P
- The type of the property to be retrieved.pd
- The property to be retrieved.IllegalArgumentException
- If the property definition is not associated with this
managed object's definition.boolean isPropertyPresent(PropertyDefinition<?> pd)
pd
- The property definition.true
if the property has been set, or
false
if it is unset and any default behavior
associated with the property applies.IllegalArgumentException
- If the property definition is not associated with this
managed object's definition.<C extends ConfigurationClient,S extends Configuration> boolean hasChild(OptionalRelationDefinition<C,S> r) throws ConcurrentModificationException, LdapException
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.r
- The optional relation definition.true
if the optional managed object exists,
false
otherwise.ConcurrentModificationException
- If this managed object has been removed from the server by
another client.LdapException
- If there is any other error.<C extends ConfigurationClient,S extends Configuration> String[] listChildren(InstantiableRelationDefinition<C,S> r) throws ConcurrentModificationException, LdapException
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.r
- The instantiable relation definition.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.<C extends ConfigurationClient,S extends Configuration> String[] listChildren(InstantiableRelationDefinition<C,S> r, AbstractManagedObjectDefinition<? extends C,? extends S> d) throws ConcurrentModificationException, LdapException
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.r
- The instantiable relation definition.d
- The managed object definition.ConcurrentModificationException
- If this managed object has been removed from the server by
another client.LdapException
- If any other error occurs.<C extends ConfigurationClient,S extends Configuration> String[] listChildren(SetRelationDefinition<C,S> r) throws ConcurrentModificationException, LdapException
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.r
- The set relation definition.ConcurrentModificationException
- If this managed object has been removed from the server by
another client.LdapException
- If any other error occurs.<C extends ConfigurationClient,S extends Configuration> String[] listChildren(SetRelationDefinition<C,S> r, AbstractManagedObjectDefinition<? extends C,? extends S> d) throws ConcurrentModificationException, LdapException
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.r
- The set relation definition.d
- The managed object definition.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.<C extends ConfigurationClient,S extends Configuration> void removeChild(InstantiableRelationDefinition<C,S> r, String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
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.r
- The instantiable relation definition.name
- The name of the child managed object to be removed.IllegalArgumentException
- If the relation definition is not associated with this
managed object's definition.ManagedObjectNotFoundException
- If the managed object could not be removed because it could
not found on the server.OperationRejectedException
- If the managed object cannot be removed due to some
client-side or server-side constraint which cannot be
satisfied (for example, if it is referenced by another
managed object).ConcurrentModificationException
- If this managed object has been removed from the server by
another client.LdapException
- If any other error occurs.<C extends ConfigurationClient,S extends Configuration> void removeChild(OptionalRelationDefinition<C,S> r) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
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.r
- The optional relation definition.ManagedObjectNotFoundException
- If the managed object could not be removed because it could
not found on the server.OperationRejectedException
- If the managed object cannot be removed due to some
client-side or server-side constraint which cannot be
satisfied (for example, if it is referenced by another
managed object).ConcurrentModificationException
- If this managed object has been removed from the server by
another client.LdapException
- If any other error occurs.<C extends ConfigurationClient,S extends Configuration> void removeChild(SetRelationDefinition<C,S> r, String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
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.r
- The set relation definition.name
- The name of the child managed object to be removed.ManagedObjectNotFoundException
- If the managed object could not be removed because it could
not found on the server.OperationRejectedException
- If the managed object cannot be removed due to some
client-side or server-side constraint which cannot be
satisfied (for example, if it is referenced by another
managed object).ConcurrentModificationException
- If this managed object has been removed from the server by
another client.LdapException
- If any other error occurs.<P> void setPropertyValue(PropertyDefinition<P> pd, ValueOrExpression<P> value)
See the class description for more information regarding pending values.
P
- The type of the property to be modified.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.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.<P> void setPropertyValues(PropertyDefinition<P> pd, Collection<ValueOrExpression<P>> values)
See the class description for more information regarding pending values.
P
- The type of the property to be modified.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.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.Copyright 2010-2022 ForgeRock AS.