Package org.forgerock.opendj.config.client

Interface ManagementContext

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

DriverBasedManagementContext, LDAPManagementContext

public interface ManagementContext
extends Closeable

Client management connection context.

Method Summary

Modifier and Type	Method	Description
<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.
<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 interface java.io.Closeable

close

Method Detail

deleteManagedObject

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

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

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:

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

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

deleteManagedObject

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

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

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:

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

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

deleteManagedObject

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

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

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:

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

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

getManagedObject

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

Gets the named managed object.

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

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

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

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:

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.

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

getPropertyValues

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

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

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:

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.

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

getRootConfiguration

RootCfgClient getRootConfiguration()

Gets the root configuration client associated with this management context.

Returns:

Returns the root configuration client associated with this management context.

getRootConfigurationManagedObject

ManagedObject<RootCfgClient> getRootConfigurationManagedObject()

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

Returns:

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

listManagedObjects

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

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

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:

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.

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

listManagedObjects

<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

Lists the child managed objects of the named parent managed object 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:

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:

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.

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

listManagedObjects

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

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

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:

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.

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

managedObjectExists

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

Determines whether the named managed object exists.

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.