|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.admin.client.ManagementContext
public abstract class ManagementContext
Client management connection context.
Constructor Summary | |
---|---|
protected |
ManagementContext()
Creates a new management context. |
Method Summary | ||
---|---|---|
void |
close()
Closes this management context. |
|
|
deleteManagedObject(ManagedObjectPath<?,?> parent,
InstantiableRelationDefinition<C,S> rd,
java.lang.String name)
Deletes the named instantiable child managed object from the named parent managed object. |
|
|
deleteManagedObject(ManagedObjectPath<?,?> parent,
OptionalRelationDefinition<C,S> rd)
Deletes the optional child managed object from the named parent managed object. |
|
protected abstract Driver |
getDriver()
Gets the driver associated with this management context. |
|
|
getManagedObject(ManagedObjectPath<C,S> path)
Gets the named managed object. |
|
|
getPropertyValue(ManagedObjectPath<?,?> path,
PropertyDefinition<PD> pd)
Gets the effective value of a property in the named managed object. |
|
|
getPropertyValues(ManagedObjectPath<?,?> path,
PropertyDefinition<PD> 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. |
|
|
listManagedObjects(ManagedObjectPath<?,?> parent,
InstantiableRelationDefinition<C,S> rd)
Lists the child managed objects of the named parent managed object. |
|
|
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. |
|
boolean |
managedObjectExists(ManagedObjectPath<?,?> path)
Determines whether or not 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 |
---|
protected ManagementContext()
Method Detail |
---|
public final <C extends ConfigurationClient,S extends Configuration> boolean deleteManagedObject(ManagedObjectPath<?,?> parent, InstantiableRelationDefinition<C,S> rd, java.lang.String name) throws java.lang.IllegalArgumentException, ManagedObjectNotFoundException, OperationRejectedException, AuthorizationException, CommunicationException
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.
java.lang.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.public final <C extends ConfigurationClient,S extends Configuration> boolean deleteManagedObject(ManagedObjectPath<?,?> parent, OptionalRelationDefinition<C,S> rd) throws java.lang.IllegalArgumentException, ManagedObjectNotFoundException, OperationRejectedException, AuthorizationException, CommunicationException
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.
java.lang.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.public final <C extends ConfigurationClient,S extends Configuration> ManagedObject<? extends C> getManagedObject(ManagedObjectPath<C,S> path) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, AuthorizationException, CommunicationException
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.
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.public final <PD> PD getPropertyValue(ManagedObjectPath<?,?> path, PropertyDefinition<PD> pd) throws java.lang.IllegalArgumentException, DefinitionDecodingException, AuthorizationException, ManagedObjectNotFoundException, CommunicationException, PropertyException
PD
- 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.
java.lang.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.public final <PD> java.util.SortedSet<PD> getPropertyValues(ManagedObjectPath<?,?> path, PropertyDefinition<PD> pd) throws java.lang.IllegalArgumentException, DefinitionDecodingException, AuthorizationException, ManagedObjectNotFoundException, CommunicationException, PropertyException
PD
- The type of the property to be retrieved.path
- The path of the managed object containing the property.pd
- The property to be retrieved.
java.lang.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.public final RootCfgClient getRootConfiguration()
public final ManagedObject<RootCfgClient> getRootConfigurationManagedObject()
public final <C extends ConfigurationClient,S extends Configuration> java.lang.String[] listManagedObjects(ManagedObjectPath<?,?> parent, InstantiableRelationDefinition<C,S> rd) throws java.lang.IllegalArgumentException, ManagedObjectNotFoundException, AuthorizationException, CommunicationException
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.
java.lang.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.public final <C extends ConfigurationClient,S extends Configuration> java.lang.String[] listManagedObjects(ManagedObjectPath<?,?> parent, InstantiableRelationDefinition<C,S> rd, AbstractManagedObjectDefinition<? extends C,? extends S> d) throws java.lang.IllegalArgumentException, ManagedObjectNotFoundException, AuthorizationException, CommunicationException
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.
java.lang.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.public final boolean managedObjectExists(ManagedObjectPath<?,?> path) throws ManagedObjectNotFoundException, AuthorizationException, CommunicationException
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.
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.protected abstract Driver getDriver()
public final void close()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |