# MessageLoggingParamsBean

Overview | Related MBeans | Attributes | Operations

## Overview

These parameters control what should happen to messages logging. They allow the adminstrator to control logging

Security roles | The following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean: Deployer
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.j2ee.descriptor.wl.MessageLoggingParamsBean`
Factory Methods | No factory methods. Instances of this MBean are created automatically.
Access Points | You can access this MBean from the following MBean attributes:
DestinationBean.MessageLoggingParams QueueBean.MessageLoggingParams SAFDestinationBean.MessageLoggingParams SAFImportedDestinationsBean.MessageLoggingParams SAFQueueBean.MessageLoggingParams SAFTopicBean.MessageLoggingParams | TemplateBean.MessageLoggingParams TopicBean.MessageLoggingParams UniformDistributedDestinationBean.MessageLoggingParams UniformDistributedQueueBean.MessageLoggingParams UniformDistributedTopicBean.MessageLoggingParams

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

TemplateBean |

### TemplateBean

Finds the template bean for this destination.

Privileges | Read only
Type | TemplateBean
Relationship type: | Reference.

## Attributes

This section describes the following attributes:

MessageLoggingEnabled MessageLoggingFormat |

### MessageLoggingEnabled

Specifies whether the module logs information about the message life cycle.

Privileges | Read/Write
Type | boolean

### MessageLoggingFormat

Defines which information about the message is logged.

Valid values are:

- %header%

  - All JMS header fields are logged.

- %properties%

  - All user-defined properties are logged.

- JMSDeliveryTime

  - This WebLogic JMS-specific extended header field is logged.

- JMSRedeliveryLimit

  - This WebLogic JMS-specific extended header field is logged.

- foo

  - Any valid JMS header field or user-defined property is logged.

When specifying multiple values, enter them as a comma-separated list. The `%header%` and `%properies%` values are not case sensitive. For example, you could use `"%header%,%properties%"` for all the JMS header fields and user properties. However, the enumeration of individual JMS header fields and user-defined properties are case sensitive. To enumerate only individual JMS header fields you could use `"%header, name, address, city, state, zip"` .

Note:

The `JMSMessageID` field is always logged and cannot be turned off. Therefore, if the Message Logging Format is not defined (i.e., null) or is defined as an empty string, then the output to the log file contains only the `JMSMessageID` of the message. Gets the "message-logging-format" element

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

## Operations

This section describes the following operations:

isSet unSet |

### isSet

Return true if the given property has been explicitly set in this bean.

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`
Exceptions | `java.lang.IllegalArgumentException` IllegalArgumentException if propertyName is not a recognized property

### 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`
Exceptions | `java.lang.IllegalArgumentException` UnsupportedOperationException if called on a runtime implementation.