Skip navigation links

weblogic.management.runtime
Interface WLDFPartitionImageRuntimeMBean

All Superinterfaces:

DynamicMBean, MBeanRegistration, NotificationBroadcaster, RuntimeMBean, WebLogicMBean

All Known Subinterfaces:

WLDFImageRuntimeMBean

public interface WLDFPartitionImageRuntimeMBean

extends RuntimeMBean

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

Since:

9.0.0.0

captureImage

WLDFImageCreationTaskRuntimeMBean captureImage()
                                               throws ManagementException

Creates a diagnostic image in the configured destination directory.

Returns:

TaskRuntimeMBean instance to watch the progress of this image capture

Throws:

ManagementException

captureImage

WLDFImageCreationTaskRuntimeMBean captureImage(int lockoutMinutes)
                                               throws ManagementException

Creates a diagnostic image in the configured destination directory.

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

Parameters:

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

Returns:

TaskRuntimeMBean instance to watch the progress of this image capture

Throws:

ManagementException

listImageCaptureTasks

WLDFImageCreationTaskRuntimeMBean[] listImageCaptureTasks()

Deprecated. Please use getImageCaptureTasks

The list of all initiated image capture tasks.

Returns:

a list of all pending or completed image capture tasks.

getImageCaptureTasks

WLDFImageCreationTaskRuntimeMBean[] getImageCaptureTasks()

The list of all initiated image capture tasks.

Returns:

a list of all pending or completed image capture tasks.

lookupImageCaptureTask

WLDFImageCreationTaskRuntimeMBean lookupImageCaptureTask(String name)

Lookup image capture task by name.

Parameters:

name - Name of the image capture task to lookup

Returns:

image capture task or null if none found by that name

clearCompletedImageCaptureTasks

void clearCompletedImageCaptureTasks()

Removes all completed image capture tasks.

resetImageLockout

void resetImageLockout()

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

getAvailableCapturedImages

String[] getAvailableCapturedImages()

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

purgeCapturedImages

void purgeCapturedImages(String age)

Delete captured images specified by the age criteria.

Parameters:

age - 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.

getImageDir

String getImageDir()

The default directory where the server stores captured diagnostic images.

Returns:

the relative or absolute directory where the diagnostic images captured are stored

getImageTimeout

int getImageTimeout()

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

Returns:

the timeout in minutes

Skip navigation links