# JMSSAFMessageLogFileMBean

Overview | Related MBeans | Attributes | Operations

## Overview

This defines the configuration aspects of the logs for a jms server.

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.JMSSAFMessageLogFileMBean`
Factory Methods | No factory methods. Instances of this MBean are created automatically.
Access Points | You can access this MBean from the following MBean attributes:
SAFAgentMBean.JMSSAFMessageLogFile |

## Attributes

This section describes the following attributes:

FileCount FileMinSize FileName FileTimeSpan LogFileRotationDir Name Notes | NumberOfFilesLimited Parent RotateLogOnStartup RotationTime RotationType Type

### FileCount

The maximum number of log files that the server creates when it rotates the log. This number does not include the file that the server uses to store current messages. (Requires that you enable Number of Files Limited.)

For more information, see:

- isNumberOfFilesLimited

Privileges | Read/Write
Type | int
Default Value | 7
Minimum value | 1
Maximum value | 99999

### FileMinSize

The size (1 - 65535 kilobytes) that triggers the server to move log messages to a separate file. After the log file reaches the specified minimum size, the next time the server checks the file size, it will rename the current log file as `FileName.n` and create a new one to store subsequent messages. (Requires that you specify a file rotation type of `Size`.)

For more information, see:

- getRotationType

Privileges | Read/Write
Type | int
Default Value | 500
Minimum value | 1
Maximum value | 65535

### FileName

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

### FileTimeSpan

The interval (in hours) at which the server saves old log messages to another file. (Requires that you specify a file rotation type of `TIME`.)

For more information, see:

- getRotationType

Privileges | Read/Write
Type | int
Default Value | 24
Minimum value | 1

### LogFileRotationDir

The directory where the rotated log files will be stored. By default the rotated files are stored in the same directory where the log file is stored.

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

### 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

### NumberOfFilesLimited

Indicates whether to limit the number of log files that this server instance creates to store old messages. (Requires that you specify a file rotation type of `SIZE` or `TIME`.)

After the server reaches this limit, it deletes the oldest log file and creates a new log file with the latest suffix.

If you do not enable this option, the server creates new files indefinitely and you must clean up these files as you require.

For more information, see:

- getRotationType

Privileges | Read/Write
Type | boolean

### Parent

Return the immediate parent for this MBean

Privileges | Read/Write
Type |

### RotateLogOnStartup

Specifies whether a server rotates its log file during its startup cycle.

Privileges | Read/Write
Type | boolean
Default Value | true

### RotationTime

Determines the start time (hour and minute) for a time-based rotation sequence.

At the time that this value specifies, the server renames the current log file. Thereafter, the server renames the log file at an interval that you specify in File Time Span.

If the specified time has already past, then the server starts its file rotation immediately.

Use the following format: `k:mm`, where

- `k`

  is the hour in a 24-hour format.

- `mm`

  is the minute

For more information, see:

- getRotationType
- getFileTimeSpan

Privileges | Read/Write
Type | java.lang.String
Default Value | 00:00

### RotationType

Criteria for moving old log messages to a separate file.

- `NONE`

  Messages accumulate in a single file. You must erase the contents of the file when the size is too large. Note that WebLogic Server sets a threshold size limit of 500 MB before it forces a hard rotation to prevent excessive log file growth.

- `SIZE`

  When the log file reaches the size that you specify in `FileMinSize`, the server renames the file as `FileName.n`.

- `TIME`

  At each time interval that you specify in `TimeSpan`, the server renames the file as `FileName.n`.

After the server renames a file, subsequent messages accumulate in a new file with the name that you specified in `FileName`.

Privileges | Read/Write
Type | java.lang.String
Default Value | bySize
Legal Values | bySize byTime none
Secure value | byTime

### 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`