Package org.forgerock.opendj.server.config.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 OpenDJ directory server is running.

    • Method Detail

      • isEnableProfilingOnStartup

        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 PropertyException
        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:
        PropertyException - 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​(Boolean value)
                             throws PropertyException
        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:
        PropertyException - If the new value is invalid.

      • getJavaClass

        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​(String value)
           throws PropertyException
        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:
        PropertyException - If the new value is invalid.

      • getPluginType

        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.

      • 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 PropertyException
        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:
        PropertyException - If the new value is invalid.

      • getProfileDirectory

        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 OpenDJ 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​(String value)
                  throws PropertyException
        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 OpenDJ 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:
        PropertyException - If the new value is invalid.

      • getProfileSampleInterval

        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 PropertyException
        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:
        PropertyException - If the new value is invalid.