Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.2)

Part Number E27170-01
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

weblogic.management.runtime
Interface WLDFImageRuntimeMBean

All Superinterfaces:
DynamicMBean, MBeanRegistration, NotificationBroadcaster, RuntimeMBean, WebLogicMBean
public interface WLDFImageRuntimeMBean
extends RuntimeMBean

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

Method Summary
 WLDFImageCreationTaskRuntimeMBean captureImage()
          Creates a diagnostic image in the configured destination directory.
 WLDFImageCreationTaskRuntimeMBean captureImage(int lockoutMinutes)
          Creates a diagnostic image in the configured destination directory.
 WLDFImageCreationTaskRuntimeMBean captureImage(String destination)
          Creates a diagnostic image in the specified destination directory, which can be specified either as a relative or absolute pathname.
 WLDFImageCreationTaskRuntimeMBean captureImage(String destination, int lockoutMinutes)
          Creates a diagnostic image in the specified destination directory, which can be specified either as a relative or absolute pathname.
 void clearCompletedImageCaptureTasks()
          Removes all completed image capture tasks.
 WLDFImageCreationTaskRuntimeMBean[] listImageCaptureTasks()
          The list of all initiated image capture tasks.
 void resetImageLockout()
          Reset the lockout period, thus allowing image capture requests to be accepted.
 
Methods inherited from interface weblogic.management.WebLogicMBean
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent
 
Methods inherited from interface javax.management.DynamicMBean
getAttribute, getAttributes, invoke, setAttribute, setAttributes
 
Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister
 
Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener
 

Method Detail

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(String destination)
                                               throws ManagementException

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.

Parameters:
destination - absolute or relative directory path
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

captureImage

WLDFImageCreationTaskRuntimeMBean captureImage(String destination,
                                               int lockoutMinutes)
                                               throws ManagementException

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.

Parameters:
destination - absolute or relative path
lockoutMinutes - number of minutes before next image capture request will be accepted
Returns:
TaskRuntimeMBean instance to watch the progress of this image capture
Throws:
ManagementException

listImageCaptureTasks

WLDFImageCreationTaskRuntimeMBean[] listImageCaptureTasks()

The list of all initiated image capture tasks.

Returns:
a list of all pending or completed image capture tasks.

clearCompletedImageCaptureTasks

void clearCompletedImageCaptureTasks()

Removes all completed image capture tasks.

resetImageLockout

void resetImageLockout()

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

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Copyright 1996, 2013, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.2)

Part Number E27170-01
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD