public interface ProfilerPluginCfgClient extends PluginCfgClient
The Profiler plug-in captures profiling information about operations performed inside the JVM while the OpenDJ directory server is running.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends ProfilerPluginCfgClient,? extends ProfilerPluginCfg> |
definition()
Get the configuration definition associated with this Profiler Plugin.
|
ValueOrExpression<String> |
getJavaClass()
Gets the "java-class" property.
|
SortedSet<ValueOrExpression<PluginCfgDefn.PluginType>> |
getPluginType()
Gets the "plugin-type" property.
|
ValueOrExpression<ProfilerPluginCfgDefn.ProfileAction> |
getProfileAction()
Gets the "profile-action" property.
|
ValueOrExpression<String> |
getProfileDirectory()
Gets the "profile-directory" property.
|
ValueOrExpression<Long> |
getProfileSampleInterval()
Gets the "profile-sample-interval" property.
|
ValueOrExpression<Boolean> |
isEnableProfilingOnStartup()
Gets the "enable-profiling-on-startup" property.
|
ValueOrExpression<Boolean> |
isInvokeForInternalOperations()
Gets the "invoke-for-internal-operations" property.
|
void |
setEnableProfilingOnStartup(ValueOrExpression<Boolean> value)
Sets the "enable-profiling-on-startup" property.
|
void |
setInvokeForInternalOperations(ValueOrExpression<Boolean> value)
Sets the "invoke-for-internal-operations" property.
|
void |
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.
|
void |
setPluginType(Collection<ValueOrExpression<PluginCfgDefn.PluginType>> values)
Sets the "plugin-type" property.
|
void |
setProfileAction(ValueOrExpression<ProfilerPluginCfgDefn.ProfileAction> value)
Sets the "profile-action" property.
|
void |
setProfileDirectory(ValueOrExpression<String> value)
Sets the "profile-directory" property.
|
void |
setProfileSampleInterval(ValueOrExpression<Long> value)
Sets the "profile-sample-interval" property.
|
isEnabled, setEnabled
commit, properties
ManagedObjectDefinition<? extends ProfilerPluginCfgClient,? extends ProfilerPluginCfg> definition()
definition
in interface ConfigurationClient
definition
in interface PluginCfgClient
ValueOrExpression<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.
void setEnableProfilingOnStartup(ValueOrExpression<Boolean> value) throws PropertyException
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.
value
- The value of the "enable-profiling-on-startup" property.PropertyException
- If the new value is invalid.ValueOrExpression<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 PluginCfgClient
void setInvokeForInternalOperations(ValueOrExpression<Boolean> value) throws PropertyException
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.
setInvokeForInternalOperations
in interface PluginCfgClient
value
- The value of the "invoke-for-internal-operations" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getJavaClass()
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
getJavaClass
in interface PluginCfgClient
void setJavaClass(ValueOrExpression<String> value) throws PropertyException
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
setJavaClass
in interface PluginCfgClient
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<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 PluginCfgClient
void setPluginType(Collection<ValueOrExpression<PluginCfgDefn.PluginType>> values) throws PropertyException
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
setPluginType
in interface PluginCfgClient
values
- The values of the "plugin-type" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<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.
void setProfileAction(ValueOrExpression<ProfilerPluginCfgDefn.ProfileAction> value) throws PropertyException
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.
value
- The value of the "profile-action" property.PropertyException
- If the new value is invalid.ValueOrExpression<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 OpenDJ directory server instance.
The directory must exist and the directory server must have permission to create new files in it.
void setProfileDirectory(ValueOrExpression<String> value) throws PropertyException
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 OpenDJ directory server instance.
The directory must exist and the directory server must have permission to create new files in it.
value
- The value of the "profile-directory" property.PropertyException
- If the new value is invalid.ValueOrExpression<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.
void setProfileSampleInterval(ValueOrExpression<Long> value) throws PropertyException
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.
value
- The value of the "profile-sample-interval" property.PropertyException
- If the new value is invalid.Copyright 2010-2018 ForgeRock AS.