Package org.forgerock.opendj.config.client

Class DriverBasedManagementContext

java.lang.Object

org.forgerock.opendj.config.client.DriverBasedManagementContext

All Implemented Interfaces:

Closeable, AutoCloseable, ManagementContext

Direct Known Subclasses:

LDAPManagementContext

public abstract class DriverBasedManagementContext
extends Object
implements ManagementContext

Driver based client management connection context.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DriverBasedManagementContext()	Creates a new management context.

Method Summary

Modifier and Type	Method	Description
void	close()
<C extends ConfigurationClient,S extends Configuration> boolean	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> boolean	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> boolean	deleteManagedObject(ManagedObjectPath<?,?> parent, SetRelationDefinition<C,S> rd, String name)	Deletes s set child managed object from the named parent managed object.
protected abstract Driver	getDriver()	Gets the driver associated with this management context.
<C extends ConfigurationClient,S extends Configuration> ManagedObject<? extends C>	getManagedObject(ManagedObjectPath<C,S> path)	Gets the named managed object.
<P> P	getPropertyValue(ManagedObjectPath<?,?> path, PropertyDefinition<P> pd)	Gets the effective value of a property in the named managed object.
<P> SortedSet<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> String[]	listManagedObjects(ManagedObjectPath<?,?> parent, InstantiableRelationDefinition<C,S> rd)	Lists the child managed objects of the named parent managed object.
<C extends ConfigurationClient,S extends Configuration> String[]	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> String[]	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DriverBasedManagementContext

protected DriverBasedManagementContext()

Creates a new management context.

Method Detail

deleteManagedObject

public final <C extends ConfigurationClient,S extends Configuration> boolean deleteManagedObject(ManagedObjectPath<?,?> parent,
                                                                                                       InstantiableRelationDefinition<C,S> rd,
                                                                                                       String name)
                                                                                                throws ManagedObjectNotFoundException,
                                                                                                       OperationRejectedException,
                                                                                                       org.forgerock.opendj.ldap.LdapException

Description copied from interface: ManagementContext

Deletes the named instantiable child managed object from the named parent managed object.

Specified by:

deleteManagedObject in interface ManagementContext

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:

parent - The path of the parent managed object.

rd - The instantiable relation definition.

name - The name of the child managed object to be removed.

Returns:

Returns true if the named instantiable child managed object was found, or false if it was not found.

Throws:

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).

org.forgerock.opendj.ldap.LdapException - If any other error occurs.

deleteManagedObject

public final <C extends ConfigurationClient,S extends Configuration> boolean deleteManagedObject(ManagedObjectPath<?,?> parent,
                                                                                                       OptionalRelationDefinition<C,S> rd)
                                                                                                throws ManagedObjectNotFoundException,
                                                                                                       OperationRejectedException,
                                                                                                       org.forgerock.opendj.ldap.LdapException

Description copied from interface: ManagementContext

Deletes the optional child managed object from the named parent managed object.

Specified by:

deleteManagedObject in interface ManagementContext

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:

parent - The path of the parent managed object.

rd - The optional relation definition.

Returns:

Returns true if the optional child managed object was found, or false if it was not found.

Throws:

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).

org.forgerock.opendj.ldap.LdapException - If any other error occurs.

deleteManagedObject

public final <C extends ConfigurationClient,S extends Configuration> boolean deleteManagedObject(ManagedObjectPath<?,?> parent,
                                                                                                       SetRelationDefinition<C,S> rd,
                                                                                                       String name)
                                                                                                throws ManagedObjectNotFoundException,
                                                                                                       OperationRejectedException,
                                                                                                       org.forgerock.opendj.ldap.LdapException

Description copied from interface: ManagementContext

Deletes s set child managed object from the named parent managed object.

Specified by:

deleteManagedObject in interface ManagementContext

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:

parent - The path of the parent managed object.

rd - The set relation definition.

name - The name of the child managed object to be removed.

Returns:

Returns true if the set child managed object was found, or false if it was not found.

Throws:

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).

org.forgerock.opendj.ldap.LdapException - If any other error occurs.

getManagedObject

public final <C extends ConfigurationClient,S extends Configuration> ManagedObject<? extends C> getManagedObject(ManagedObjectPath<C,S> path)
                                                                                                                throws DefinitionDecodingException,
                                                                                                                       ManagedObjectDecodingException,
                                                                                                                       ManagedObjectNotFoundException,
                                                                                                                       org.forgerock.opendj.ldap.LdapException

Description copied from interface: ManagementContext

Gets the named managed object.

Specified by:

getManagedObject in interface ManagementContext

Type Parameters:

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.

Parameters:

path - The path of the managed object.

Returns:

Returns the named managed object.

Throws:

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.

org.forgerock.opendj.ldap.LdapException - If any other error occurs.

getPropertyValue

public final <P> P getPropertyValue(ManagedObjectPath<?,?> path,
                                    PropertyDefinition<P> pd)
                             throws DefinitionDecodingException,
                                    org.forgerock.opendj.ldap.LdapException,
                                    ManagedObjectNotFoundException

Description copied from interface: ManagementContext

