weblogic.j2ee.descriptor.wl
Interface MessageLoggingParamsBean

All Superinterfaces:

SettableBean

public interface MessageLoggingParamsBean
extends SettableBean

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

Access limited to the following security roles:

Deployer

isMessageLoggingEnabled

boolean isMessageLoggingEnabled()

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

Returns:

The message logging currently in use by this destination

Changes take effect after you redeploy the module or restart the server.

Default Value:

false

setMessageLoggingEnabled

void setMessageLoggingEnabled(boolean value)
                              throws IllegalArgumentException

Sets the value of the MessageLoggingEnabled attribute.

Throws:

IllegalArgumentException

Changes take effect after you redeploy the module or restart the server.

Default Value:

false

getMessageLoggingFormat

String getMessageLoggingFormat()

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

Returns:

The message logging format currently in use by this destination

Changes take effect after you redeploy the module or restart the server.

Default Value:

null

setMessageLoggingFormat

void setMessageLoggingFormat(String messageLoggingFormat)
                             throws IllegalArgumentException

Sets the value of the MessageLoggingFormat attribute.

Parameters:

messageLoggingFormat - The message logging format to use with this destination

Throws:

IllegalArgumentException

Changes take effect after you redeploy the module or restart the server.

getTemplateBean

TemplateBean getTemplateBean()

Finds the template bean for this destination.

Returns:

The template bean that will be used for this destination, or null if this threshold bean is from a template or a template could not be found for this destination