WLDFImageRuntimeMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This interface controls diagnostic image creation, and provides access to run-time information about past and current diagnostic image capture requests.

       
Since9.0.0.0
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.runtime.WLDFImageRuntimeMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points You can access this MBean from the following MBean attributes:
    Access Points Inherited from RuntimeMBean Because this MBean extends or implements RuntimeMBean, you can also access this MBean by retrieving RuntimeMBeans. The following attributes contain RuntimeMBeans and its subtypes:
    Access Points Inherited from WLDFPartitionImageRuntimeMBean Because this MBean extends or implements WLDFPartitionImageRuntimeMBean, you can also access this MBean by retrieving WLDFPartitionImageRuntimeMBeans. The following attributes contain WLDFPartitionImageRuntimeMBeans and its subtypes:


      Related MBeans

      This section describes attributes that provide access to other MBeans.


        ImageCaptureTasks

        The list of all initiated image capture tasks.

                   
        Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
        Lookup OperationlookupImageCaptureTask(String name)

        Returns a javax.management.ObjectName for the instance of WLDFImageCreationTaskRuntimeMBean named name.

        Privileges Read only
        TypeWLDFImageCreationTaskRuntimeMBean[]
        Relationship type: Containment.


        Attributes

        This section describes the following attributes:


        AvailableCapturedImages

        Returns a list of captured images that are available on the Server.

               
        Privileges Read only
        Typeclass java.lang.String[]

        CachingDisabled

        Private property that disables caching in proxies.

        This attribute is not dynamic and requires a server restart to take effect.

               
        Privileges Read only
        Typeboolean

        ImageDir

        The default directory where the server stores captured diagnostic images.

               
        Privileges Read only
        Typejava.lang.String

        ImageTimeout

        The default timeout period, in minutes, that the server uses to delay future diagnostic image-capture requests.

               
        Privileges Read only
        Typeint

        MBeanInfo

        Returns the MBean info for this MBean.

        This attribute is not dynamic and requires a server restart to take effect.

        Deprecated.

               
        Privileges Read only
        Typejavax.management.MBeanInfo

        Name

        The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

               
        Privileges Read only
        Typejava.lang.String

        ObjectName

        Returns the ObjectName under which this MBean is registered in the MBean server.

        This attribute is not dynamic and requires a server restart to take effect.

        Deprecated.

               
        Privileges Read only
        Typeweblogic.management.WebLogicObjectName

        Parent

        Return the immediate parent for this MBean

        This attribute is not dynamic and requires a server restart to take effect.

               
        Privileges Read/Write
        Type

        Registered

        Returns false if the MBean represented by this object has been unregistered.

        This attribute is not dynamic and requires a server restart to take effect.

        Deprecated.

               
        Privileges Read only
        Typeboolean

        Type

        Returns the type of the MBean.

        This attribute is not dynamic and requires a server restart to take effect.

               
        Privileges Read only
        Typejava.lang.String


        Operations

        This section describes the following operations:


        captureImage

        Creates a diagnostic image in the specified destination directory, which can be specified either as a relative or absolute pathname. If relative, the path is relative to the server's logs directory.

        If the directory does not exist, it is created. If the directory exists, it must be writable in order for image creation to proceed.

           
        Operation Name"captureImage"
        ParametersObject [] {  destination }

        where:

        • destination is an object of type java.lang.String that specifies:

          absolute or relative directory path

        SignatureString [] { "java.lang.String" }
        ReturnsWLDFImageCreationTaskRuntimeMBean
        Exceptions
        • weblogic.management.ManagementException

        captureImage

        Creates a diagnostic image in the configured destination directory.

        No additional image capture requests will be accepted until the configured lockout period has expired.

        For more information, see:

           
        Operation Name"captureImage"
        Parametersnull
        Signaturenull
        ReturnsWLDFImageCreationTaskRuntimeMBean
        Exceptions
        • weblogic.management.ManagementException

        captureImage

        Creates a diagnostic image in the specified destination directory, which can be specified either as a relative or absolute pathname. If relative, the path is relative to the server's logs directory.

        If the directory does not exist, it is created. If the directory exists, it must be writable in order for image creation to proceed.

        No additional image capture requests will be accepted until the specified lockout period has expired.

           
        Operation Name"captureImage"
        ParametersObject [] {  destinationlockoutMinutes }

        where:

        • destination is an object of type java.lang.String that specifies:

          absolute or relative path

        • lockoutMinutes is an object of type java.lang.Integer that specifies:

          number of minutes before next image capture request will be accepted

        SignatureString [] { "java.lang.String", "java.lang.Integer" }
        ReturnsWLDFImageCreationTaskRuntimeMBean
        Exceptions
        • weblogic.management.ManagementException

        captureImage

        Creates a diagnostic image in the configured destination directory.

        No additional image capture requests will be accepted until the specified lockout period has expired.

           
        Operation Name"captureImage"
        ParametersObject [] {  lockoutMinutes }

        where:

        • lockoutMinutes is an object of type java.lang.Integer that specifies:

          number of minutes before the next image capture request will be accepted

        SignatureString [] { "java.lang.Integer" }
        ReturnsWLDFImageCreationTaskRuntimeMBean
        Exceptions
        • weblogic.management.ManagementException

        clearCompletedImageCaptureTasks

        Removes all completed image capture tasks.

           
        Operation Name"clearCompletedImageCaptureTasks"
        Parametersnull
        Signaturenull
        Returns void

        listImageCaptureTasks

        The list of all initiated image capture tasks.

        Deprecated. Please use getImageCaptureTasks

           
        Operation Name"listImageCaptureTasks"
        Parametersnull
        Signaturenull
        Returns class

        lookupImageCaptureTask

        Lookup image capture task by name.

           
        Operation Name"lookupImageCaptureTask"
        ParametersObject [] {  name }

        where:

        • name is an object of type java.lang.String that specifies:

          Name of the image capture task to lookup

        SignatureString [] { "java.lang.String" }
        ReturnsWLDFImageCreationTaskRuntimeMBean

        purgeCapturedImages

        Delete captured images specified by the age criteria.

           
        Operation Name"purgeCapturedImages"
        ParametersObject [] {  age }

        where:

        • age is an object of type java.lang.String that specifies:

          Purge diagnostic images older than specified age specified in the format Days:Hours:Minutes. If empty or null all existing image files on disk are purged. The hours and minutes components are optional.

        SignatureString [] { "java.lang.String" }
        Returns void

        resetImageLockout

        Reset the lockout period, thus allowing image capture requests to be accepted.

           
        Operation Name"resetImageLockout"
        Parametersnull
        Signaturenull
        Returns void