org.opends.server.admin.std.client
Interface ProfilerPluginCfgClient

All Superinterfaces:
ConfigurationClient, PluginCfgClient

public interface ProfilerPluginCfgClient
extends PluginCfgClient

A client-side interface for reading and modifying Profiler Plugin settings.

The Profiler plug-in captures profiling information about operations performed inside the JVM while the Directory Server is running.


Method Summary
 ManagedObjectDefinition<? extends ProfilerPluginCfgClient,? extends ProfilerPluginCfg> definition()
          Get the configuration definition 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.
 java.lang.Long getProfileSampleInterval()
          Gets the "profile-sample-interval" property.
 java.lang.Boolean isEnableProfilingOnStartup()
          Gets the "enable-profiling-on-startup" property.
 boolean isInvokeForInternalOperations()
          Gets the "invoke-for-internal-operations" property.
 void setEnableProfilingOnStartup(boolean value)
          Sets the "enable-profiling-on-startup" property.
 void setInvokeForInternalOperations(java.lang.Boolean value)
          Sets the "invoke-for-internal-operations" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setPluginType(java.util.Collection<PluginCfgDefn.PluginType> values)
          Sets the "plugin-type" property.
 void setProfileAction(ProfilerPluginCfgDefn.ProfileAction value)
          Sets the "profile-action" property.
 void setProfileDirectory(java.lang.String value)
          Sets the "profile-directory" property.
 void setProfileSampleInterval(long value)
          Sets the "profile-sample-interval" property.
 
Methods inherited from interface org.opends.server.admin.std.client.PluginCfgClient
isEnabled, setEnabled
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends ProfilerPluginCfgClient,? extends ProfilerPluginCfg> definition()
Get the configuration definition associated with this Profiler Plugin.

Specified by:
definition in interface ConfigurationClient
Specified by:
definition in interface PluginCfgClient
Returns:
Returns the configuration definition associated with this Profiler Plugin.

isEnableProfilingOnStartup

java.lang.Boolean isEnableProfilingOnStartup()
Gets the "enable-profiling-on-startup" property.

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.

Returns:
Returns the value of the "enable-profiling-on-startup" property.

setEnableProfilingOnStartup

void setEnableProfilingOnStartup(boolean value)
                                 throws IllegalPropertyValueException
Sets the "enable-profiling-on-startup" property.

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.

Parameters:
value - The value of the "enable-profiling-on-startup" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

isInvokeForInternalOperations

boolean isInvokeForInternalOperations()
Gets the "invoke-for-internal-operations" property.

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.

Specified by:
isInvokeForInternalOperations in interface PluginCfgClient
Returns:
Returns the value of the "invoke-for-internal-operations" property.

setInvokeForInternalOperations

void setInvokeForInternalOperations(java.lang.Boolean value)
                                    throws IllegalPropertyValueException
Sets the "invoke-for-internal-operations" property.

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.

Specified by:
setInvokeForInternalOperations in interface PluginCfgClient
Parameters:
value - The value of the "invoke-for-internal-operations" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the plug-in implementation.

Specified by:
getJavaClass in interface PluginCfgClient
Returns:
Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the plug-in implementation.

Specified by:
setJavaClass in interface PluginCfgClient
Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getPluginType

java.util.SortedSet<PluginCfgDefn.PluginType> getPluginType()
Gets the "plugin-type" property.

Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.

Specified by:
getPluginType in interface PluginCfgClient
Returns:
Returns the values of the "plugin-type" property.

setPluginType

void setPluginType(java.util.Collection<PluginCfgDefn.PluginType> values)
                   throws IllegalPropertyValueException
Sets the "plugin-type" property.

Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.

Specified by:
setPluginType in interface PluginCfgClient
Parameters:
values - The values of the "plugin-type" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.

getProfileAction

ProfilerPluginCfgDefn.ProfileAction getProfileAction()
Gets the "profile-action" property.

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.

Returns:
Returns the value of the "profile-action" property.

setProfileAction

void setProfileAction(ProfilerPluginCfgDefn.ProfileAction value)
                      throws IllegalPropertyValueException
Sets the "profile-action" property.

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.

Parameters:
value - The value of the "profile-action" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getProfileDirectory

java.lang.String getProfileDirectory()
Gets the "profile-directory" property.

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.

Returns:
Returns the value of the "profile-directory" property.

setProfileDirectory

void setProfileDirectory(java.lang.String value)
                         throws IllegalPropertyValueException
Sets the "profile-directory" property.

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.

Parameters:
value - The value of the "profile-directory" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getProfileSampleInterval

java.lang.Long getProfileSampleInterval()
Gets the "profile-sample-interval" property.

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.

Returns:
Returns the value of the "profile-sample-interval" property.

setProfileSampleInterval

void setProfileSampleInterval(long value)
                              throws IllegalPropertyValueException
Sets the "profile-sample-interval" property.

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.

Parameters:
value - The value of the "profile-sample-interval" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.