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> extends Object
Constructor and Description |
---|
MonitorProvider() |
Modifier and Type | Method and Description |
---|---|
void |
finalizeMonitorProvider()
Finalizes this monitor provider so that it may be unloaded and
taken out of service.
|
abstract 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 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 void |
initializeMonitorProvider(T configuration)
Initializes this monitor provider based on the information in the
provided configuration entry.
|
boolean |
isConfigurationAcceptable(MonitorProviderCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the provided configuration is acceptable for
this monitor provider.
|
protected void |
scheduleUpdate(Runnable updater,
long initialDelay,
long period,
TimeUnit unit)
Schedules any periodic processing that may be desired
to update the information associated with this monitor.
|
public MonitorProvider()
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, List<LocalizableMessage> 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 String getMonitorInstanceName()
public ObjectClass getMonitorObjectClass()
protected final void scheduleUpdate(Runnable updater, long initialDelay, long period, TimeUnit unit)
getUpdateInterval
milliseconds apart,
but no guarantees will be made.updater
- The updater to execute.initialDelay
- The time to delay first execution.period
- The period between successive executions.unit
- The time unit of the initialDelay and period
parameters.public abstract List<Attribute> getMonitorData()
Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.