public final class ServerManagementContext extends Object
Modifier and Type | Method and Description |
---|---|
static ServerManagementContext |
getInstance()
Get the single server-side management context.
|
<C extends ConfigurationClient,S extends Configuration> |
getManagedObject(ManagedObjectPath<C,S> path)
Gets the named managed object.
|
<C extends ConfigurationClient,S extends Configuration,PD> |
getPropertyValue(ManagedObjectPath<C,S> path,
PropertyDefinition<PD> pd)
Gets the effective value of a property in the named managed
object.
|
<C extends ConfigurationClient,S extends Configuration,PD> |
getPropertyValues(ManagedObjectPath<C,S> path,
PropertyDefinition<PD> pd)
Gets the effective values of a property in the named managed
object.
|
RootCfg |
getRootConfiguration()
Get the root configuration manager associated with this
management context.
|
ServerManagedObject<RootCfg> |
getRootConfigurationManagedObject()
Get the root configuration server managed object associated with
this management context.
|
<C extends ConfigurationClient,S extends Configuration> |
listManagedObjects(ManagedObjectPath<?,?> parent,
InstantiableRelationDefinition<C,S> rd)
Lists the child managed objects of the named parent managed
object.
|
<C extends ConfigurationClient,S extends Configuration> |
listManagedObjects(ManagedObjectPath<?,?> parent,
SetRelationDefinition<C,S> rd)
Lists the child managed objects of the named parent managed
object.
|
boolean |
managedObjectExists(ManagedObjectPath<?,?> path)
Determines whether or not the named managed object exists.
|
public static ServerManagementContext getInstance()
public <C extends ConfigurationClient,S extends Configuration> ServerManagedObject<? extends S> getManagedObject(ManagedObjectPath<C,S> path) throws ConfigException
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.ConfigException
- If the named managed object could not be found or if it
could not be decoded.public <C extends ConfigurationClient,S extends Configuration,PD> PD getPropertyValue(ManagedObjectPath<C,S> path, PropertyDefinition<PD> pd) throws IllegalArgumentException, ConfigException, PropertyException
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.path
- The path of the managed object containing the property.pd
- The property to be retrieved.null
if there are no values defined.IllegalArgumentException
- If the property definition is not associated with the
referenced managed object's definition.PropertyException
- If the managed object was found but the requested
property could not be decoded.ConfigException
- If the named managed object could not be found or if it
could not be decoded.public <C extends ConfigurationClient,S extends Configuration,PD> SortedSet<PD> getPropertyValues(ManagedObjectPath<C,S> path, PropertyDefinition<PD> pd) throws IllegalArgumentException, ConfigException, PropertyException
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.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.PropertyException
- If the managed object was found but the requested
property could not be decoded.ConfigException
- If the named managed object could not be found or if it
could not be decoded.public RootCfg getRootConfiguration()
public ServerManagedObject<RootCfg> getRootConfigurationManagedObject()
public <C extends ConfigurationClient,S extends Configuration> String[] listManagedObjects(ManagedObjectPath<?,?> parent, InstantiableRelationDefinition<C,S> rd) throws IllegalArgumentException
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.IllegalArgumentException
- If the relation definition is not associated with the
parent managed object's definition.public <C extends ConfigurationClient,S extends Configuration> String[] listManagedObjects(ManagedObjectPath<?,?> parent, SetRelationDefinition<C,S> rd) throws IllegalArgumentException
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.IllegalArgumentException
- If the relation definition is not associated with the
parent managed object's definition.public boolean managedObjectExists(ManagedObjectPath<?,?> path)
path
- The path of the named managed object.true
if the named managed object
exists, false
otherwise.Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.