|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ProfilerPluginCfg
A server-side interface for querying Profiler Plugin settings.
The Profiler plug-in captures profiling information about operations performed inside the JVM while the Directory Server is running.
Method Summary | |
---|---|
void |
addProfilerChangeListener(ConfigurationChangeListener<ProfilerPluginCfg> listener)
Register to be notified when this Profiler Plugin is changed. |
java.lang.Class<? extends ProfilerPluginCfg> |
configurationClass()
Gets the configuration class associated with this Profiler Plugin. |
java.lang.String |
getJavaClass()
Gets the "java-class" property. |
java.util.SortedSet<PluginCfgDefn.PluginType> |
getPluginType()
Gets the "plugin-type" property. |
ProfilerPluginCfgDefn.ProfileAction |
getProfileAction()
Gets the "profile-action" property. |
java.lang.String |
getProfileDirectory()
Gets the "profile-directory" property. |
long |
getProfileSampleInterval()
Gets the "profile-sample-interval" property. |
boolean |
isEnableProfilingOnStartup()
Gets the "enable-profiling-on-startup" property. |
boolean |
isInvokeForInternalOperations()
Gets the "invoke-for-internal-operations" property. |
void |
removeProfilerChangeListener(ConfigurationChangeListener<ProfilerPluginCfg> listener)
Deregister an existing Profiler Plugin configuration change listener. |
Methods inherited from interface org.opends.server.admin.std.server.PluginCfg |
---|
addChangeListener, isEnabled, removeChangeListener |
Methods inherited from interface org.opends.server.admin.Configuration |
---|
dn |
Method Detail |
---|
java.lang.Class<? extends ProfilerPluginCfg> configurationClass()
configurationClass
in interface Configuration
configurationClass
in interface PluginCfg
void addProfilerChangeListener(ConfigurationChangeListener<ProfilerPluginCfg> listener)
listener
- The Profiler Plugin configuration change listener.void removeProfilerChangeListener(ConfigurationChangeListener<ProfilerPluginCfg> listener)
listener
- The Profiler Plugin configuration change listener.boolean isEnableProfilingOnStartup()
Indicates whether the profiler plug-in is to start collecting data automatically when the Directory Server is started.
This property is read only when the server is started, and any changes take effect on the next restart. This property is typically set to "false" unless startup profiling is required, because otherwise the volume of data that can be collected can cause the server to run out of memory if it is not turned off in a timely manner.
boolean isInvokeForInternalOperations()
Indicates whether the plug-in should be invoked for internal operations.
Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.
isInvokeForInternalOperations
in interface PluginCfg
java.lang.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
getJavaClass
in interface PluginCfg
java.util.SortedSet<PluginCfgDefn.PluginType> getPluginType()
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
getPluginType
in interface PluginCfg
ProfilerPluginCfgDefn.ProfileAction getProfileAction()
Specifies the action that should be taken by the profiler.
A value of "start" causes the profiler thread to start collecting data if it is not already active. A value of "stop" causes the profiler thread to stop collecting data and write it to disk, and a value of "cancel" causes the profiler thread to stop collecting data and discard anything that has been captured. These operations occur immediately.
java.lang.String getProfileDirectory()
Specifies the path to the directory where profile information is to be written. This path may be either an absolute path or a path that is relative to the root of the OpenDS Directory Server instance.
The directory must exist and the Directory Server must have permission to create new files in it.
long getProfileSampleInterval()
Specifies the sample interval in milliseconds to be used when capturing profiling information in the server.
When capturing data, the profiler thread sleeps for this length of time between calls to obtain traces for all threads running in the JVM.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |