org.opends.server.admin.client.spi

Class Driver

java.lang.Object

org.opends.server.admin.client.spi.Driver

public abstract class Driver
extends Object

An abstract management connection context driver which should form the basis of driver implementations.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Driver() Creates a new abstract management context.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes any context associated with this management context driver.
<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 the named instantiable child managed object from the named parent managed object.
protected abstract <C extends ConfigurationClient,S extends Configuration> void	deleteManagedObject(ManagedObjectPath<C,S> path) Deletes the named managed object.
protected <PD> Collection<PD>	findDefaultValues(ManagedObjectPath<?,?> p, PropertyDefinition<PD> pd, boolean isCreate) Gets the default values for the specified property.
abstract <C extends ConfigurationClient,S extends Configuration> ManagedObject<? extends C>	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,PD> SortedSet<PD>	getPropertyValues(ManagedObjectPath<C,S> path, PropertyDefinition<PD> 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> 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.
abstract <C extends ConfigurationClient,S extends Configuration> String[]	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 or not 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

Driver

protected Driver()

Creates a new abstract management context.

Method Detail

close

public void close()

Closes any context associated with this management context driver.

deleteManagedObject

public final <C extends ConfigurationClient,S extends Configuration> boolean deleteManagedObject(ManagedObjectPath<?,?> parent,
                                                                                  InstantiableRelationDefinition<C,S> rd,
                                                                                  String name)
                                  throws IllegalArgumentException,
                                         ManagedObjectNotFoundException,
                                         OperationRejectedException,
                                         AuthorizationException,
                                         CommunicationException

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

AuthorizationException - If the server refuses to remove the managed objects because the client does not have the correct privileges.

CommunicationException - If the client cannot contact the server due to an underlying communication problem.

deleteManagedObject

public final <C extends ConfigurationClient,S extends Configuration> boolean deleteManagedObject(ManagedObjectPath<?,?> parent,
                                                                                  OptionalRelationDefinition<C,S> rd)
                                  throws IllegalArgumentException,
                                         ManagedObjectNotFoundException,
                                         OperationRejectedException,
                                         AuthorizationException,
                                         CommunicationException

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

AuthorizationException - If the server refuses to remove the managed objects because the client does not have the correct privileges.

CommunicationException - If the client cannot contact the server due to an underlying communication problem.

deleteManagedObject

public final <C extends ConfigurationClient,S extends Configuration> boolean deleteManagedObject(ManagedObjectPath<?,?> parent,
                                                                                  SetRelationDefinition<C,S> rd,
                                                                                  String name)
                                  throws IllegalArgumentException,
                                         ManagedObjectNotFoundException,
                                         OperationRejectedException,
                                         AuthorizationException,
                                         CommunicationException

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

AuthorizationException - If the server refuses to remove the managed objects because the client does not have the correct privileges.

CommunicationException - If the client cannot contact the server due to an underlying communication problem.

getManagedObject

public abstract <C extends ConfigurationClient,S extends Configuration> ManagedObject<? extends C> getManagedObject(ManagedObjectPath<C,S> path)
                                                                                 throws DefinitionDecodingException,
                                                                                        ManagedObjectDecodingException,
                                                                                        ManagedObjectNotFoundException,
                                                                                        AuthorizationException,
                                                                                        CommunicationException

Gets the named managed object. The path is guaranteed to be non-empty, so implementations do not need to worry about handling this special case.

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 non-empty 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.

AuthorizationException - If the server refuses to retrieve the managed object because the client does not have the correct privileges.

CommunicationException - If the client cannot contact the server due to an underlying communication problem.

getPropertyValues

public abstract <C extends ConfigurationClient,S extends Configuration,PD> SortedSet<PD> getPropertyValues(ManagedObjectPath<C,S> path,
                                                                                         PropertyDefinition<PD> pd)
                                         throws IllegalArgumentException,
                                                DefinitionDecodingException,
                                                AuthorizationException,
                                                ManagedObjectNotFoundException,
                                                CommunicationException,
                                                PropertyException

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

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.

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.

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

AuthorizationException - If the server refuses to retrieve the managed object because the client does not have the correct privileges.

CommunicationException - If the client cannot contact the server due to an underlying communication problem.

getRootConfigurationManagedObject

public abstract ManagedObject<RootCfgClient> getRootConfigurationManagedObject()

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

Returns:

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

listManagedObjects

public abstract <C extends ConfigurationClient,S extends Configuration> String[] listManagedObjects(ManagedObjectPath<?,?> parent,
                                                                                  InstantiableRelationDefinition<C,S> rd,
                                                                                  AbstractManagedObjectDefinition<? extends C,? extends S> d)
                                     throws IllegalArgumentException,
                                            ManagedObjectNotFoundException,
                                            AuthorizationException,
                                            CommunicationException

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.

AuthorizationException - If the server refuses to list the managed objects because the client does not have the correct privileges.

CommunicationException - If the client cannot contact the server due to an underlying communication problem.

listManagedObjects

public abstract <C extends ConfigurationClient,S extends Configuration> String[] listManagedObjects(ManagedObjectPath<?,?> parent,
                                                                                  SetRelationDefinition<C,S> rd,
                                                                                  AbstractManagedObjectDefinition<? extends C,? extends S> d)
                                     throws IllegalArgumentException,
                                            ManagedObjectNotFoundException,
                                            AuthorizationException,
                                            CommunicationException

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

AuthorizationException - If the server refuses to list the managed objects because the client does not have the correct privileges.

CommunicationException - If the client cannot contact the server due to an underlying communication problem.

managedObjectExists

public abstract boolean managedObjectExists(ManagedObjectPath<?,?> path)
                                     throws ManagedObjectNotFoundException,
                                            AuthorizationException,
                                            CommunicationException

Determines whether or not the named managed object exists.

Implementations should always return true when the provided path is empty.

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.

AuthorizationException - If the server refuses to make the determination because the client does not have the correct privileges.

CommunicationException - If the client cannot contact the server due to an underlying communication problem.

deleteManagedObject

protected abstract <C extends ConfigurationClient,S extends Configuration> void deleteManagedObject(ManagedObjectPath<C,S> path)
                                     throws OperationRejectedException,
                                            AuthorizationException,
                                            CommunicationException

Deletes the named managed object.

Implementations do not need check whether the named managed object exists, nor do they need to enforce client constraints.

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:

path - The path of the managed object to be deleted.

Throws:

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

AuthorizationException - If the server refuses to remove the managed objects because the client does not have the correct privileges.

CommunicationException - If the client cannot contact the server due to an underlying communication problem.

findDefaultValues

protected final <PD> Collection<PD> findDefaultValues(ManagedObjectPath<?,?> p,
                                    PropertyDefinition<PD> pd,
                                    boolean isCreate)
                                          throws PropertyException

Gets the default values for the specified property.

Type Parameters:

PD - The type of the property.

Parameters:

p - The managed object path of the current managed object.

pd - The property definition.

isCreate - Indicates whether the managed object has been created yet.

Returns:

Returns the default values for the specified property.

Throws:

PropertyException - If the default values could not be retrieved or decoded properly.

getManagementContext

protected abstract ManagementContext getManagementContext()

Gets the management context associated with this driver.

Returns:

Returns the management context associated with this driver.

validateRelationDefinition

protected final void validateRelationDefinition(ManagedObjectPath<?,?> path,
                              RelationDefinition<?,?> rd)
                                         throws IllegalArgumentException

Validate that a relation definition belongs to the managed object referenced by the provided path.

Parameters:

path - The parent managed object path.

rd - The relation definition.

Throws:

IllegalArgumentException - If the relation definition does not belong to the managed object definition.