public interface ManagementContext extends Closeable
Modifier and Type | Method and Description |
---|---|
<C extends ConfigurationClient,S extends Configuration> |
deleteManagedObject(ManagedObjectPath<?,?> parent,
InstantiableRelationDefinition<C,S> rd,
String name)
Deletes the named instantiable child managed object from the named parent
managed object.
|
<C extends ConfigurationClient,S extends Configuration> |
deleteManagedObject(ManagedObjectPath<?,?> parent,
OptionalRelationDefinition<C,S> rd)
Deletes the optional child managed object from the named parent managed
object.
|
<C extends ConfigurationClient,S extends Configuration> |
deleteManagedObject(ManagedObjectPath<?,?> parent,
SetRelationDefinition<C,S> rd,
String name)
Deletes s set child managed object from the named parent managed object.
|
<C extends ConfigurationClient,S extends Configuration> |
getManagedObject(ManagedObjectPath<C,S> path)
Gets the named managed object.
|
<P> ValueOrExpression<P> |
getPropertyValue(ManagedObjectPath<?,?> path,
PropertyDefinition<P> pd)
Gets the effective value of a property in the named managed object.
|
<P> SortedSet<ValueOrExpression<P>> |
getPropertyValues(ManagedObjectPath<?,?> path,
PropertyDefinition<P> pd)
Gets the effective values of a property in the named managed object.
|
RootCfgClient |
getRootConfiguration()
Gets the root configuration client associated with this management
context.
|
ManagedObject<RootCfgClient> |
getRootConfigurationManagedObject()
Gets the root configuration managed object associated with this
management context.
|
<C extends ConfigurationClient,S extends Configuration> |
listManagedObjects(ManagedObjectPath<?,?> parent,
InstantiableRelationDefinition<C,S> rd)
Lists the child managed objects of the named parent managed object.
|
<C extends ConfigurationClient,S extends Configuration> |
listManagedObjects(ManagedObjectPath<?,?> parent,
InstantiableRelationDefinition<C,S> rd,
AbstractManagedObjectDefinition<? extends C,? extends S> d)
Lists the child managed objects of the named parent managed object which
are a sub-type of the specified managed object definition.
|
<C extends ConfigurationClient,S extends Configuration> |
listManagedObjects(ManagedObjectPath<?,?> parent,
SetRelationDefinition<C,S> rd)
Lists the child managed objects of the named parent managed object.
|
boolean |
managedObjectExists(ManagedObjectPath<?,?> path)
Determines whether the named managed object exists.
|
<C extends ConfigurationClient,S extends Configuration> boolean deleteManagedObject(ManagedObjectPath<?,?> parent, InstantiableRelationDefinition<C,S> rd, String name) throws ManagedObjectNotFoundException, OperationRejectedException, 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.parent
- The path of the parent managed object.rd
- The instantiable relation definition.name
- The name of the child managed object to be removed.true
if the named instantiable child managed
object was found, or false
if it was not found.IllegalArgumentException
- If the relation definition is not associated with the parent
managed object's definition.ManagedObjectNotFoundException
- If the parent managed object could not be found.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).LdapException
- If any other error occurs.<C extends ConfigurationClient,S extends Configuration> boolean deleteManagedObject(ManagedObjectPath<?,?> parent, OptionalRelationDefinition<C,S> rd) throws ManagedObjectNotFoundException, OperationRejectedException, 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.parent
- The path of the parent managed object.rd
- The optional relation definition.true
if the optional child managed object
was found, or false
if it was not found.IllegalArgumentException
- If the relation definition is not associated with the parent
managed object's definition.ManagedObjectNotFoundException
- If the parent managed object could not be found.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).LdapException
- If any other error occurs.<C extends ConfigurationClient,S extends Configuration> boolean deleteManagedObject(ManagedObjectPath<?,?> parent, SetRelationDefinition<C,S> rd, String name) throws ManagedObjectNotFoundException, OperationRejectedException, 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.parent
- The path of the parent managed object.rd
- The set relation definition.name
- The name of the child managed object to be removed.true
if the set child managed object was
found, or false
if it was not found.IllegalArgumentException
- If the relation definition is not associated with the parent
managed object's definition.ManagedObjectNotFoundException
- If the parent managed object could not be found.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).LdapException
- If any other error occurs.<C extends ConfigurationClient,S extends Configuration> ManagedObject<? extends C> getManagedObject(ManagedObjectPath<C,S> path) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, LdapException
C
- The type of client managed object configuration that the path
definition refers to.S
- The type of server managed object configuration that the path
definition refers to.path
- The path of the managed object.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.LdapException
- If any other error occurs.<P> ValueOrExpression<P> getPropertyValue(ManagedObjectPath<?,?> path, PropertyDefinition<P> pd) throws DefinitionDecodingException, LdapException, ManagedObjectNotFoundException
P
- The type of the property to be retrieved.path
- The path of the managed object containing the property.pd
- The property to be retrieved.null
if
there are no values defined.IllegalArgumentException
- If the property definition is not associated with the
referenced managed object's definition.DefinitionDecodingException
- If the managed object was found but its type could not be
determined.PropertyException
- If the managed object was found but the requested property
could not be decoded.ManagedObjectNotFoundException
- If the requested managed object could not be found on the
server.LdapException
- If any other error occurs.<P> SortedSet<ValueOrExpression<P>> getPropertyValues(ManagedObjectPath<?,?> path, PropertyDefinition<P> pd) throws DefinitionDecodingException, LdapException, ManagedObjectNotFoundException
P
- The type of the property to be retrieved.path
- The path of the managed object containing the property.pd
- The property to be retrieved.IllegalArgumentException
- If the property definition is not associated with the
referenced managed object's definition.DefinitionDecodingException
- If the managed object was found but its type could not be
determined.PropertyException
- If the managed object was found but the requested property
could not be decoded.ManagedObjectNotFoundException
- If the requested managed object could not be found on the
server.LdapException
- If any other error occurs.RootCfgClient getRootConfiguration()
ManagedObject<RootCfgClient> getRootConfigurationManagedObject()
<C extends ConfigurationClient,S extends Configuration> String[] listManagedObjects(ManagedObjectPath<?,?> parent, InstantiableRelationDefinition<C,S> rd) throws ManagedObjectNotFoundException, 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.parent
- The path of the parent managed object.rd
- The instantiable relation definition.IllegalArgumentException
- If the relation definition is not associated with the parent
managed object's definition.ManagedObjectNotFoundException
- If the parent managed object could not be found.LdapException
- If any other error occurs.<C extends ConfigurationClient,S extends Configuration> String[] listManagedObjects(ManagedObjectPath<?,?> parent, InstantiableRelationDefinition<C,S> rd, AbstractManagedObjectDefinition<? extends C,? extends S> d) throws ManagedObjectNotFoundException, 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.parent
- The path of the parent managed object.rd
- The instantiable relation definition.d
- The managed object definition.IllegalArgumentException
- If the relation definition is not associated with the parent
managed object's definition.ManagedObjectNotFoundException
- If the parent managed object could not be found.LdapException
- If any other error occurs.<C extends ConfigurationClient,S extends Configuration> String[] listManagedObjects(ManagedObjectPath<?,?> parent, SetRelationDefinition<C,S> rd) throws ManagedObjectNotFoundException, 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.parent
- The path of the parent managed object.rd
- The set relation definition.IllegalArgumentException
- If the relation definition is not associated with the parent
managed object's definition.ManagedObjectNotFoundException
- If the parent managed object could not be found.LdapException
- If any other error occurs.boolean managedObjectExists(ManagedObjectPath<?,?> path) throws ManagedObjectNotFoundException, LdapException
path
- The path of the named managed object.true
if the named managed object exists,
false
otherwise.ManagedObjectNotFoundException
- If the parent managed object could not be found.LdapException
- If any other error occurs.Copyright 2010-2022 ForgeRock AS.