S
- The type of server configuration represented by the server managed
object.public final class ServerManagedObject<S extends Configuration> extends Object
Modifier and Type | Method and Description |
---|---|
<M extends Configuration> |
deregisterAddListener(InstantiableRelationDefinition<?,M> d,
ConfigurationAddListener<M> listener)
Deregisters an existing configuration add listener.
|
<M extends Configuration> |
deregisterAddListener(InstantiableRelationDefinition<?,M> d,
ServerManagedObjectAddListener<M> listener)
Deregisters an existing server managed object add listener.
|
<M extends Configuration> |
deregisterAddListener(OptionalRelationDefinition<?,M> d,
ConfigurationAddListener<M> listener)
Deregisters an existing configuration add listener.
|
<M extends Configuration> |
deregisterAddListener(OptionalRelationDefinition<?,M> d,
ServerManagedObjectAddListener<M> listener)
Deregisters an existing server managed object add listener.
|
<M extends Configuration> |
deregisterAddListener(SetRelationDefinition<?,M> d,
ConfigurationAddListener<M> listener)
Deregisters an existing configuration add listener.
|
<M extends Configuration> |
deregisterAddListener(SetRelationDefinition<?,M> d,
ServerManagedObjectAddListener<M> listener)
Deregisters an existing server managed object add listener.
|
void |
deregisterChangeListener(ConfigurationChangeListener<? super S> listener)
Deregisters an existing configuration change listener.
|
void |
deregisterChangeListener(ServerManagedObjectChangeListener<? super S> listener)
Deregisters an existing server managed object change listener.
|
<M extends Configuration> |
deregisterDeleteListener(InstantiableRelationDefinition<?,M> d,
ConfigurationDeleteListener<M> listener)
Deregisters an existing configuration delete listener.
|
<M extends Configuration> |
deregisterDeleteListener(InstantiableRelationDefinition<?,M> d,
ServerManagedObjectDeleteListener<M> listener)
Deregisters an existing server managed object delete listener.
|
<M extends Configuration> |
deregisterDeleteListener(OptionalRelationDefinition<?,M> d,
ConfigurationDeleteListener<M> listener)
Deregisters an existing configuration delete listener.
|
<M extends Configuration> |
deregisterDeleteListener(OptionalRelationDefinition<?,M> d,
ServerManagedObjectDeleteListener<M> listener)
Deregisters an existing server managed object delete listener.
|
<M extends Configuration> |
deregisterDeleteListener(SetRelationDefinition<?,M> d,
ConfigurationDeleteListener<M> listener)
Deregisters an existing configuration delete listener.
|
<M extends Configuration> |
deregisterDeleteListener(SetRelationDefinition<?,M> d,
ServerManagedObjectDeleteListener<M> listener)
Deregisters an existing server managed object delete listener.
|
<M extends Configuration> |
getChild(InstantiableRelationDefinition<?,M> d,
String name)
Retrieve an instantiable child managed object.
|
<M extends Configuration> |
getChild(OptionalRelationDefinition<?,M> d)
Retrieve an optional child managed object.
|
<M extends Configuration> |
getChild(SetRelationDefinition<?,M> d,
String name)
Retrieve a set child managed object.
|
<M extends Configuration> |
getChild(SingletonRelationDefinition<?,M> d)
Retrieve a singleton child managed object.
|
S |
getConfiguration()
Creates a server configuration view of this managed object.
|
Dn |
getDn()
Get the DN of the LDAP entry associated with this server managed object.
|
ManagedObjectDefinition<?,S> |
getManagedObjectDefinition()
Get the definition associated with this server managed object.
|
ManagedObjectPath<?,S> |
getManagedObjectPath()
Get the path of this server managed object.
|
String |
getName()
Returns the RDN value of the LDAP entry associated with this server managed object.
|
<T> T |
getPropertyValue(PropertyDefinition<T> d)
Get the effective value of the specified property.
|
<T> SortedSet<T> |
getPropertyValues(PropertyDefinition<T> d)
Get the effective values of the specified property.
|
ServerManagementContext |
getServerContext()
Returns the server management context used by this object.
|
boolean |
hasChild(OptionalRelationDefinition<?,?> d)
Determines whether the optional managed object associated with the
specified optional relations exists.
|
String[] |
listChildren(InstantiableRelationDefinition<?,?> d)
Lists the child managed objects associated with the specified
instantiable relation.
|
String[] |
listChildren(SetRelationDefinition<?,?> d)
Lists the child managed objects associated with the specified set
relation.
|
<M extends Configuration> |
registerAddListener(InstantiableRelationDefinition<?,M> d,
ConfigurationAddListener<M> listener)
Register to be notified when new child configurations are added beneath
an instantiable relation.
|
<M extends Configuration> |
registerAddListener(InstantiableRelationDefinition<?,M> d,
ServerManagedObjectAddListener<M> listener)
Register to be notified when new child server managed object are added
beneath an instantiable relation.
|
<M extends Configuration> |
registerAddListener(OptionalRelationDefinition<?,M> d,
ConfigurationAddListener<M> listener)
Register to be notified when a new child configurations is added beneath
an optional relation.
|
<M extends Configuration> |
registerAddListener(OptionalRelationDefinition<?,M> d,
ServerManagedObjectAddListener<M> listener)
Register to be notified when a new child server managed object is added
beneath an optional relation.
|
<M extends Configuration> |
registerAddListener(SetRelationDefinition<?,M> d,
ConfigurationAddListener<M> listener)
Register to be notified when new child configurations are added beneath a
set relation.
|
<M extends Configuration> |
registerAddListener(SetRelationDefinition<?,M> d,
ServerManagedObjectAddListener<M> listener)
Register to be notified when new child server managed object are added
beneath a set relation.
|
void |
registerChangeListener(ConfigurationChangeListener<? super S> listener)
Register to be notified when this server managed object is changed.
|
void |
registerChangeListener(ServerManagedObjectChangeListener<? super S> listener)
Register to be notified when this server managed object is changed.
|
<M extends Configuration> |
registerDeleteListener(InstantiableRelationDefinition<?,M> d,
ConfigurationDeleteListener<M> listener)
Register to be notified when existing child configurations are deleted
beneath an instantiable relation.
|
<M extends Configuration> |
registerDeleteListener(InstantiableRelationDefinition<?,M> d,
ServerManagedObjectDeleteListener<M> listener)
Register to be notified when existing child server managed objects are
deleted beneath an instantiable relation.
|
<M extends Configuration> |
registerDeleteListener(OptionalRelationDefinition<?,M> d,
ConfigurationDeleteListener<M> listener)
Register to be notified when an existing child configuration is deleted
beneath an optional relation.
|
<M extends Configuration> |
registerDeleteListener(OptionalRelationDefinition<?,M> d,
ServerManagedObjectDeleteListener<M> listener)
Register to be notified when an existing child server managed object is
deleted beneath an optional relation.
|
<M extends Configuration> |
registerDeleteListener(SetRelationDefinition<?,M> d,
ConfigurationDeleteListener<M> listener)
Register to be notified when existing child configurations are deleted
beneath a set relation.
|
<M extends Configuration> |
registerDeleteListener(SetRelationDefinition<?,M> d,
ServerManagedObjectDeleteListener<M> listener)
Register to be notified when existing child server managed objects are
deleted beneath a set relation.
|
String |
toString() |
public <M extends Configuration> void deregisterAddListener(InstantiableRelationDefinition<?,M> d, ConfigurationAddListener<M> listener)
M
- The type of the child server configuration object.d
- The instantiable relation definition.listener
- The configuration add listener.IllegalArgumentException
- If the instantiable relation definition is not associated
with this managed object's definition.public <M extends Configuration> void deregisterAddListener(InstantiableRelationDefinition<?,M> d, ServerManagedObjectAddListener<M> listener)
M
- The type of the child server configuration object.d
- The instantiable relation definition.listener
- The server managed object add listener.IllegalArgumentException
- If the instantiable relation definition is not associated
with this managed object's definition.public <M extends Configuration> void deregisterAddListener(OptionalRelationDefinition<?,M> d, ConfigurationAddListener<M> listener)
M
- The type of the child server configuration object.d
- The optional relation definition.listener
- The configuration add listener.IllegalArgumentException
- If the optional relation definition is not associated with
this managed object's definition.public <M extends Configuration> void deregisterAddListener(OptionalRelationDefinition<?,M> d, ServerManagedObjectAddListener<M> listener)
M
- The type of the child server configuration object.d
- The optional relation definition.listener
- The server managed object add listener.IllegalArgumentException
- If the optional relation definition is not associated with
this managed object's definition.public <M extends Configuration> void deregisterAddListener(SetRelationDefinition<?,M> d, ConfigurationAddListener<M> listener)
M
- The type of the child server configuration object.d
- The set relation definition.listener
- The configuration add listener.IllegalArgumentException
- If the set relation definition is not associated with this
managed object's definition.public <M extends Configuration> void deregisterAddListener(SetRelationDefinition<?,M> d, ServerManagedObjectAddListener<M> listener)
M
- The type of the child server configuration object.d
- The set relation definition.listener
- The server managed object add listener.IllegalArgumentException
- If the set relation definition is not associated with this
managed object's definition.public void deregisterChangeListener(ConfigurationChangeListener<? super S> listener)
listener
- The configuration change listener.public void deregisterChangeListener(ServerManagedObjectChangeListener<? super S> listener)
listener
- The server managed object change listener.public <M extends Configuration> void deregisterDeleteListener(InstantiableRelationDefinition<?,M> d, ConfigurationDeleteListener<M> listener)
M
- The type of the child server configuration object.d
- The instantiable relation definition.listener
- The configuration delete listener.IllegalArgumentException
- If the instantiable relation definition is not associated
with this managed object's definition.public <M extends Configuration> void deregisterDeleteListener(InstantiableRelationDefinition<?,M> d, ServerManagedObjectDeleteListener<M> listener)
M
- The type of the child server configuration object.d
- The instantiable relation definition.listener
- The server managed object delete listener.IllegalArgumentException
- If the instantiable relation definition is not associated
with this managed object's definition.public <M extends Configuration> void deregisterDeleteListener(OptionalRelationDefinition<?,M> d, ConfigurationDeleteListener<M> listener)
M
- The type of the child server configuration object.d
- The optional relation definition.listener
- The configuration delete listener.IllegalArgumentException
- If the optional relation definition is not associated with
this managed object's definition.public <M extends Configuration> void deregisterDeleteListener(OptionalRelationDefinition<?,M> d, ServerManagedObjectDeleteListener<M> listener)
M
- The type of the child server configuration object.d
- The optional relation definition.listener
- The server managed object delete listener.IllegalArgumentException
- If the optional relation definition is not associated with
this managed object's definition.public <M extends Configuration> void deregisterDeleteListener(SetRelationDefinition<?,M> d, ConfigurationDeleteListener<M> listener)
M
- The type of the child server configuration object.d
- The set relation definition.listener
- The configuration delete listener.IllegalArgumentException
- If the set relation definition is not associated with this
managed object's definition.public <M extends Configuration> void deregisterDeleteListener(SetRelationDefinition<?,M> d, ServerManagedObjectDeleteListener<M> listener)
M
- The type of the child server configuration object.d
- The set relation definition.listener
- The server managed object delete listener.IllegalArgumentException
- If the set relation definition is not associated with this
managed object's definition.public <M extends Configuration> ServerManagedObject<? extends M> getChild(InstantiableRelationDefinition<?,M> d, String name) throws ConfigException
M
- The requested type of the child server managed object
configuration.d
- The instantiable relation definition.name
- The name of the child managed object.IllegalArgumentException
- If the relation definition is not associated with this
managed object's definition.ConfigException
- If the child managed object could not be found or if it could
not be decoded.public <M extends Configuration> ServerManagedObject<? extends M> getChild(OptionalRelationDefinition<?,M> d) throws ConfigException
M
- The requested type of the child server managed object
configuration.d
- The optional relation definition.IllegalArgumentException
- If the optional relation definition is not associated with
this managed object's definition.ConfigException
- If the child managed object could not be found or if it could
not be decoded.public <M extends Configuration> ServerManagedObject<? extends M> getChild(SetRelationDefinition<?,M> d, String name) throws ConfigException
M
- The requested type of the child server managed object
configuration.d
- The set relation definition.name
- The name of the child managed object.IllegalArgumentException
- If the relation definition is not associated with this
managed object's definition or if name
specifies a
managed object definition which is not a sub-type of the
relation's child definition.ConfigException
- If the child managed object could not be found or if it could
not be decoded.public <M extends Configuration> ServerManagedObject<? extends M> getChild(SingletonRelationDefinition<?,M> d) throws ConfigException
M
- The requested type of the child server managed object
configuration.d
- The singleton relation definition.IllegalArgumentException
- If the relation definition is not associated with this
managed object's definition.ConfigException
- If the child managed object could not be found or if it could
not be decoded.public ServerManagementContext getServerContext()
public S getConfiguration()
public Dn getDn()
public String getName()
public ManagedObjectDefinition<?,S> getManagedObjectDefinition()
public ManagedObjectPath<?,S> getManagedObjectPath()
public <T> T getPropertyValue(PropertyDefinition<T> d)
null
indicating that any default behavior is applicable.T
- The type of the property to be retrieved.d
- The property to be retrieved.null
indicating that any default behavior is applicable.IllegalArgumentException
- If the property definition is not associated with this
managed object's definition.public <T> SortedSet<T> getPropertyValues(PropertyDefinition<T> d)
T
- The type of the property to be retrieved.d
- The property to be retrieved.IllegalArgumentException
- If the property definition is not associated with this
managed object's definition.public boolean hasChild(OptionalRelationDefinition<?,?> d)
d
- The optional relation definition.true
if the optional managed object exists,
false
otherwise.IllegalArgumentException
- If the optional relation definition is not associated with
this managed object's definition.public String[] listChildren(InstantiableRelationDefinition<?,?> d)
d
- The instantiable relation definition.IllegalArgumentException
- If the relation definition is not associated with this
managed object's definition.public String[] listChildren(SetRelationDefinition<?,?> d)
d
- The set relation definition.IllegalArgumentException
- If the relation definition is not associated with this
managed object's definition.public <M extends Configuration> void registerAddListener(InstantiableRelationDefinition<?,M> d, ConfigurationAddListener<M> listener) throws ConfigException
M
- The type of the child server configuration object.d
- The instantiable relation definition.listener
- The configuration add listener.IllegalArgumentException
- If the instantiable relation definition is not associated
with this managed object's definition.ConfigException
- If the configuration entry associated with the instantiable
relation could not be retrieved.public <M extends Configuration> void registerAddListener(InstantiableRelationDefinition<?,M> d, ServerManagedObjectAddListener<M> listener) throws ConfigException
M
- The type of the child server configuration object.d
- The instantiable relation definition.listener
- The server managed object add listener.IllegalArgumentException
- If the instantiable relation definition is not associated
with this managed object's definition.ConfigException
- If the configuration entry associated with the instantiable
relation could not be retrieved.public <M extends Configuration> void registerAddListener(OptionalRelationDefinition<?,M> d, ConfigurationAddListener<M> listener) throws ConfigException
M
- The type of the child server configuration object.d
- The optional relation definition.listener
- The configuration add listener.IllegalArgumentException
- If the optional relation definition is not associated with
this managed object's definition.ConfigException
- If the configuration entry associated with the optional
relation could not be retrieved.public <M extends Configuration> void registerAddListener(OptionalRelationDefinition<?,M> d, ServerManagedObjectAddListener<M> listener) throws ConfigException
M
- The type of the child server configuration object.d
- The optional relation definition.listener
- The server managed object add listener.IllegalArgumentException
- If the optional relation definition is not associated with
this managed object's definition.ConfigException
- If the configuration entry associated with the optional
relation could not be retrieved.public <M extends Configuration> void registerAddListener(SetRelationDefinition<?,M> d, ConfigurationAddListener<M> listener) throws ConfigException
M
- The type of the child server configuration object.d
- The set relation definition.listener
- The configuration add listener.IllegalArgumentException
- If the set relation definition is not associated with this
managed object's definition.ConfigException
- If the configuration entry associated with the set relation
could not be retrieved.public <M extends Configuration> void registerAddListener(SetRelationDefinition<?,M> d, ServerManagedObjectAddListener<M> listener) throws ConfigException
M
- The type of the child server configuration object.d
- The set relation definition.listener
- The server managed object add listener.IllegalArgumentException
- If the set relation definition is not associated with this
managed object's definition.ConfigException
- If the configuration entry associated with the set relation
could not be retrieved.public void registerChangeListener(ConfigurationChangeListener<? super S> listener)
listener
- The configuration change listener.public void registerChangeListener(ServerManagedObjectChangeListener<? super S> listener)
listener
- The server managed object change listener.public <M extends Configuration> void registerDeleteListener(InstantiableRelationDefinition<?,M> d, ConfigurationDeleteListener<M> listener) throws ConfigException
M
- The type of the child server configuration object.d
- The instantiable relation definition.listener
- The configuration delete listener.IllegalArgumentException
- If the instantiable relation definition is not associated
with this managed object's definition.ConfigException
- If the configuration entry associated with the instantiable
relation could not be retrieved.public <M extends Configuration> void registerDeleteListener(InstantiableRelationDefinition<?,M> d, ServerManagedObjectDeleteListener<M> listener) throws ConfigException
M
- The type of the child server configuration object.d
- The instantiable relation definition.listener
- The server managed objects delete listener.IllegalArgumentException
- If the instantiable relation definition is not associated
with this managed object's definition.ConfigException
- If the configuration entry associated with the instantiable
relation could not be retrieved.public <M extends Configuration> void registerDeleteListener(OptionalRelationDefinition<?,M> d, ConfigurationDeleteListener<M> listener) throws ConfigException
M
- The type of the child server configuration object.d
- The optional relation definition.listener
- The configuration delete listener.IllegalArgumentException
- If the optional relation definition is not associated with
this managed object's definition.ConfigException
- If the configuration entry associated with the optional
relation could not be retrieved.public <M extends Configuration> void registerDeleteListener(OptionalRelationDefinition<?,M> d, ServerManagedObjectDeleteListener<M> listener) throws ConfigException
M
- The type of the child server configuration object.d
- The optional relation definition.listener
- The server managed object delete listener.IllegalArgumentException
- If the optional relation definition is not associated with
this managed object's definition.ConfigException
- If the configuration entry associated with the optional
relation could not be retrieved.public <M extends Configuration> void registerDeleteListener(SetRelationDefinition<?,M> d, ConfigurationDeleteListener<M> listener) throws ConfigException
M
- The type of the child server configuration object.d
- The set relation definition.listener
- The configuration delete listener.IllegalArgumentException
- If the set relation definition is not associated with this
managed object's definition.ConfigException
- If the configuration entry associated with the set relation
could not be retrieved.public <M extends Configuration> void registerDeleteListener(SetRelationDefinition<?,M> d, ServerManagedObjectDeleteListener<M> listener) throws ConfigException
M
- The type of the child server configuration object.d
- The set relation definition.listener
- The server managed objects delete listener.IllegalArgumentException
- If the set relation definition is not associated with this
managed object's definition.ConfigException
- If the configuration entry associated with the set relation
could not be retrieved.Copyright 2010-2022 ForgeRock AS.