|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.admin.server.ServerManagedObject<S>
S
- The type of server configuration represented by the server
managed object.public final class ServerManagedObject<S extends Configuration>
A server-side managed object.
Field Summary |
---|
Fields inherited from interface org.opends.server.admin.PropertyProvider |
---|
DEFAULT_PROVIDER |
Method Summary | ||
---|---|---|
|
deregisterAddListener(InstantiableRelationDefinition<?,M> d,
ConfigurationAddListener<M> listener)
Deregisters an existing configuration add listener. |
|
|
deregisterAddListener(InstantiableRelationDefinition<?,M> d,
ServerManagedObjectAddListener<M> listener)
Deregisters an existing server managed object add listener. |
|
|
deregisterAddListener(OptionalRelationDefinition<?,M> d,
ConfigurationAddListener<M> listener)
Deregisters an existing configuration add listener. |
|
|
deregisterAddListener(OptionalRelationDefinition<?,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. |
|
|
deregisterDeleteListener(InstantiableRelationDefinition<?,M> d,
ConfigurationDeleteListener<M> listener)
Deregisters an existing configuration delete listener. |
|
|
deregisterDeleteListener(InstantiableRelationDefinition<?,M> d,
ServerManagedObjectDeleteListener<M> listener)
Deregisters an existing server managed object delete listener. |
|
|
deregisterDeleteListener(OptionalRelationDefinition<?,M> d,
ConfigurationDeleteListener<M> listener)
Deregisters an existing configuration delete listener. |
|
|
deregisterDeleteListener(OptionalRelationDefinition<?,M> d,
ServerManagedObjectDeleteListener<M> listener)
Deregisters an existing server managed object delete listener. |
|
|
getChild(InstantiableRelationDefinition<?,M> d,
java.lang.String name)
Retrieve an instantiable child managed object. |
|
|
getChild(OptionalRelationDefinition<?,M> d)
Retrieve an optional child managed object. |
|
|
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. |
|
|
getPropertyValue(PropertyDefinition<T> d)
Get the effective value of the specified property. |
|
|
getPropertyValues(PropertyDefinition<T> d)
Get the effective values of the specified property. |
|
boolean |
hasChild(OptionalRelationDefinition<?,?> d)
Determines whether or not the optional managed object associated with the specified optional relations exists. |
|
java.lang.String[] |
listChildren(InstantiableRelationDefinition<?,?> d)
Lists the child managed objects associated with the specified instantiable relation. |
|
|
registerAddListener(InstantiableRelationDefinition<?,M> d,
ConfigurationAddListener<M> listener)
Register to be notified when new child configurations are added beneath an instantiable relation. |
|
|
registerAddListener(InstantiableRelationDefinition<?,M> d,
ServerManagedObjectAddListener<M> listener)
Register to be notified when new child server managed object are added beneath an instantiable relation. |
|
|
registerAddListener(OptionalRelationDefinition<?,M> d,
ConfigurationAddListener<M> listener)
Register to be notified when a new child configurations is added beneath an optional relation. |
|
|
registerAddListener(OptionalRelationDefinition<?,M> d,
ServerManagedObjectAddListener<M> listener)
Register to be notified when a new child server managed object is added beneath an optional 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. |
|
|
registerDeleteListener(InstantiableRelationDefinition<?,M> d,
ConfigurationDeleteListener<M> listener)
Register to be notified when existing child configurations are deleted beneath an instantiable relation. |
|
|
registerDeleteListener(InstantiableRelationDefinition<?,M> d,
ServerManagedObjectDeleteListener<M> listener)
Register to be notified when existing child server managed objects are deleted beneath an instantiable relation. |
|
|
registerDeleteListener(OptionalRelationDefinition<?,M> d,
ConfigurationDeleteListener<M> listener)
Register to be notified when an existing child configuration is deleted beneath an optional relation. |
|
|
registerDeleteListener(OptionalRelationDefinition<?,M> d,
ServerManagedObjectDeleteListener<M> listener)
Register to be notified when an existing child server managed object is deleted beneath an optional relation. |
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public <M extends Configuration> void deregisterAddListener(InstantiableRelationDefinition<?,M> d, ConfigurationAddListener<M> listener) throws java.lang.IllegalArgumentException
M
- The type of the child server configuration object.d
- The instantiable relation definition.listener
- The configuration add listener.
java.lang.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) throws java.lang.IllegalArgumentException
M
- The type of the child server configuration object.d
- The instantiable relation definition.listener
- The server managed object add listener.
java.lang.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) throws java.lang.IllegalArgumentException
M
- The type of the child server configuration object.d
- The optional relation definition.listener
- The configuration add listener.
java.lang.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) throws java.lang.IllegalArgumentException
M
- The type of the child server configuration object.d
- The optional relation definition.listener
- The server managed object add listener.
java.lang.IllegalArgumentException
- If the optional 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) throws java.lang.IllegalArgumentException
M
- The type of the child server configuration object.d
- The instantiable relation definition.listener
- The configuration delete listener.
java.lang.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) throws java.lang.IllegalArgumentException
M
- The type of the child server configuration object.d
- The instantiable relation definition.listener
- The server managed object delete listener.
java.lang.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) throws java.lang.IllegalArgumentException
M
- The type of the child server configuration object.d
- The optional relation definition.listener
- The configuration delete listener.
java.lang.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) throws java.lang.IllegalArgumentException
M
- The type of the child server configuration object.d
- The optional relation definition.listener
- The server managed object delete listener.
java.lang.IllegalArgumentException
- If the optional relation definition is not associated
with this managed object's definition.public <M extends Configuration> ServerManagedObject<? extends M> getChild(InstantiableRelationDefinition<?,M> d, java.lang.String name) throws java.lang.IllegalArgumentException, 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.
java.lang.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 java.lang.IllegalArgumentException, ConfigException
M
- The requested type of the child server managed object
configuration.d
- The optional relation definition.
java.lang.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(SingletonRelationDefinition<?,M> d) throws java.lang.IllegalArgumentException, ConfigException
M
- The requested type of the child server managed object
configuration.d
- The singleton relation definition.
java.lang.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 S getConfiguration()
public DN getDN()
public ManagedObjectDefinition<?,S> getManagedObjectDefinition()
public ManagedObjectPath<?,S> getManagedObjectPath()
public <T> T getPropertyValue(PropertyDefinition<T> d) throws java.lang.IllegalArgumentException
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.
java.lang.IllegalArgumentException
- If the property definition is not associated with this
managed object's definition.public <T> java.util.SortedSet<T> getPropertyValues(PropertyDefinition<T> d) throws java.lang.IllegalArgumentException
getPropertyValues
in interface PropertyProvider
T
- The type of the property to be retrieved.d
- The property to be retrieved.
java.lang.IllegalArgumentException
- If the property definition is not associated with this
managed object's definition.public boolean hasChild(OptionalRelationDefinition<?,?> d) throws java.lang.IllegalArgumentException
d
- The optional relation definition.
true
if the optional managed
object exists, false
otherwise.
java.lang.IllegalArgumentException
- If the optional relation definition is not associated
with this managed object's definition.public java.lang.String[] listChildren(InstantiableRelationDefinition<?,?> d) throws java.lang.IllegalArgumentException
d
- The instantiable relation definition.
java.lang.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 java.lang.IllegalArgumentException, ConfigException
M
- The type of the child server configuration object.d
- The instantiable relation definition.listener
- The configuration add listener.
java.lang.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 java.lang.IllegalArgumentException, ConfigException
M
- The type of the child server configuration object.d
- The instantiable relation definition.listener
- The server managed object add listener.
java.lang.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 java.lang.IllegalArgumentException, ConfigException
M
- The type of the child server configuration object.d
- The optional relation definition.listener
- The configuration add listener.
java.lang.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 java.lang.IllegalArgumentException, ConfigException
M
- The type of the child server configuration object.d
- The optional relation definition.listener
- The server managed object add listener.
java.lang.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 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 java.lang.IllegalArgumentException, ConfigException
M
- The type of the child server configuration object.d
- The instantiable relation definition.listener
- The configuration delete listener.
java.lang.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 java.lang.IllegalArgumentException, ConfigException
M
- The type of the child server configuration object.d
- The instantiable relation definition.listener
- The server managed objects delete listener.
java.lang.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 java.lang.IllegalArgumentException, ConfigException
M
- The type of the child server configuration object.d
- The optional relation definition.listener
- The configuration delete listener.
java.lang.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 java.lang.IllegalArgumentException, ConfigException
M
- The type of the child server configuration object.d
- The optional relation definition.listener
- The server managed object delete listener.
java.lang.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 java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |