|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.plugin.DirectoryServerPlugin<ProfilerPluginCfg>
org.opends.server.plugins.profiler.ProfilerPlugin
public final class ProfilerPlugin
This class defines a Directory Server startup plugin that will register itself as a configurable component that can allow for a simple sample-based profiling mechanism within the Directory Server. When profiling is enabled, the server will periodically (e.g., every few milliseconds) retrieve all the stack traces for all threads in the server and aggregates them so that they can be analyzed to see where the server is spending all of its processing time.
Field Summary | |
---|---|
static java.lang.String |
PROFILE_ACTION_CANCEL
The value to use for the profiler action when it should stop capturing data and discard any information that has been collected. |
static java.lang.String |
PROFILE_ACTION_NONE
The value to use for the profiler action when no action is necessary. |
static java.lang.String |
PROFILE_ACTION_START
The value to use for the profiler action when it should start capturing information. |
static java.lang.String |
PROFILE_ACTION_STOP
The value to use for the profiler action when it should stop capturing data and write the information it has collected to disk. |
Constructor Summary | |
---|---|
ProfilerPlugin()
Creates a new instance of this Directory Server plugin. |
Method Summary | |
---|---|
ConfigChangeResult |
applyConfigurationChange(ProfilerPluginCfg configuration)
Applies the configuration changes to this change listener. |
PluginResult.Startup |
doStartup()
Performs any processing that should be done when the Directory Server is in the process of starting. |
void |
finalizePlugin()
Performs any necessary finalization for this plugin. |
void |
initializePlugin(java.util.Set<PluginType> pluginTypes,
ProfilerPluginCfg configuration)
Performs any initialization necessary for this plugin. |
boolean |
isConfigurationAcceptable(PluginCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this plugin. |
boolean |
isConfigurationChangeAcceptable(ProfilerPluginCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the proposed change to the configuration is acceptable to this change listener. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PROFILE_ACTION_NONE
public static final java.lang.String PROFILE_ACTION_START
public static final java.lang.String PROFILE_ACTION_STOP
public static final java.lang.String PROFILE_ACTION_CANCEL
Constructor Detail |
---|
public ProfilerPlugin()
super()
as its first element.
Method Detail |
---|
public final void initializePlugin(java.util.Set<PluginType> pluginTypes, ProfilerPluginCfg configuration) throws ConfigException
initializePlugin
in class DirectoryServerPlugin<ProfilerPluginCfg>
pluginTypes
- The set of plugin types that indicate the
ways in which this plugin will be invoked.configuration
- The configuration for this plugin.
ConfigException
- If the provided entry does not contain
a valid configuration for this plugin.public final void finalizePlugin()
finalizePlugin
in class DirectoryServerPlugin<ProfilerPluginCfg>
public final PluginResult.Startup doStartup()
doStartup
in class DirectoryServerPlugin<ProfilerPluginCfg>
public boolean isConfigurationAcceptable(PluginCfg configuration, java.util.List<Message> unacceptableReasons)
isConfigurationAcceptable
in class DirectoryServerPlugin<ProfilerPluginCfg>
configuration
- The plugin 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 plugin, or false
if not.public boolean isConfigurationChangeAcceptable(ProfilerPluginCfg configuration, java.util.List<Message> unacceptableReasons)
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<ProfilerPluginCfg>
configuration
- The new configuration containing the changes.unacceptableReasons
- A list that can be used to hold messages about why the
provided configuration is not acceptable.
true
if the proposed change is
acceptable, or false
if it is not.public ConfigChangeResult applyConfigurationChange(ProfilerPluginCfg configuration)
applyConfigurationChange
in interface ConfigurationChangeListener<ProfilerPluginCfg>
configuration
- The new configuration containing the changes.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |