|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Thread
org.opends.server.api.DirectoryThread
org.opends.server.api.MonitorProvider<T>
T
- The type of configuration handled by this monitor
provider.@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=true, mayInvoke=false) public abstract class MonitorProvider<T extends MonitorProviderCfg>
This class defines the set of methods and structures that must be implemented by a Directory Server module that can provide usage, performance, availability, or other kinds of monitor information to clients.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class java.lang.Thread |
---|
java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler |
Field Summary |
---|
Fields inherited from class java.lang.Thread |
---|
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY |
Constructor Summary | |
---|---|
protected |
MonitorProvider(java.lang.String threadName)
Initializes this monitor provider. |
Method Summary | |
---|---|
void |
finalizeMonitorProvider()
Finalizes this monitor provider so that it may be unloaded and taken out of service. |
abstract java.util.List<Attribute> |
getMonitorData()
Retrieves a set of attributes containing monitor data that should be returned to the client if the corresponding monitor entry is requested. |
abstract java.lang.String |
getMonitorInstanceName()
Retrieves the name of this monitor provider. |
ObjectClass |
getMonitorObjectClass()
Retrieves the objectclass that should be included in the monitor entry created from this monitor provider. |
abstract long |
getUpdateInterval()
Retrieves the length of time in milliseconds that should elapse between calls to the updateMonitorData method. |
abstract void |
initializeMonitorProvider(T configuration)
Initializes this monitor provider based on the information in the provided configuration entry. |
boolean |
isConfigurationAcceptable(MonitorProviderCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this monitor provider. |
void |
run()
Enters a loop, periodically invoking the getUpdateInterval method to updates the data associated
with this monitor. |
abstract void |
updateMonitorData()
Performs any processing periodic processing that may be desired to update the information associated with this monitor. |
Methods inherited from class org.opends.server.api.DirectoryThread |
---|
getAssociatedTask, getCreationStackTrace, getDebugProperties, getParentThread, setAssociatedTask |
Methods inherited from class java.lang.Thread |
---|
activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected MonitorProvider(java.lang.String threadName)
initializeMonitorProvider
class.
threadName
- The name to use for this thread for debugging
purposes.Method Detail |
---|
public abstract void initializeMonitorProvider(T configuration) throws ConfigException, InitializationException
configuration
- The configuration to use to initialize
this monitor provider.
ConfigException
- If an unrecoverable problem arises in
the process of performing the
initialization.
InitializationException
- If a problem occurs during
initialization that is not
related to the server
configuration.public boolean isConfigurationAcceptable(MonitorProviderCfg configuration, java.util.List<Message> unacceptableReasons)
configuration
- The monitor provider configuration
for which to make the determination.unacceptableReasons
- A list that may be used to hold the
reasons that the provided
configuration is not acceptable.
true
if the provided configuration is acceptable
for this monitor provider, or false
if not.public void finalizeMonitorProvider()
super.finalizeMonitorProvider
.
public abstract java.lang.String getMonitorInstanceName()
public ObjectClass getMonitorObjectClass()
public abstract long getUpdateInterval()
updateMonitorData
method. A
negative or zero return value indicates that the
updateMonitorData
method should not be periodically
invoked.
updateMonitorData()
method.public abstract void updateMonitorData()
getUpdateInterval
milliseconds apart,
but no guarantees will be made.
public abstract java.util.List<Attribute> getMonitorData()
public final void run()
getUpdateInterval
method to updates the data associated
with this monitor.
run
in interface java.lang.Runnable
run
in class java.lang.Thread
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |