|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.directory.sdk.common.api.MonitorProvider
@Extensible @DirectoryServerExtension @DirectoryProxyServerExtension(appliesToLocalContent=true, appliesToRemoteContent=false) @SynchronizationServerExtension(appliesToLocalContent=true, appliesToSynchronizedContent=false) @MetricsEngineExtension @IdentityBrokerExtension @ThreadSafety(level=INTERFACE_THREADSAFE) public abstract class MonitorProvider
This class defines an API that must be implemented by extensions which
expose monitoring information about server components. Each monitor provider
instance will be used by the server to construct a single monitor entry.
The monitor information will be obtained on demand whenever the server
receives a request targeting a monitor entry, but monitor providers may also
indicate that they should be periodically invoked by a background thread so
that they can collect additional information on a regular basis even when no
clients have requested monitor information.
dsconfig create-monitor-provider \ --provider-name "{provider-name}" \ --type third-party \ --set enabled:true \ --set "extension-class:{class-name}" \ --set "extension-argument:{name=value}"where "{provider-name}" is the name to use for the monitor provider instance, "{class-name}" is the fully-qualified name of the Java class that extends
com.unboundid.directory.sdk.common.api.MonitorProvider
,
and "{name=value}" represents name-value pairs for any arguments to
provide to the monitor provider. If multiple arguments should be provided to
the monitor provider, then the
"--set extension-argument:{name=value}
" option should be
provided multiple times.
Constructor Summary | |
---|---|
MonitorProvider()
Creates a new instance of this monitor provider. |
Method Summary | |
---|---|
com.unboundid.ldap.sdk.ResultCode |
applyConfiguration(MonitorProviderConfig config,
com.unboundid.util.args.ArgumentParser parser,
java.util.List<java.lang.String> adminActionsRequired,
java.util.List<java.lang.String> messages)
Attempts to apply the configuration from the provided argument parser to this extension. |
void |
defineConfigArguments(com.unboundid.util.args.ArgumentParser parser)
Updates the provided argument parser to define any configuration arguments which may be used by this extension. |
void |
finalizeMonitorProvider()
Performs any cleanup which may be necessary when this monitor provider is to be taken out of service. |
java.util.Map<java.util.List<java.lang.String>,java.lang.String> |
getExamplesArgumentSets()
Retrieves a map containing examples of configurations that may be used for this extension. |
abstract java.lang.String[] |
getExtensionDescription()
Retrieves a human-readable description for this extension. |
abstract java.lang.String |
getExtensionName()
Retrieves a human-readable name for this extension. |
abstract java.util.List<com.unboundid.ldap.sdk.Attribute> |
getMonitorAttributes()
Retrieves a list of attributes containing the data to include in the monitor entry generated from this monitor provider. |
abstract java.lang.String |
getMonitorInstanceName()
Retrieves the name that identifies this monitor provider instance. |
java.lang.String |
getMonitorObjectClass()
Retrieves the name of the object class that will be used for monitor entries created from this monitor provider. |
long |
getUpdateIntervalMillis()
Retrieves the update interval in milliseconds that should be used for this monitor provider. |
void |
initializeMonitorProvider(ServerContext serverContext,
MonitorProviderConfig config,
com.unboundid.util.args.ArgumentParser parser)
Initializes this monitor provider. |
boolean |
isConfigurationAcceptable(MonitorProviderConfig config,
com.unboundid.util.args.ArgumentParser parser,
java.util.List<java.lang.String> unacceptableReasons)
Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension. |
void |
updateMonitorData()
Updates the information collected by this monitor provider. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MonitorProvider()
initializeMonitorProvider
method.
Method Detail |
---|
public abstract java.lang.String getExtensionName()
getExtensionName
in interface UnboundIDExtension
public abstract java.lang.String[] getExtensionDescription()
getExtensionDescription
in interface UnboundIDExtension
null
or an empty array if no description should be available.public void defineConfigArguments(com.unboundid.util.args.ArgumentParser parser) throws com.unboundid.util.args.ArgumentException
defineConfigArguments
in interface Configurable
parser
- The argument parser to be updated with the configuration
arguments which may be used by this extension.
com.unboundid.util.args.ArgumentException
- If a problem is encountered while updating the
provided argument parser.public void initializeMonitorProvider(ServerContext serverContext, MonitorProviderConfig config, com.unboundid.util.args.ArgumentParser parser) throws com.unboundid.ldap.sdk.LDAPException
serverContext
- A handle to the server context for the server in
which this extension is running.config
- The general configuration for this access logger.parser
- The argument parser which has been initialized from
the configuration for this monitor provider.
com.unboundid.ldap.sdk.LDAPException
- If a problem occurs while initializing this monitor
providerpublic boolean isConfigurationAcceptable(MonitorProviderConfig config, com.unboundid.util.args.ArgumentParser parser, java.util.List<java.lang.String> unacceptableReasons)
isConfigurationAcceptable
in interface Reconfigurable<MonitorProviderConfig>
config
- The general configuration for this extension.parser
- The argument parser that has been used to
parse the proposed configuration for this
extension.unacceptableReasons
- A list to which messages may be added to
provide additional information about why the
provided configuration is not acceptable.
true
if the configuration in the provided argument parser
appears to be acceptable, or false
if not.public com.unboundid.ldap.sdk.ResultCode applyConfiguration(MonitorProviderConfig config, com.unboundid.util.args.ArgumentParser parser, java.util.List<java.lang.String> adminActionsRequired, java.util.List<java.lang.String> messages)
applyConfiguration
in interface Reconfigurable<MonitorProviderConfig>
config
- The general configuration for this extension.parser
- The argument parser that has been used to
parse the new configuration for this
extension.adminActionsRequired
- A list to which messages may be added to
provide additional information about any
additional administrative actions that may
be required to apply some of the
configuration changes.messages
- A list to which messages may be added to
provide additional information about the
processing performed by this method.
SUCCESS
should be
used to indicate that all processing completed successfully. Any
other result will indicate that a problem occurred during
processing.public void finalizeMonitorProvider()
public abstract java.lang.String getMonitorInstanceName()
public java.lang.String getMonitorObjectClass()
null
if a default object
class should be used.
public long getUpdateIntervalMillis()
updateMonitorData()
method to be repeatedly invoked at that
interval. A value less than or equal to zero indicates that the monitor
provider should not be periodically updated.
If the initial returned value is greater than zero, then this method will be invoked between each update to see if the update interval has changed. This way you can change the interval dynamically.
public void updateMonitorData()
getUpdateIntervalMillis()
method
returns a positive value.
public abstract java.util.List<com.unboundid.ldap.sdk.Attribute> getMonitorAttributes()
public java.util.Map<java.util.List<java.lang.String>,java.lang.String> getExamplesArgumentSets()
getExamplesArgumentSets
in interface ExampleUsageProvider
null
or empty if there should
not be any example argument sets.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |