public abstract class Driver extends Object
Modifier | Constructor and Description |
---|---|
protected |
Driver()
Creates a new abstract driver.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes any context associated with this management context driver.
|
<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 the named instantiable child managed object from the named parent
managed object.
|
protected abstract <C extends ConfigurationClient,S extends Configuration> |
deleteManagedObject(ManagedObjectPath<C,S> path)
Deletes the named managed object.
|
protected <P> Collection<P> |
findDefaultValues(ManagedObjectPath<?,?> p,
PropertyDefinition<P> pd,
boolean isCreate)
Gets the default values for the specified property.
|
abstract <C extends ConfigurationClient,S extends Configuration> |
getManagedObject(ManagedObjectPath<C,S> path)
Gets the named managed object.
|
protected abstract ManagementContext |
getManagementContext()
Gets the management context associated with this driver.
|
abstract <C extends ConfigurationClient,S extends Configuration,P> |
getPropertyValues(ManagedObjectPath<C,S> path,
PropertyDefinition<P> pd)
Gets the effective values of a property in the named managed object.
|
abstract ManagedObject<RootCfgClient> |
getRootConfigurationManagedObject()
Gets the root configuration managed object associated with this
management context driver.
|
abstract <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.
|
abstract <C extends ConfigurationClient,S extends Configuration> |
listManagedObjects(ManagedObjectPath<?,?> parent,
SetRelationDefinition<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.
|
abstract boolean |
managedObjectExists(ManagedObjectPath<?,?> path)
Determines whether the named managed object exists.
|
protected void |
validateRelationDefinition(ManagedObjectPath<?,?> path,
RelationDefinition<?,?> rd)
Validate that a relation definition belongs to the managed object
referenced by the provided path.
|
public void close()
public final <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.public final <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.public final <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 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.public abstract <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 non-empty 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.public abstract <C extends ConfigurationClient,S extends Configuration,P> SortedSet<P> getPropertyValues(ManagedObjectPath<C,S> path, PropertyDefinition<P> pd) throws DefinitionDecodingException, ManagedObjectNotFoundException, LdapException
Implementations MUST NOT not use
getManagedObject(ManagedObjectPath)
to read the referenced
managed object in its entirety. Specifically, implementations MUST only
attempt to resolve the default values for the requested property and its
dependencies (if it uses inherited defaults). This is to avoid infinite
recursion where a managed object contains a property which inherits
default values from another property in the same managed object.
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.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.public abstract ManagedObject<RootCfgClient> getRootConfigurationManagedObject()
public abstract <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.public abstract <C extends ConfigurationClient,S extends Configuration> String[] listManagedObjects(ManagedObjectPath<?,?> parent, SetRelationDefinition<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 set 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.public abstract boolean managedObjectExists(ManagedObjectPath<?,?> path) throws ManagedObjectNotFoundException, LdapException
Implementations should always return true
when the provided
path is empty.
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.protected abstract <C extends ConfigurationClient,S extends Configuration> void deleteManagedObject(ManagedObjectPath<C,S> path) throws OperationRejectedException, LdapException
Implementations do not need check whether the named managed object exists, nor do they need to enforce client constraints.
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.path
- The path of the managed object to be deleted.OperationRejectedException
- If the managed object cannot be removed due to some
server-side constraint which cannot be satisfied (for
example, if it is referenced by another managed object).LdapException
- If any other error occurs.protected final <P> Collection<P> findDefaultValues(ManagedObjectPath<?,?> p, PropertyDefinition<P> pd, boolean isCreate)
P
- The type of the property.p
- The managed object path of the current managed object.pd
- The property definition.isCreate
- Indicates whether the managed object has been created yet.PropertyException
- If the default values could not be retrieved or decoded
properly.protected abstract ManagementContext getManagementContext()
protected final void validateRelationDefinition(ManagedObjectPath<?,?> path, RelationDefinition<?,?> rd)
path
- The parent managed object path.rd
- The relation definition.IllegalArgumentException
- If the relation definition does not belong to the managed
object definition.Copyright 2010-2020 ForgeRock AS.