Gets the effective value of a property in the named managed object.

Specified by:

getPropertyValue in interface ManagementContext

Type Parameters:

P - The type of the property to be retrieved.

Parameters:

path - The path of the managed object containing the property.

pd - The property to be retrieved.

Returns:

Returns the property's effective value, or null if there are no values defined.

Throws:

DefinitionDecodingException - If the managed object was found but its type could not be determined.

org.forgerock.opendj.ldap.LdapException - If any other error occurs.

ManagedObjectNotFoundException - If the requested managed object could not be found on the server.

getPropertyValues

public final <P> SortedSet<P> getPropertyValues(ManagedObjectPath<?,?> path,
                                                PropertyDefinition<P> pd)
                                         throws DefinitionDecodingException,
                                                org.forgerock.opendj.ldap.LdapException,
                                                ManagedObjectNotFoundException

Description copied from interface: ManagementContext

Gets the effective values of a property in the named managed object.

Specified by:

getPropertyValues in interface ManagementContext

Type Parameters:

P - The type of the property to be retrieved.

Parameters:

path - The path of the managed object containing the property.

pd - The property to be retrieved.

Returns:

Returns the property's effective values, or an empty set if there are no values defined.

Throws:

DefinitionDecodingException - If the managed object was found but its type could not be determined.

org.forgerock.opendj.ldap.LdapException - If any other error occurs.

ManagedObjectNotFoundException - If the requested managed object could not be found on the server.

getRootConfiguration

public final RootCfgClient getRootConfiguration()

Description copied from interface: ManagementContext

Gets the root configuration client associated with this management context.

Specified by:

getRootConfiguration in interface ManagementContext

Returns:

Returns the root configuration client associated with this management context.

getRootConfigurationManagedObject

public final ManagedObject<RootCfgClient> getRootConfigurationManagedObject()

Description copied from interface: ManagementContext

Gets the root configuration managed object associated with this management context.

Specified by:

getRootConfigurationManagedObject in interface ManagementContext

Returns:

Returns the root configuration managed object associated with this management context.

listManagedObjects

public final <C extends ConfigurationClient,S extends Configuration> String[] listManagedObjects(ManagedObjectPath<?,?> parent,
                                                                                                       InstantiableRelationDefinition<C,S> rd)
                                                                                                throws ManagedObjectNotFoundException,
                                                                                                       org.forgerock.opendj.ldap.LdapException

Description copied from interface: ManagementContext

Lists the child managed objects of the named parent managed object.

Specified by:

listManagedObjects in interface ManagementContext

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:

parent - The path of the parent managed object.

rd - The instantiable relation definition.

Returns:

Returns the names of the child managed objects.

Throws:

ManagedObjectNotFoundException - If the parent managed object could not be found.

org.forgerock.opendj.ldap.LdapException - If any other error occurs.

listManagedObjects

public final <C extends ConfigurationClient,S extends Configuration> String[] listManagedObjects(ManagedObjectPath<?,?> parent,
                                                                                                       InstantiableRelationDefinition<C,S> rd,
                                                                                                       AbstractManagedObjectDefinition<? extends C,? extends S> d)
                                                                                                throws ManagedObjectNotFoundException,
                                                                                                       org.forgerock.opendj.ldap.LdapException

Description copied from interface: ManagementContext

Lists the child managed objects of the named parent managed object which are a sub-type of the specified managed object definition.

Specified by:

listManagedObjects in interface ManagementContext

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:

parent - The path of the parent managed object.

rd - 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:

ManagedObjectNotFoundException - If the parent managed object could not be found.

org.forgerock.opendj.ldap.LdapException - If any other error occurs.

listManagedObjects

public final <C extends ConfigurationClient,S extends Configuration> String[] listManagedObjects(ManagedObjectPath<?,?> parent,
                                                                                                       SetRelationDefinition<C,S> rd)
                                                                                                throws ManagedObjectNotFoundException,
                                                                                                       org.forgerock.opendj.ldap.LdapException

Description copied from interface: ManagementContext

Lists the child managed objects of the named parent managed object.

Specified by:

listManagedObjects in interface ManagementContext

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:

parent - The path of the parent managed object.

rd - The set relation definition.

Returns:

Returns the names of the child managed objects.

Throws:

ManagedObjectNotFoundException - If the parent managed object could not be found.

org.forgerock.opendj.ldap.LdapException - If any other error occurs.

managedObjectExists

public final boolean managedObjectExists(ManagedObjectPath<?,?> path)
                                  throws ManagedObjectNotFoundException,
                                         org.forgerock.opendj.ldap.LdapException

Description copied from interface: ManagementContext

Determines whether the named managed object exists.

Specified by:

managedObjectExists in interface ManagementContext

Parameters:

path - The path of the named managed object.

Returns:

Returns true if the named managed object exists, false otherwise.

Throws:

ManagedObjectNotFoundException - If the parent managed object could not be found.

org.forgerock.opendj.ldap.LdapException - If any other error occurs.

getDriver

protected abstract Driver getDriver()

Gets the driver associated with this management context.

Returns:

Returns the driver associated with this management context.

close

public final void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable