|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.config.JMXMBean
@PublicAPI(stability=VOLATILE, mayInstantiate=true, mayExtend=false, mayInvoke=true) public final class JMXMBean
This class defines a JMX MBean that can be registered with the Directory Server to provide monitoring and statistical information, provide read and/or read-write access to the configuration, and provide notifications and alerts if a significant event or severe/fatal error occurs.
Constructor Summary | |
---|---|
JMXMBean(DN configEntryDN)
Creates a new dynamic JMX MBean for use with the Directory Server. |
Method Summary | |
---|---|
void |
addAlertGenerator(AlertGenerator generator)
Adds the provided alert generator to the set of alert generators associated with this JMX MBean. |
void |
addInvokableComponent(InvokableComponent component)
Adds the provided invokable component to the set of components associated with this JMX MBean. |
void |
addMonitorProvider(MonitorProvider<? extends MonitorProviderCfg> component)
Adds the given monitor provider to the set of components associated with this JMX MBean. |
java.util.concurrent.CopyOnWriteArrayList<AlertGenerator> |
getAlertGenerators()
Retrieves the set of alert generators for this JMX MBean. |
javax.management.Attribute |
getAttribute(java.lang.String attributeName)
Obtain the value of a specific attribute of the Dynamic MBean. |
javax.management.AttributeList |
getAttributes(java.lang.String[] attributes)
Get the values of several attributes of the Dynamic MBean. |
java.util.concurrent.CopyOnWriteArrayList<InvokableComponent> |
getInvokableComponents()
Retrieves the set of invokable components associated with this JMX MBean. |
static java.lang.String |
getJmxName(DN configEntryDN)
Creates a JMX object name string based on a DN. |
javax.management.MBeanInfo |
getMBeanInfo()
Provides the exposed attributes and actions of the Dynamic MBean using an MBeanInfo object. |
java.util.concurrent.CopyOnWriteArrayList<MonitorProvider<? extends MonitorProviderCfg>> |
getMonitorProviders()
Retrieves the set of monitor providers associated with this JMX MBean. |
javax.management.ObjectName |
getObjectName()
Retrieves the JMX object name for this JMX MBean. |
java.lang.Object |
invoke(java.lang.String actionName,
java.lang.Object[] params,
java.lang.String[] signature)
Allows an action to be invoked on the Dynamic MBean. |
boolean |
removeAlertGenerator(AlertGenerator generator)
Removes the provided alert generator from the set of alert generators associated with this JMX MBean. |
boolean |
removeInvokableComponent(InvokableComponent component)
Removes the provided invokable component from the set of components associated with this JMX MBean. |
boolean |
removeMonitorProvider(MonitorProvider component)
Removes the given monitor provider from the set of components associated with this JMX MBean. |
void |
setAttribute(javax.management.Attribute attribute)
Set the value of a specific attribute of the Dynamic MBean. |
javax.management.AttributeList |
setAttributes(javax.management.AttributeList attributes)
Sets the values of several attributes of the Dynamic MBean. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JMXMBean(DN configEntryDN)
configEntryDN
- The DN of the configuration entry with which this
MBean is associated.Method Detail |
---|
public static java.lang.String getJmxName(DN configEntryDN)
configEntryDN
- The DN of the configuration entry with which
this ObjectName is associated.
public javax.management.ObjectName getObjectName()
getObjectName
in interface DirectoryServerMBean
public java.util.concurrent.CopyOnWriteArrayList<AlertGenerator> getAlertGenerators()
public void addAlertGenerator(AlertGenerator generator)
generator
- The alert generator to add to the set of alert
generators for this JMX MBean.public boolean removeAlertGenerator(AlertGenerator generator)
generator
- The alert generator to remove from the set of alert
generators for this JMX MBean.
true
if the alert generator was removed, or
false
if it was not associated with this MBean.public java.util.concurrent.CopyOnWriteArrayList<InvokableComponent> getInvokableComponents()
public void addInvokableComponent(InvokableComponent component)
component
- The component to add to the set of invokable components
for this JMX MBean.public boolean removeInvokableComponent(InvokableComponent component)
component
- The component to remove from the set of invokable
components for this JMX MBean.
true
if the specified component was successfully
removed, or false
if not.public java.util.concurrent.CopyOnWriteArrayList<MonitorProvider<? extends MonitorProviderCfg>> getMonitorProviders()
public void addMonitorProvider(MonitorProvider<? extends MonitorProviderCfg> component)
component
- The component to add to the set of monitor providers
for this JMX MBean.public boolean removeMonitorProvider(MonitorProvider component)
component
- The component to remove from the set of monitor
providers for this JMX MBean.
true
if the specified component was successfully
removed, or false
if not.public javax.management.Attribute getAttribute(java.lang.String attributeName) throws javax.management.AttributeNotFoundException
getAttribute
in interface javax.management.DynamicMBean
attributeName
- The name of the attribute to be retrieved.
javax.management.AttributeNotFoundException
- If the specified attribute is not
associated with this MBean.public void setAttribute(javax.management.Attribute attribute) throws javax.management.AttributeNotFoundException, javax.management.InvalidAttributeValueException
InvalidAttributeValueException
because setting
attribute values over JMX is currently not allowed.
setAttribute
in interface javax.management.DynamicMBean
attribute
- The identification of the attribute to be set and the
value it is to be set to.
javax.management.AttributeNotFoundException
- If the specified attribute is not
associated with this MBean.
javax.management.InvalidAttributeValueException
- If the provided value is not
acceptable for this MBean.public javax.management.AttributeList getAttributes(java.lang.String[] attributes)
getAttributes
in interface javax.management.DynamicMBean
attributes
- A list of the attributes to be retrieved.
public javax.management.AttributeList setAttributes(javax.management.AttributeList attributes)
setAttributes
in interface javax.management.DynamicMBean
attributes
- A list of attributes: The identification of the
attributes to be set and the values they are to be set
to.
public java.lang.Object invoke(java.lang.String actionName, java.lang.Object[] params, java.lang.String[] signature) throws javax.management.MBeanException
invoke
in interface javax.management.DynamicMBean
actionName
- The name of the action to be invoked.params
- An array containing the parameters to be set when the
action is invoked.signature
- An array containing the signature of the action. The
class objects will be loaded through the same class
loader as the one used for loading the MBean on which
action is invoked.
javax.management.MBeanException
- If a problem is encountered while invoking the
method.public javax.management.MBeanInfo getMBeanInfo()
getMBeanInfo
in interface javax.management.DynamicMBean
MBeanInfo
allowing all attributes and
actions exposed by this Dynamic MBean to be retrieved.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |