public final class ProfilerPluginCfgDefn extends ManagedObjectDefinition<ProfilerPluginCfgClient,ProfilerPluginCfg>
The Profiler plug-in captures profiling information about operations performed inside the JVM while the OpenDJ directory server is running.
Modifier and Type | Class and Description |
---|---|
static class |
ProfilerPluginCfgDefn.ProfileAction
Defines the set of permissable values for the "profile-action" property.
|
Modifier and Type | Method and Description |
---|---|
ProfilerPluginCfgClient |
createClientConfiguration(ManagedObject<? extends ProfilerPluginCfgClient> impl)
Creates a client configuration view of the provided managed
object.
|
ProfilerPluginCfg |
createServerConfiguration(ServerManagedObject<? extends ProfilerPluginCfg> impl)
Creates a server configuration view of the provided server
managed object.
|
BooleanPropertyDefinition |
getEnabledPropertyDefinition()
Get the "enabled" property definition.
|
BooleanPropertyDefinition |
getEnableProfilingOnStartupPropertyDefinition()
Get the "enable-profiling-on-startup" property definition.
|
static ProfilerPluginCfgDefn |
getInstance()
Get the Profiler Plugin configuration definition singleton.
|
BooleanPropertyDefinition |
getInvokeForInternalOperationsPropertyDefinition()
Get the "invoke-for-internal-operations" property definition.
|
ClassPropertyDefinition |
getJavaClassPropertyDefinition()
Get the "java-class" property definition.
|
EnumPropertyDefinition<PluginCfgDefn.PluginType> |
getPluginTypePropertyDefinition()
Get the "plugin-type" property definition.
|
EnumPropertyDefinition<ProfilerPluginCfgDefn.ProfileAction> |
getProfileActionPropertyDefinition()
Get the "profile-action" property definition.
|
StringPropertyDefinition |
getProfileDirectoryPropertyDefinition()
Get the "profile-directory" property definition.
|
DurationPropertyDefinition |
getProfileSampleIntervalPropertyDefinition()
Get the "profile-sample-interval" property definition.
|
Class<ProfilerPluginCfg> |
getServerConfigurationClass()
Gets the server configuration class instance associated with this
managed object definition.
|
getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString
public static ProfilerPluginCfgDefn getInstance()
public ProfilerPluginCfgClient createClientConfiguration(ManagedObject<? extends ProfilerPluginCfgClient> impl)
createClientConfiguration
in class ManagedObjectDefinition<ProfilerPluginCfgClient,ProfilerPluginCfg>
impl
- The managed object.public ProfilerPluginCfg createServerConfiguration(ServerManagedObject<? extends ProfilerPluginCfg> impl)
createServerConfiguration
in class ManagedObjectDefinition<ProfilerPluginCfgClient,ProfilerPluginCfg>
impl
- The server managed object.public Class<ProfilerPluginCfg> getServerConfigurationClass()
getServerConfigurationClass
in class ManagedObjectDefinition<ProfilerPluginCfgClient,ProfilerPluginCfg>
public BooleanPropertyDefinition getEnabledPropertyDefinition()
Indicates whether the plug-in is enabled for use.
public BooleanPropertyDefinition getEnableProfilingOnStartupPropertyDefinition()
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.
public BooleanPropertyDefinition getInvokeForInternalOperationsPropertyDefinition()
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.
public ClassPropertyDefinition getJavaClassPropertyDefinition()
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
public EnumPropertyDefinition<PluginCfgDefn.PluginType> getPluginTypePropertyDefinition()
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
public EnumPropertyDefinition<ProfilerPluginCfgDefn.ProfileAction> getProfileActionPropertyDefinition()
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.
public StringPropertyDefinition getProfileDirectoryPropertyDefinition()
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.
public DurationPropertyDefinition getProfileSampleIntervalPropertyDefinition()
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.
Copyright © 2010-2016 ForgeRock AS. All Rights Reserved.