SAFAgentMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This class represents a Store-and-Forward (SAF) agent. A SAF sending agent takes care of storing messages to a persistent storage, forwarding messages to the receiving side, and re-transmitting messages when acknowledgements do not come back in time. A SAF receiving agent takes care of detecting and eliminating duplicate messages sent by the receiving agent, and deliver messages to the final endpoint.

       
Since9.0.0.0
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.SAFAgentMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.


Related MBeans

This section describes attributes that provide access to other MBeans.


JMSSAFMessageLogFile

The jms message log file configuration for this saf agent

       
Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
Privileges Read only
TypeJMSSAFMessageLogFileMBean
Relationship type: Containment.

Store

The persistent disk-based file store or JDBC-accessible database for the SAF agent.

If a store is not configured, the server's default store is used.

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

Targets

       
Privileges Read/Write
TypeTargetMBean[]
Relationship type: Reference.


Attributes

This section describes the following attributes:


AcknowledgeInterval

The maximum interval between two successive acknowledgements sent by the receiving side.

       
Privileges Read/Write
Typelong
Default Value-1

BytesMaximum

The maximum bytes quota (total amount of bytes) that can be stored in this SAF agent.

Range of Values: >= BytesThresholdHigh

       
Privileges Read/Write
Typelong
Default Value-1
Minimum value-1

BytesThresholdHigh

The upper threshold value that triggers events based on the number of bytes stored in the SAF agent.

Range of Values: <= BytesMaximum; >= BytesThresholdLow

       
Privileges Read/Write
Typelong
Default Value-1
Minimum value-1

BytesThresholdLow

The lower threshold that triggers events based on the number of bytes stored in the SAF agent.

Range of Values: <= BytesThresholdHigh

       
Privileges Read/Write
Typelong
Default Value-1
Minimum value-1

CachingDisabled

Private property that disables caching in proxies.

       
Privileges Read only
Typeboolean
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

ConversationIdleTimeMaximum

The maximum amount of time allowed before a sending side releases the resources used by a conversation.

       
Privileges Read/Write
Typelong
Default Value0
Minimum value0

DefaultRetryDelayBase

The amount of time, in milliseconds, between the original delivery attempt and the first retry.

Range of Values: <= RetryDelayMaximum if RetryDelayMultiplier is not 1.0.

       
Privileges Read/Write
Typelong
Default Value20000
Minimum value1

DefaultRetryDelayMaximum

The maximum amount of time, in milliseconds, between two successive delivery retry attempts.

Range of Values: > = RetryDelayBase if RetryDelayMultiplier is not 1.0.

       
Privileges Read/Write
Typelong
Default Value180000
Minimum value1

DefaultRetryDelayMultiplier

The factor used to multiply the previous delay time to calculate the next delay time to be used.

Range of Values: >= 1.

       
Privileges Read/Write
Typedouble
Default Value1.0
Minimum value1.0

DefaultTimeToLive

The default amount of time, in milliseconds, that the agent guarantees to reliably send messages.

       
Privileges Read/Write
Typelong
Default Value0
Minimum value0

DeploymentOrder

A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.

For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.

Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.

       
Privileges Read/Write
Typeint
Default Value1000
Minimum value0
Maximum value2147483647

ForwardingPausedAtStartup

Specifies whether the agent is paused for forwarding messages at the startup time.

When enabled, the sending agent forwards messages. Otherwise, the sending agent does not forward any messages.

       
Privileges Read/Write
Typeboolean

IncomingPausedAtStartup

Specifies whether the agent is paused for incoming messages at startup time.

When enabled, the sending agent accepts new messages. Otherwise, the sending agent does not accept any new messages.

       
Privileges Read/Write
Typeboolean

LoggingEnabled

Specifies whether a message is logged in the server log file when a message fails to be forwarded.

       
Privileges Read/Write
Typeboolean
Default Valuetrue

MaximumMessageSize

The maximum number of bytes allowed in individual messages on this SAF agent.

       
Privileges Read/Write
Typeint
Default Value2147483647
Minimum value0

MBeanInfo

Returns the MBean info for this MBean.

Deprecated.

       
Privileges Read only
Typejavax.management.MBeanInfo
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

MessageBufferSize

The amount of memory used to store message bodies in memory before they are paged out to disk.

For more information, see:

       
Privileges Read/Write
Typelong
Default Value-1
Minimum value-1

MessagesMaximum

The maximum message quota (total amount of messages) that can be stored in this SAF agent.

