WLDFServerDiagnosticMBean (Java API Reference for Oracle WebLogic Server)

All Superinterfaces:

ConfigurationMBean, DescriptorBean, javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, SettableBean, WebLogicMBean
```
public interface WLDFServerDiagnosticMBean
extends ConfigurationMBean
```
Use this interface to configure the WebLogic Diagnostic Framework (WLDF) components that are defined for each WebLogic Server instance.

Field Summary

Fields
Modifier and Type	Field	Description
`static long`	`DEFAULT_EVENTS_IMAGE_CAPTURE_INTERVAL`	The default time interval, 60 seconds, used when capturing recent diagnostic image events.
`static java.lang.String`	`FILE_STORE_ARCHIVE_TYPE`	The file store type of archive.
`static java.lang.String`	`HIGH_VOLUME`
`static java.lang.String`	`JDBC_ARCHIVE_TYPE`	The JDBC type of archive.
`static java.lang.String`	`LOW_VOLUME`
`static java.lang.String`	`MEDIUM_VOLUME`
`static java.lang.String`	`OFF_VOLUME`

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`WLDFDataRetirementByAgeMBean`	`createWLDFDataRetirementByAge(java.lang.String name)`	Factory to create WLDFDataRetirement instance corresponding to a WLDF archive
`void`	`destroyWLDFDataRetirementByAge(WLDFDataRetirementByAgeMBean wldfDataRetirement)`	Deletes WLDFDataRetirementByAgeMBean object
`java.lang.String`	`getDiagnosticDataArchiveType()`	Determines whether the current server persists its harvested metrics and event data in a diagnostic store (file-based store) or a JDBC based archive.
`java.lang.String`	`getDiagnosticDumpsDir()`	Directory where heap and thread dumps will be generated by actions.
`JDBCSystemResourceMBean`	`getDiagnosticJDBCResource()`	The JDBC data source that the server uses to archive its harvested metrics and event data.
`java.lang.String`	`getDiagnosticJDBCSchemaName()`	The schema name to use for accessing JDBC-based archive tables.
`int`	`getDiagnosticStoreBlockSize()`	The smallest addressable block, in bytes, of a file.
`java.lang.String`	`getDiagnosticStoreDir()`	The directory in which the current server maintains its diagnostic store.
`int`	`getDiagnosticStoreIoBufferSize()`	The I/O buffer size, in bytes, automatically rounded down to the nearest power of 2, controls the largest write size.
`long`	`getDiagnosticStoreMaxFileSize()`	The maximum file size, in bytes.
`int`	`getDiagnosticStoreMaxWindowBufferSize()`	The maximum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per diagnostic store file.
`int`	`getDiagnosticStoreMinWindowBufferSize()`	The minimum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per diagnostic store file.
`long`	`getEventPersistenceInterval()`	The interval, in milliseconds, at which queued up instrumentation events will be periodically dispatched to the archive.
`long`	`getEventsImageCaptureInterval()`	The time span, in milliseconds, for which recently archived events will be captured in the diagnostic image.
`java.lang.String`	`getImageDir()`	The default directory where the server stores captured diagnostic images.
`int`	`getImageTimeout()`	The default timeout period, in minutes, that the server uses to delay future diagnostic image-capture requests.
`int`	`getMaxHeapDumpCount()`	Returns the maximum number of heap dump files to be retained which are generated by heap dump actions.
`int`	`getMaxThreadDumpCount()`	Returns the maximum number of thread dump files to be retained which are generated by thread dump actions.
`int`	`getPreferredStoreSizeLimit()`	Return the preferred limit on the size of diagnostic store file in MB.
`int`	`getStoreSizeCheckPeriod()`	Return the period in hours at which diagnostic store file size check will be performed
`WLDFResourceBean`	`getWLDFBuiltinSystemResourceDescriptorBean()`
`java.lang.String`	`getWLDFBuiltinSystemResourceType()`	This attribute specifies the WLDF built-in system resource type in use for this server.
`WLDFBuiltinWatchConfigurationMBean`	`getWLDFBuiltinWatchConfiguration()`	If set, to enable or disable Stuck Thread Watch and Notifications in WLDF Builtin System Resource.
`WLDFDataRetirementByAgeMBean[]`	`getWLDFDataRetirementByAges()`	Return the WLDFDataRetirementByAgeMBeans parented by this WLDFServerDiagnosticMBean.
`WLDFDataRetirementMBean[]`	`getWLDFDataRetirements()`	Return the WLDFDataRetirementMBeans parented by this WLDFServerDiagnosticMBean.
`java.lang.String`	`getWLDFDiagnosticVolume()`	Specifies the volume of diagnostic data that is automatically produced by WebLogic Server at run time.
`boolean`	`isDataRetirementEnabled()`	This attribute controls if configuration based data retirement functionality is enabled on the server.
`boolean`	`isDiagnosticContextEnabled()`	Deprecated. 12.2.1.0.0 Defaults to enabled now
`boolean`	`isDiagnosticStoreFileLockingEnabled()`	Determines whether OS file locking is used.
`boolean`	`isSynchronousEventPersistenceEnabled()`	Specifies the instrumentation events persistence policy.
`WLDFDataRetirementMBean`	`lookupWLDFDataRetirement(java.lang.String name)`	Look up WLDFDataRetirement object with given name
`WLDFDataRetirementByAgeMBean`	`lookupWLDFDataRetirementByAge(java.lang.String name)`	Look up WLDFDataRetirementByAgeMBean object with given name
`void`	`setDataRetirementEnabled(boolean enabled)`	Enables or disabled the data retirement functionality on this server.
`void`	`setDataRetirementTestModeEnabled(boolean enabled)`
`void`	`setDiagnosticContextEnabled(boolean enable)`	Deprecated. 12.2.1.0.0 Defaults to enabled now
`void`	`setDiagnosticDataArchiveType(java.lang.String archiveType)`	Sets the value of the DiagnosticDataArchiveType attribute.
`void`	`setDiagnosticDumpsDir(java.lang.String dirPath)`	Sets the value of the DiagnosticDumpsDir attribute.
`void`	`setDiagnosticJDBCResource(JDBCSystemResourceMBean diagnosticJDBCResource)`	Sets the value of the DiagnosticJDBCResource attribute.
`void`	`setDiagnosticJDBCSchemaName(java.lang.String schemaName)`	The schema name to use for accessing JDBC-based archive tables.
`void`	`setDiagnosticStoreBlockSize(int diagnosticStoreBlockSize)`	See GenericFileStoreMBean.setBlockSize.
`void`	`setDiagnosticStoreDir(java.lang.String diagnosticStoreDir)`	Sets the value of the DiagnosticStoreDir attribute.
`void`	`setDiagnosticStoreFileLockingEnabled(boolean diagnosticStoreFileLockingEnabled)`	See GenericFileStoreMBean.setFileLockingEnabled.
`void`	`setDiagnosticStoreIoBufferSize(int diagnosticStoreIoBufferSize)`	See GenericFileStoreMBean.IoBufferSize.
`void`	`setDiagnosticStoreMaxFileSize(long diagnosticStoreMaxFileSize)`	See GenericFileStoreMBean.setMaxFileSize.
`void`	`setDiagnosticStoreMaxWindowBufferSize(int diagnosticStoreMaxWindowBufferSize)`	See GenericFileStoreMBean.setMaxWindowBufferSize.
`void`	`setDiagnosticStoreMinWindowBufferSize(int diagnosticStoreMinWindowBufferSize)`	See GenericFileStoreMBean.setMinWindowBufferSize.
`void`	`setEventPersistenceInterval(long interval)`	Sets the value of the EventPersistenceInterval attribute.
`void`	`setEventsImageCaptureInterval(long interval)`	Sets the value of the EventsImageCaptureInterval attribute.
`void`	`setImageDir(java.lang.String dirPath)`	Sets the value of the ImageDir attribute.
`void`	`setImageTimeout(int timeout)`	Sets the value of the ImageTimeout attribute.
`void`	`setMaxHeapDumpCount(int maxHeapDumps)`	Sets the maxHeapDumps MaxHeapDumpCount attribute
`void`	`setMaxThreadDumpCount(int maxThreadDumps)`	Sets the MaxThreadDumpCount attribute
`void`	`setPreferredStoreSizeLimit(int preferredStoreSizeLimit)`	Sets preferredStoreSizeLimit attributes
`void`	`setStoreSizeCheckPeriod(int storeSizeCheckPeriod)`	Sets storeSizeCheckPeriod attribute
`void`	`setSynchronousEventPersistenceEnabled(boolean enable)`	Sets the value of the SynchronousEventPersistenceEnabled attribute.
`void`	`setWLDFBuiltinSystemResourceType(java.lang.String profile)`	Sets the built-in system resource type for this server
`void`	`setWLDFDiagnosticVolume(java.lang.String volume)`	Specifies the volume of diagnostic data that is automatically produced by WebLogic Server at run time.

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet

Methods inherited from interface weblogic.descriptor.DescriptorBean
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

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

Methods inherited from interface weblogic.management.WebLogicMBean
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent

- Field Detail
  - FILE_STORE_ARCHIVE_TYPE
```
static final java.lang.String FILE_STORE_ARCHIVE_TYPE
```
    The file store type of archive.
    
    See Also:
    
    Constant Field Values
  - JDBC_ARCHIVE_TYPE
```
static final java.lang.String JDBC_ARCHIVE_TYPE
```
    The JDBC type of archive.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_EVENTS_IMAGE_CAPTURE_INTERVAL
```
static final long DEFAULT_EVENTS_IMAGE_CAPTURE_INTERVAL
```
    The default time interval, 60 seconds, used when capturing recent diagnostic image events.
    
    See Also:
    
    Constant Field Values
  - OFF_VOLUME
```
static final java.lang.String OFF_VOLUME
```
    See Also:
    
    Constant Field Values
  - LOW_VOLUME
```
static final java.lang.String LOW_VOLUME
```
    See Also:
    
    Constant Field Values
  - MEDIUM_VOLUME
```
static final java.lang.String MEDIUM_VOLUME
```
    See Also:
    
    Constant Field Values
  - HIGH_VOLUME
```
static final java.lang.String HIGH_VOLUME
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getImageDir
```
java.lang.String getImageDir()
```
    The default directory where the server stores captured diagnostic images.
    
    If you specify a relative pathname, the root of that path is the server's root directory.
    
    If the directory does not exist, it will be created when the WebLogic Diagnostic Framework is initialized on the server. Note that each image capture request can override this default directory location.
    
    Returns:
    
    the relative or absolute directory where the diagnostic images captured are stored
    
    See Also:
    
    WLDFImageRuntimeMBean
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - setImageDir
```
void setImageDir(java.lang.String dirPath)
```
    Sets the value of the ImageDir attribute.
    
    Parameters:
    
    dirPath - The path where the images will be stored.
    
    See Also:
    
    getImageDir()
  - 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
    
    Default Value:
    
    1
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Maximum Value:
    
    1440
    
    Minimum Value:
    
    0
  - setImageTimeout
```
void setImageTimeout(int timeout)
```
    Sets the value of the ImageTimeout attribute.
    
    Parameters:
    
    timeout - in minutes
    
    See Also:
    
    getImageTimeout()
  - getEventsImageCaptureInterval
```
long getEventsImageCaptureInterval()
```
    The time span, in milliseconds, for which recently archived events will be captured in the diagnostic image. All events archived on or after ( System.currentTimeMillis() - interval ) will be captured.
    
    Returns:
    
    the length of the interval in milliseconds
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - setEventsImageCaptureInterval
```
void setEventsImageCaptureInterval(long interval)
```
    Sets the value of the EventsImageCaptureInterval attribute.
    
    Parameters:
    
    interval - The length of the interval in milliseconds
    
    See Also:
    
    getEventsImageCaptureInterval()
    
    Default Value:
    
    WLDFServerDiagnosticMBean.DEFAULT_EVENTS_IMAGE_CAPTURE_INTERVAL
  - getDiagnosticStoreDir
```
java.lang.String getDiagnosticStoreDir()
```
    The directory in which the current server maintains its diagnostic store.
    
    Returns:
    
    Directory path for diagnostic store
    
    See Also:
    
    getDiagnosticDataArchiveType()
    
    Default Value:
    
    weblogic.management.configuration.WLDFServerDiagnosticMBean.DEFAULT_STORE_DIR
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
  - setDiagnosticStoreDir
```
void setDiagnosticStoreDir(java.lang.String diagnosticStoreDir)
```
    Sets the value of the DiagnosticStoreDir attribute.
    
    Parameters:
    
    diagnosticStoreDir - Directory path for diagnostic store
    
    See Also:
    
    getDiagnosticStoreDir()
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
  - isDiagnosticStoreFileLockingEnabled
```
boolean isDiagnosticStoreFileLockingEnabled()
```
    Determines whether OS file locking is used.
    When file locking protection is enabled, a store boot fails if another store instance already has opened the store files. Do not disable this setting unless you have procedures in place to prevent multiple store instances from opening the same file. File locking is not required but helps prevent corruption in the event that two same-named file store instances attempt to operate in the same directories. This setting applies to both primary and cache files.
    
    Returns:
    
    DiagnosticStoreFileLockingEnabled value
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
  - setDiagnosticStoreFileLockingEnabled
```
void setDiagnosticStoreFileLockingEnabled(boolean diagnosticStoreFileLockingEnabled)
```
    See GenericFileStoreMBean.setFileLockingEnabled.
    
    Parameters:
    
    diagnosticStoreFileLockingEnabled - The new FileLockingEnabled value
    
    Default Value:
    
    false
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
  - getDiagnosticStoreMinWindowBufferSize
```
int getDiagnosticStoreMinWindowBufferSize()
```
    The minimum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per diagnostic store file. Applies only when a native wlfileio library is loaded. See Diagnostic Store Maximum Window Buffer Size.
    
    Returns:
    
    The DiagnosticStoreMinWindowBufferSize value
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
  - setDiagnosticStoreMinWindowBufferSize
```
void setDiagnosticStoreMinWindowBufferSize(int diagnosticStoreMinWindowBufferSize)
```
    See GenericFileStoreMBean.setMinWindowBufferSize.
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    Default Value:
    
    -1
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
    
    Maximum Value:
    
    1073741824
    
    Minimum Value:
    
    -1
  - getDiagnosticStoreMaxWindowBufferSize
```
int getDiagnosticStoreMaxWindowBufferSize()
```
    The maximum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per diagnostic store file. Applies only when a native wlfileio library is loaded.
    
    A window buffer does not consume Java heap memory, but does consume off-heap (native) memory. If the store is unable to allocate the requested buffer size, it allocates smaller and smaller buffers until it reaches DiagnosticStoreMinWindowBufferSize, and then fails if it cannot honor DiagnosticStoreMinWindowBufferSize.
    
    Oracle recommends setting the max window buffer size to more than double the size of the largest write (multiple concurrently updated records may be combined into a single write), and greater than or equal to the file size, unless there are other constraints. 32-bit JVMs may impose a total limit of between 2 and 4GB for combined Java heap plus off-heap (native) memory usage.
    
    Returns:
    
    The DiagnosticStoreMaxWindowBufferSize value
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
  - setDiagnosticStoreMaxWindowBufferSize
```
void setDiagnosticStoreMaxWindowBufferSize(int diagnosticStoreMaxWindowBufferSize)
```
    See GenericFileStoreMBean.setMaxWindowBufferSize.
    
    Parameters:
    
    diagnosticStoreMaxWindowBufferSize - The new DiagnosticStoreMaxWindowBufferSize value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    Default Value:
    
    4194304
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
    
    Maximum Value:
    
    1073741824
    
    Minimum Value:
    
    -1
  - getDiagnosticStoreIoBufferSize
```
int getDiagnosticStoreIoBufferSize()
```
    The I/O buffer size, in bytes, automatically rounded down to the nearest power of 2, controls the largest write size.
    - When a native wlfileio driver is available, the setting applies to off-heap (native) memory.
    - When a native wlfileio driver is not available, the setting applies to JAVA heap memory.
    - For the best runtime performance, Oracle recommends setting DiagnosticStoreIOBufferSize so that it is larger than the largest write (multiple concurrent store requests may be combined into a single write).
    - See AllocatedIOBufferBytes to find out the actual allocated off-heap (native) memory amount. It is a multiple of IOBufferSize
    Returns:
    
    The DiagnosticStoreIoBufferSize value
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
  - setDiagnosticStoreIoBufferSize
```
void setDiagnosticStoreIoBufferSize(int diagnosticStoreIoBufferSize)
```
    See GenericFileStoreMBean.IoBufferSize.
    
    Parameters:
    
    diagnosticStoreIoBufferSize - The new DiagnosticStoreIOBufferSize value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    Default Value:
    
    -1
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
    
    Maximum Value:
    
    67108864
    
    Minimum Value:
    
    -1
  - getDiagnosticStoreMaxFileSize
```
long getDiagnosticStoreMaxFileSize()
```
    The maximum file size, in bytes.
    - The DiagnosticStoreMaxFileSize value affects the number of files needed to accommodate a diagnostic store of a particular size (number of files = diagnostic store size/MaxFileSize rounded up).
    - A diagnostic store automatically reuses space freed by deleted records and automatically expands individual files up to DiagnosticStoreMaxFileSize if there is not enough space for a new record. If there is no space left in exiting files for a new record, a diagnostic store creates an additional file.
    - A small number of larger files is normally preferred over a large number of smaller files as each file allocates Window Buffer and file handles.
    - If DiagnosticStoreMaxFileSize is larger than 2^24 * DiagnosticStoreBlockSize, then DiagnosticStoreMaxFileSize is ignored, and the value becomes 2^24 * DiagnosticStoreBlockSize. The default DiagnosticStoreBlockSize is 512, and 2^24 * 512 is 8 GB.
    Oracle recommends not setting the Diagnostic Store Max File Size above the default value of 1,342,177,280.
    Returns:
    
    The DiagnosticStoreMaxFileSize value
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
  - setDiagnosticStoreMaxFileSize
```
void setDiagnosticStoreMaxFileSize(long diagnosticStoreMaxFileSize)
```
    See GenericFileStoreMBean.setMaxFileSize.
    
    Parameters:
    
    diagnosticStoreMaxFileSize - The new DiagnosticStoreMaxFileSize value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    Default Value:
    
    1342177280
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
    
    Minimum Value:
    
    10485760
  - getDiagnosticStoreBlockSize
```
int getDiagnosticStoreBlockSize()
```
    The smallest addressable block, in bytes, of a file. When a native wlfileio driver is available and the block size has not been configured by the user, the store selects the minimum OS specific value for unbuffered (direct) I/O, if it is within the range [512, 8192].
    A file store's block size does not change once the file store creates its files. Changes to block size only take effect for new file stores or after the current files have been deleted. See "Tuning the Persistent Store" in Performance and Tuning for Oracle WebLogic Server.
    
    Returns:
    
    The DiagnosticStoreBlockSize value
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
  - setDiagnosticStoreBlockSize
```
void setDiagnosticStoreBlockSize(int diagnosticStoreBlockSize)
```
    See GenericFileStoreMBean.setBlockSize.
    
    Parameters:
    
    diagnosticStoreBlockSize - The new DiagnosticStoreBlockSize value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    Default Value:
    
    -1
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
    
    Maximum Value:
    
    8192
    
    Minimum Value:
    
    -1
  - getDiagnosticDataArchiveType
```
java.lang.String getDiagnosticDataArchiveType()
```
    Determines whether the current server persists its harvested metrics and event data in a diagnostic store (file-based store) or a JDBC based archive. The default store is file-based.
    
    Returns:
    
    the diagnostic data archive type, file-based or JDBC based
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
  - setDiagnosticDataArchiveType
```
void setDiagnosticDataArchiveType(java.lang.String archiveType)
```
    Sets the value of the DiagnosticDataArchiveType attribute.
    
    Parameters:
    
    archiveType - the diagnostic data archive type
    
    See Also:
    
    getDiagnosticDataArchiveType()
    
    Default Value:
    
    WLDFServerDiagnosticMBean.FILE_STORE_ARCHIVE_TYPE
    
    Valid Values:
    
    WLDFServerDiagnosticMBean.FILE_STORE_ARCHIVE_TYPE, WLDFServerDiagnosticMBean.JDBC_ARCHIVE_TYPE
  - getDiagnosticJDBCResource
```
JDBCSystemResourceMBean getDiagnosticJDBCResource()
```
    The JDBC data source that the server uses to archive its harvested metrics and event data.
    
    Returns:
    
    the JDBC data source
    
    See Also:
    
    getDiagnosticDataArchiveType()
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
  - setDiagnosticJDBCResource
```
void setDiagnosticJDBCResource(JDBCSystemResourceMBean diagnosticJDBCResource)
```
    Sets the value of the DiagnosticJDBCResource attribute.
    
    Parameters:
    
    diagnosticJDBCResource - the JDBC data source
    
    See Also:
    
    getDiagnosticJDBCResource()
  - getDiagnosticJDBCSchemaName
```
java.lang.String getDiagnosticJDBCSchemaName()
```
    The schema name to use for accessing JDBC-based archive tables.
    
    If multiple WLDF JDBC archive schemas exist in the same database, this value specifies the correct schema to use for accessing JDBC-based archive tables in that database.
    
    There is no default value. If a schema name is not specified, no schema name is applied when WLDF validates the run-time table or is used for the SQL statements.
    
    Returns:
    
    The schema name to use with the JDBC connection
    
    See Also:
    
    getDiagnosticDataArchiveType()
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
  - setDiagnosticJDBCSchemaName
```
void setDiagnosticJDBCSchemaName(java.lang.String schemaName)
```
    The schema name to use for accessing JDBC-based archive tables.
    
    If multiple WLDF JDBC archive schemas exist in the same database, this value specifies the correct schema to use for accessing JDBC-based archive tables in that database.
    
    There is no default value. If a schema name is not specified, no schema name is applied when WLDF validates the run-time table or is used for the SQL statements.
    
    Parameters:
    
    schemaName - The name to use for the schema associated JDBC data source connection
    
    See Also:
    
    getDiagnosticJDBCSchemaName()
  - isSynchronousEventPersistenceEnabled
```
boolean isSynchronousEventPersistenceEnabled()
```
    Specifies the instrumentation events persistence policy. If true, events will be persisted synchronously within the same thread. If false, events will be queued up to be persisted in a separate thread.
    
    Returns:
    
    True, if instrumentation events will be persisted synchronously
  - setSynchronousEventPersistenceEnabled
```
void setSynchronousEventPersistenceEnabled(boolean enable)
```
    Sets the value of the SynchronousEventPersistenceEnabled attribute.
    
    Parameters:
    
    enable - If true, persist instrumentation events synchronously.
    
    See Also:
    
    isSynchronousEventPersistenceEnabled()
    
    Default Value:
    
    false
  - getEventPersistenceInterval
```
long getEventPersistenceInterval()
```
    The interval, in milliseconds, at which queued up instrumentation events will be periodically dispatched to the archive.
    
    Returns:
    
    Event persistence interval in milliseconds
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - setEventPersistenceInterval
```
void setEventPersistenceInterval(long interval)
```
    Sets the value of the EventPersistenceInterval attribute.
    
    Parameters:
    
    interval - Event persistence interval in milliseconds
    
    See Also:
    
    getEventPersistenceInterval()
    
    Default Value:
    
    5000
  - isDiagnosticContextEnabled
```
@Deprecated
boolean isDiagnosticContextEnabled()
```
    Deprecated.
    12.2.1.0.0 Defaults to enabled now
    
    If true, diagnostic context creation is enabled. If false, the diagnostic context will not be created when requested. However, if the diagnostics context already exists because it was propagated from another VM or was created through the DyeInjection monitor, the context will be made available.
    
    Returns:
    
    If true, diagnostic context will be created when asked for.
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - setDiagnosticContextEnabled
```
@Deprecated
void setDiagnosticContextEnabled(boolean enable)
```
    Deprecated.
    12.2.1.0.0 Defaults to enabled now
    
    Sets the value of the DiagnosticContextEnabled attribute.
    
    Parameters:
    
    enable - If true, diagnostic context will be created when asked for.
    
    See Also:
    
    isDiagnosticContextEnabled()
    
    Default Value:
    
    true
  - setDataRetirementTestModeEnabled
```
void setDataRetirementTestModeEnabled(boolean enabled)
```
    Parameters:
    
    enabled -
    
    See Also:
    
    isDataRetirementTestModeEnabled()
  - isDataRetirementEnabled
```
boolean isDataRetirementEnabled()
```
    This attribute controls if configuration based data retirement functionality is enabled on the server. If disabled, all retirement policies will be disabled.
    
    Returns:
    
    True if data retirement functionality is enabled on this server
    
    Default Value:
    
    true
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - setDataRetirementEnabled
```
void setDataRetirementEnabled(boolean enabled)
```
    Enables or disabled the data retirement functionality on this server. Actual data retirement will be performed as per configured policies.
    
    Parameters:
    
    enabled - If true, enable data retirement functionality on the server.
    
    See Also:
    
    isDataRetirementEnabled()
  - getPreferredStoreSizeLimit
```
int getPreferredStoreSizeLimit()
```
    Return the preferred limit on the size of diagnostic store file in MB.
    
    Returns:
    
    Preferred limit on the size of diagnostic store file in MB.
    
    Default Value:
    
    100
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Minimum Value:
    
    10
  - setPreferredStoreSizeLimit
```
void setPreferredStoreSizeLimit(int preferredStoreSizeLimit)
```
    Sets preferredStoreSizeLimit attributes
    
    Parameters:
    
    preferredStoreSizeLimit - Preferred size limit of the diagnostic store file in MB.
    
    See Also:
    
    getPreferredStoreSizeLimit()
  - getStoreSizeCheckPeriod
```
int getStoreSizeCheckPeriod()
```
    Return the period in hours at which diagnostic store file size check will be performed
    
    Returns:
    
    Period in hours at which diagnostic store file size check will be performed
    
    Default Value:
    
    1
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Minimum Value:
    
    1
  - setStoreSizeCheckPeriod
```
void setStoreSizeCheckPeriod(int storeSizeCheckPeriod)
```
    Sets storeSizeCheckPeriod attribute
    
    Parameters:
    
    storeSizeCheckPeriod - Period in hours at which diagnostic store file size check will be performed
    
    See Also:
    
    getStoreSizeCheckPeriod()
  - getWLDFDataRetirements
```
WLDFDataRetirementMBean[] getWLDFDataRetirements()
```
    Return the WLDFDataRetirementMBeans parented by this WLDFServerDiagnosticMBean.
  - lookupWLDFDataRetirement
```
WLDFDataRetirementMBean lookupWLDFDataRetirement(java.lang.String name)
```
    Look up WLDFDataRetirement object with given name
    
    Parameters:
    
    name - Name of the data retirement
    
    Returns:
    
    WLDFDataRetirement object
  - getWLDFDataRetirementByAges
```
WLDFDataRetirementByAgeMBean[] getWLDFDataRetirementByAges()
```
    Return the WLDFDataRetirementByAgeMBeans parented by this WLDFServerDiagnosticMBean.
    
    Returns:
    
    The WLDFDataRetirementByAges value
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - createWLDFDataRetirementByAge
```
WLDFDataRetirementByAgeMBean createWLDFDataRetirementByAge(java.lang.String name)
```
    Factory to create WLDFDataRetirement instance corresponding to a WLDF archive
    
    Parameters:
    
    name -
    
    Returns:
    
    WLDFDataRetirementByAgeMBean object
  - destroyWLDFDataRetirementByAge
```
void destroyWLDFDataRetirementByAge(WLDFDataRetirementByAgeMBean wldfDataRetirement)
```
    Deletes WLDFDataRetirementByAgeMBean object
    
    Parameters:
    
    wldfDataRetirement -
  - lookupWLDFDataRetirementByAge
```
WLDFDataRetirementByAgeMBean lookupWLDFDataRetirementByAge(java.lang.String name)
```
    Look up WLDFDataRetirementByAgeMBean object with given name
    
    Parameters:
    
    name -
    
    Returns:
    
    WLDFDataRetirementByAgeMBean object
  - getWLDFDiagnosticVolume
```
java.lang.String getWLDFDiagnosticVolume()
```
    Specifies the volume of diagnostic data that is automatically produced by WebLogic Server at run time. Note that the WLDF diagnostic volume setting does not affect explicitly configured diagnostic modules. For example, this controls the volume of events generated for Flight Recorder.
    
    This attribute has the following settings:
    - Off No diagnostic data is produced.
    - Low Minimal amounts of automatic diagnostic data are produced. This is the default.
    - Medium Additional diagnostic data is automatically generated beyond the amount generated for Low.
    - High Additional diagnostic data is automatically generated beyond the amount generated for Medium.
    Returns:
    
    The diagnostic volume
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - setWLDFDiagnosticVolume
```
void setWLDFDiagnosticVolume(java.lang.String volume)
```
    Specifies the volume of diagnostic data that is automatically produced by WebLogic Server at run time. Note that the WLDF diagnostic volume setting does not affect explicitly configured diagnostic modules. For example, this controls the volume of events generated for Flight Recorder.
    
    This attribute has the following settings:
    - Off No diagnostic data is produced.
    - Low Minimal amounts of automatic diagnostic data are produced. This is the default.
    - Medium Additional diagnostic data is automatically generated beyond the amount generated for Low.
    - High Additional diagnostic data is automatically generated beyond the amount generated for Medium.
    Parameters:
    
    volume - Specifies the diagnostics volume
    
    See Also:
    
    getWLDFDiagnosticVolume()
    
    Default Value:
    
    WLDFServerDiagnosticMBean.LOW_VOLUME
    
    Valid Values:
    
    WLDFServerDiagnosticMBean.OFF_VOLUME, WLDFServerDiagnosticMBean.LOW_VOLUME, WLDFServerDiagnosticMBean.MEDIUM_VOLUME, WLDFServerDiagnosticMBean.HIGH_VOLUME
  - getWLDFBuiltinSystemResourceType
```
java.lang.String getWLDFBuiltinSystemResourceType()
```
    This attribute specifies the WLDF built-in system resource type in use for this server.
    
    This attribute has the following settings:
    - None No WLDF built-in system resource in use.
    - Low The Low WLDF built-in system resource. This is the default.
    - Medium The Medium built-in system resource.
    - High The High built-in system resource.
    Returns:
    
    The WLDF built-in system resource type in use
    
    Default Value:
    
    "None"
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Valid Values:
    
    "None", "Low", "Medium", "High"
    
    Default value in production mode:
    
    "Low"
  - setWLDFBuiltinSystemResourceType
```
void setWLDFBuiltinSystemResourceType(java.lang.String profile)
```
    Sets the built-in system resource type for this server
  - getWLDFBuiltinWatchConfiguration
```
WLDFBuiltinWatchConfigurationMBean getWLDFBuiltinWatchConfiguration()
```
    If set, to enable or disable Stuck Thread Watch and Notifications in WLDF Builtin System Resource.
    
    Returns:
    
    The WLDFBuiltinWatchConfigurationMBean value
  - getWLDFBuiltinSystemResourceDescriptorBean
```
WLDFResourceBean getWLDFBuiltinSystemResourceDescriptorBean()
```
    Returns:
    
    WLDFResourceBean for the built-in system resource.
  - getDiagnosticDumpsDir
```
java.lang.String getDiagnosticDumpsDir()
```
    Directory where heap and thread dumps will be generated by actions. This directory is a relative path with respect to the server directory
    
    Returns:
    
    Directory where heap and thread dumps will be generated by actions
    
    Default Value:
    
    weblogic.management.configuration.WLDFServerDiagnosticMBean.DEFAULT_DUMP_DIR
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - setDiagnosticDumpsDir
```
void setDiagnosticDumpsDir(java.lang.String dirPath)
```
    Sets the value of the DiagnosticDumpsDir attribute.
    
    Parameters:
    
    dirPath - The path where the heap and thread dumps will be created.
    
    See Also:
    
    getDiagnosticDumpsDir()
  - getMaxHeapDumpCount
```
int getMaxHeapDumpCount()
```
    Returns the maximum number of heap dump files to be retained which are generated by heap dump actions. If this limit is reached, oldest heap dumps will be deleted while creating new heap dump so that this limit is not exceeded.
    
    Returns:
    
    Maximum number of heap dumps generated by heap dump actions
    
    Default Value:
    
    8
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Maximum Value:
    
    50
    
    Minimum Value:
    
    1
  - setMaxHeapDumpCount
```
void setMaxHeapDumpCount(int maxHeapDumps)
```
    Sets the maxHeapDumps MaxHeapDumpCount attribute
    
    Parameters:
    
    maxHeapDumps - Maximum number of heap dumps to be retained
    
    See Also:
    
    getMaxHeapDumpCount()
  - getMaxThreadDumpCount
```
int getMaxThreadDumpCount()
```
    Returns the maximum number of thread dump files to be retained which are generated by thread dump actions. If this limit is reached, oldest thread dump files will be deleted while creating new thread dump file so that this limit is not exceeded.
    
    Returns:
    
    Maximum number of thread dumps generated by thread dump actions.
    
    Default Value:
    
    100
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Maximum Value:
    
    1000
    
    Minimum Value:
    
    1
  - setMaxThreadDumpCount
```
void setMaxThreadDumpCount(int maxThreadDumps)
```
    Sets the MaxThreadDumpCount attribute
    
    Parameters:
    
    maxThreadDumps - Maximum number of thread dump files to be retained
    
    See Also:
    
    getMaxThreadDumpCount()

Interface WLDFServerDiagnosticMBean

Field Summary

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean

Method Summary

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

Methods inherited from interface weblogic.descriptor.DescriptorBean

Methods inherited from interface javax.management.DynamicMBean

Methods inherited from interface javax.management.MBeanRegistration

Methods inherited from interface javax.management.NotificationBroadcaster

Methods inherited from interface weblogic.management.WebLogicMBean

Field Detail

FILE_STORE_ARCHIVE_TYPE

JDBC_ARCHIVE_TYPE

DEFAULT_EVENTS_IMAGE_CAPTURE_INTERVAL

OFF_VOLUME

LOW_VOLUME

MEDIUM_VOLUME

HIGH_VOLUME

Method Detail

getImageDir

setImageDir

getImageTimeout

setImageTimeout

getEventsImageCaptureInterval

setEventsImageCaptureInterval

getDiagnosticStoreDir

setDiagnosticStoreDir

isDiagnosticStoreFileLockingEnabled

setDiagnosticStoreFileLockingEnabled

getDiagnosticStoreMinWindowBufferSize

setDiagnosticStoreMinWindowBufferSize

getDiagnosticStoreMaxWindowBufferSize

setDiagnosticStoreMaxWindowBufferSize

getDiagnosticStoreIoBufferSize

setDiagnosticStoreIoBufferSize

getDiagnosticStoreMaxFileSize

setDiagnosticStoreMaxFileSize

getDiagnosticStoreBlockSize

setDiagnosticStoreBlockSize

getDiagnosticDataArchiveType

setDiagnosticDataArchiveType

getDiagnosticJDBCResource

setDiagnosticJDBCResource

getDiagnosticJDBCSchemaName

setDiagnosticJDBCSchemaName

isSynchronousEventPersistenceEnabled

setSynchronousEventPersistenceEnabled

getEventPersistenceInterval

setEventPersistenceInterval

isDiagnosticContextEnabled

setDiagnosticContextEnabled

setDataRetirementTestModeEnabled

isDataRetirementEnabled

setDataRetirementEnabled

getPreferredStoreSizeLimit

setPreferredStoreSizeLimit

getStoreSizeCheckPeriod

setStoreSizeCheckPeriod

getWLDFDataRetirements

lookupWLDFDataRetirement

getWLDFDataRetirementByAges

createWLDFDataRetirementByAge

destroyWLDFDataRetirementByAge

lookupWLDFDataRetirementByAge

getWLDFDiagnosticVolume

setWLDFDiagnosticVolume

getWLDFBuiltinSystemResourceType

setWLDFBuiltinSystemResourceType

getWLDFBuiltinWatchConfiguration

getWLDFBuiltinSystemResourceDescriptorBean

getDiagnosticDumpsDir

setDiagnosticDumpsDir

getMaxHeapDumpCount

setMaxHeapDumpCount

getMaxThreadDumpCount

setMaxThreadDumpCount