# WLDFServerDiagnosticMBean

Overview | Related MBeans | Attributes | Operations

## Overview

Use this interface to configure the WebLogic Diagnostic Framework (WLDF) components that are defined for each WebLogic Server instance.

Since | 9.0.0.0
Fully Qualified Interface Name | If you use the `getMBeanInfo` operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name: `weblogic.management.configuration.WLDFServerDiagnosticMBean`
Factory Methods | No factory methods. Instances of this MBean are created automatically.
Access Points | You can access this MBean from the following MBean attributes:
ServerMBean.ServerDiagnosticConfig |

## Related MBeans

This section describes attributes that provide access to other MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.

DiagnosticJDBCResource |

### DiagnosticJDBCResource

The JDBC data source that the server uses to archive its harvested metrics and event data.

For more information, see:

- getDiagnosticDataArchiveType

Privileges | Read/Write
Type | JDBCSystemResourceMBean
Relationship type: | Reference.
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

## Attributes

This section describes the following attributes:

DiagnosticContextEnabled DiagnosticDataArchiveType DiagnosticStoreDir EventPersistenceInterval EventsImageCaptureInterval ImageDir ImageTimeout | Name Notes Parent SynchronousEventPersistenceEnabled Type

### DiagnosticContextEnabled

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.

Privileges | Read/Write
Type | boolean

### DiagnosticDataArchiveType

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.

Privileges | Read/Write
Type | java.lang.String
Default Value | FileStoreArchive
Legal Values | FileStoreArchive JDBCArchive

### DiagnosticStoreDir

The directory in which the current server maintains its diagnostic store.

For more information, see:

- getDiagnosticDataArchiveType

Privileges | Read/Write
Type | java.lang.String
Default Value | data/store/diagnostics

### EventPersistenceInterval

The interval, in milliseconds, at which queued up instrumentation events will be periodically dispatched to the archive.

Privileges | Read/Write
Type | long
Default Value | 5000

### EventsImageCaptureInterval

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.

Privileges | Read/Write
Type | long
Default Value | 60000

### ImageDir

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.

For more information, see:

- WLDFImageRuntimeMBean

Privileges | Read/Write
Type | java.lang.String

### ImageTimeout

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

Privileges | Read/Write
Type | int
Default Value | 1
Minimum value | 0
Maximum value | 1440

### Name

The user-specified name of this MBean instance.

This name is included as one of the key properties in the MBean's `javax.management.ObjectName`:
`Name=user-specified-name`

Privileges | Read/Write
Type | java.lang.String

### Notes

Optional information that you can include to describe this configuration.

WebLogic Sever saves this note in the domain's configuration file (`config.xml`) as XML PCDATA. All left angle brackets (<) are converted to the XML entity `&lt;`. Carriage returns/line feeds are preserved.

Note:

  If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

Privileges | Read/Write
Type | java.lang.String

### Parent

Return the immediate parent for this MBean

Privileges | Read/Write
Type |

### SynchronousEventPersistenceEnabled

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.

Privileges | Read/Write
Type | boolean

### Type

Returns the type of the MBean.

Privileges | Read only
Type | java.lang.String
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

## Operations

This section describes the following operations:

freezeCurrentValue isSet restoreDefaultValue | unSet

### freezeCurrentValue

If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

Note:

  To insure that you are freezing the default value, invoke the `restoreDefaultValue` operation before you invoke this.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

Deprecated. 9.0.0.0

Operation Name | `"freezeCurrentValue"`
Parameters | `Object [] { attributeName }` where: `attributeName` is an object of type `java.lang.String` that specifies: attributeName
Signature | `String [] { "java.lang.String" }`
Returns | `void`
Exceptions | `javax.management.AttributeNotFoundException` `javax.management.MBeanException`

### isSet

Returns true if the specified attribute has been set explicitly in this MBean instance.

Operation Name | `"isSet"`
Parameters | `Object [] { propertyName }` where: `propertyName` is an object of type `java.lang.String` that specifies: property to check
Signature | `String [] { "java.lang.String" }`
Returns | `boolean`

### restoreDefaultValue

If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the `freezeCurrentValue` operation.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

Deprecated. 9.0.0.0

Operation Name | `"restoreDefaultValue"`
Parameters | `Object [] { attributeName }` where: `attributeName` is an object of type `java.lang.String` that specifies: attributeName
Signature | `String [] { "java.lang.String" }`
Returns | `void`
Exceptions | `javax.management.AttributeNotFoundException`

### unSet

Restore the given property to its default value.

Operation Name | `"unSet"`
Parameters | `Object [] { propertyName }` where: `propertyName` is an object of type `java.lang.String` that specifies: property to restore
Signature | `String [] { "java.lang.String" }`
Returns | `void`