Range of Values: >= MessagesThresholdHigh

       
Privileges Read/Write
Typelong
Default Value-1
Minimum value-1

MessagesThresholdHigh

The upper threshold that triggers events based on the number of messages stored in the SAF agent.

Range of Values: <= MessagesMaximum; >= MessagesThresholdLow

       
Privileges Read/Write
Typelong
Default Value-1
Minimum value-1

MessagesThresholdLow

The low threshold that triggers events based on the number of messages stored in the SAF agent.

Range of Values: <= MessagesThresholdHigh.

       
Privileges Read/Write
Typelong
Default Value-1
Minimum value-1

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
Typejava.lang.String

Notes

Optional information that you can include to describe this configuration.

WebLogic Server 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
Typejava.lang.String

ObjectName

Returns the ObjectName under which this MBean is registered in the MBean server.

Deprecated.

       
Privileges Read only
Typeweblogic.management.WebLogicObjectName
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

PagingDirectory

Specifies where message bodies are written when the size of the message bodies in the JMS server exceeds the message buffer size. If unspecified, messages are written to the tmp directory in the host WebLogic Server instance's directory. For example, domainName/servers/servername/tmp.

For more information, see:

       
Privileges Read/Write
Typejava.lang.String

Parent

Return the immediate parent for this MBean

       
Privileges Read/Write
Type

ReceivingPausedAtStartup

Specifies whether the agent is paused for receiving messages at the startup time.

When enabled, the sending agent receives messages. Otherwise, the sending agent does not receive any messages.

       
Privileges Read/Write
Typeboolean

Registered

Returns false if the MBean represented by this object has been unregistered.

Deprecated.

       
Privileges Read only
Typeboolean
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

ServiceType

The type of service that this SAF agent provides. JMS requires only a Sending agent on the sending side for messages. Whereas, Web Services Reliable Messaging requires both a Sending and Receiving agent for messages.

       
Privileges Read/Write
Typejava.lang.String
Default ValueBoth
Legal Values
  • Both
  • Sending-only
  • Receiving-only

Type

Returns the type of the MBean.

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

WindowInterval

The maximum amount of time, in milliseconds, that a JMS sending agent waits before forwarding messages in a single batch. For a distributed queue or topic, WindowInterval setting is ignored.

A sending agent waits to forward the message batch until either: (A) the source destination message count is greater than or equal to the configured Window Size; (B) it has waited a specified Window Interval, whichever comes first.

       
Privileges Read/Write
Typelong
Default Value0
Minimum value0

WindowSize

For JMS messages, the number of messages in a batch. A sending agent waits to forward a message batch until the source destination message count is greater than or equal to this value. For a distributed queue or topic, WindowSize setting is ignored and always internally set to 1 message.

For WSRM, the maximum number of unacknowledged messages allowed between a source destination and a target destination during a conversation.

       
Privileges Read/Write
Typeint
Default Value10
Minimum value1


Operations

This section describes the following operations:


addTarget

You can add a target to specify additional servers on which the deployment can be deployed. The targets must be either clusters or servers.

   
Operation Name"addTarget"
ParametersObject [] {  target }

where:

  • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

    The feature to be added to the Target attribute

SignatureString [] { "weblogic.management.configuration.TargetMBean" }
Returns boolean
Exceptions
  • javax.management.InvalidAttributeValueException
  • weblogic.management.DistributedManagementException

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"
ParametersObject [] {  attributeName }

where:

  • attributeName is an object of type java.lang.String that specifies:

    attributeName

SignatureString [] { "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"
ParametersObject [] {  propertyName }

where:

  • propertyName is an object of type java.lang.String that specifies:

    property to check

SignatureString [] { "java.lang.String" }
Returns boolean

removeTarget

Removes the value of the addTarget attribute.

For more information, see:

   
Operation Name"removeTarget"
ParametersObject [] {  target }

where:

  • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

    target

SignatureString [] { "weblogic.management.configuration.TargetMBean" }
Returns boolean
Exceptions
  • javax.management.InvalidAttributeValueException
  • weblogic.management.DistributedManagementException

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"
ParametersObject [] {  attributeName }

where:

  • attributeName is an object of type java.lang.String that specifies:

    attributeName

SignatureString [] { "java.lang.String" }
Returns void
Exceptions
  • javax.management.AttributeNotFoundException

unSet

Restore the given property to its default value.

   
Operation Name"unSet"
ParametersObject [] {  propertyName }

where:

  • propertyName is an object of type java.lang.String that specifies:

    property to restore

SignatureString [] { "java.lang.String" }
Returns void