SAFAgentMBean (Java API Reference for Oracle WebLogic Server)

All Superinterfaces:

ConfigurationMBean, DeploymentMBean, DescriptorBean, javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, SettableBean, TargetMBean, WebLogicMBean
```
@SingleTargetOnly
public interface SAFAgentMBean
extends DeploymentMBean, TargetMBean
```
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.

Access limited to the following security roles:

Deployer

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String BOTH

static java.lang.String RECEIVING_ONLY

static java.lang.String SENDING_ONLY
- Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
  DEFAULT_EMPTY_BYTE_ARRAY
- Fields inherited from interface weblogic.management.configuration.DeploymentMBean
  DEFAULT_ORDER, MAX_ORDER, MIN_ORDER

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`BOTH`
`static java.lang.String`	`RECEIVING_ONLY`
`static java.lang.String`	`SENDING_ONLY`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`long`	`getAcknowledgeInterval()`	The maximum interval between two successive acknowledgements sent by the receiving side.
`long`	`getBytesMaximum()`	The maximum bytes quota (total amount of bytes) that can be stored in this SAF agent.
`long`	`getBytesThresholdHigh()`	The upper threshold value that triggers events based on the number of bytes stored in the SAF agent.
`long`	`getBytesThresholdLow()`	The lower threshold that triggers events based on the number of bytes stored in the SAF agent.
`long`	`getConversationIdleTimeMaximum()`	The maximum amount of time allowed, in milliseconds, before a sending side releases the resources used by a conversation.
`long`	`getDefaultRetryDelayBase()`	The amount of time, in milliseconds, between the original delivery attempt and the first retry.
`long`	`getDefaultRetryDelayMaximum()`	The maximum amount of time, in milliseconds, between two successive delivery retry attempts.
`double`	`getDefaultRetryDelayMultiplier()`	The factor used to multiply the previous delay time to calculate the next delay time to be used.
`long`	`getDefaultTimeToLive()`	The default amount of time, in milliseconds, that the agent guarantees to reliably send messages.
`JMSSAFMessageLogFileMBean`	`getJMSSAFMessageLogFile()`	The jms message log file configuration for this saf agent
`int`	`getMaximumMessageSize()`	The maximum number of bytes allowed in individual messages on this SAF agent.
`long`	`getMessageBufferSize()`	The amount of memory used to store message bodies in memory before they are paged out to disk.
`java.lang.String`	`getMessageCompressionOptions()`	Specifies the type of message compression used when JMS message body compression is enabled for Persistent Stores and JMS Paging Stores.
`long`	`getMessagesMaximum()`	The maximum message quota (total amount of messages) that can be stored in this SAF agent.
`long`	`getMessagesThresholdHigh()`	The upper threshold that triggers events based on the number of messages stored in the SAF agent.
`long`	`getMessagesThresholdLow()`	The low threshold that triggers events based on the number of messages stored in the SAF agent.
`java.lang.String`	`getName()`	The user-specified name of this MBean instance.
`java.lang.String`	`getPagingDirectory()`	Specifies where message bodies are written when the size of the message bodies in the JMS server exceeds the message buffer size.
`java.lang.String`	`getServiceType()`	The type of service that this SAF agent provides.
`PersistentStoreMBean`	`getStore()`	The persistent disk-based file store or JDBC-accessible database for the SAF agent.
`TargetMBean[]`	`getTargets()`	You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed.
`long`	`getWindowInterval()`	The maximum amount of time, in milliseconds, that a JMS sending agent waits before forwarding messages in a single batch.
`int`	`getWindowSize()`	For JMS messages, the number of messages in a batch.
`boolean`	`isForwardingPausedAtStartup()`	Specifies whether the agent is paused for forwarding messages at the startup time.
`boolean`	`isIncomingPausedAtStartup()`	Specifies whether the agent is paused for incoming messages at startup time.
`boolean`	`isLoggingEnabled()`	Specifies whether a message is logged in the server log file when a message fails to be forwarded.
`boolean`	`isPagingMessageCompressionEnabled()`	Enables the JMS paging store to perform message body compression on persistent and non-persistent messages.
`boolean`	`isReceivingPausedAtStartup()`	Specifies whether the agent is paused for receiving messages at the startup time.
`boolean`	`isStoreMessageCompressionEnabled()`	Enables the JMS store to perform message body compression.
`void`	`setAcknowledgeInterval(long interval)`	Sets the value of the `AcknowledgeInterval` attribute.
`void`	`setBytesMaximum(long bytesMaximum)`	Sets the value of the `BytesMaximum` attribute.
`void`	`setBytesThresholdHigh(long bytesThresholdHigh)`	Sets the value of the `BytesThresholdHigh` attribute.
`void`	`setBytesThresholdLow(long bytesThresholdLow)`	Sets the value of the `BytesThresholdLow` attribute.
`void`	`setConversationIdleTimeMaximum(long conversationIdleTimeMaximum)`	Sets the value of the `ConversationIdleTimeMaximum` attribute.
`void`	`setDefaultRetryDelayBase(long base)`	Sets the value of the `DefaultRetryDelayBase` attribute.
`void`	`setDefaultRetryDelayMaximum(long maximum)`	Sets the value of the `DefaultRetryDelayMaximum` attribute.
`void`	`setDefaultRetryDelayMultiplier(double multiplier)`	Sets the value of the `DefaultRetryDelayMultiplier` attribute.
`void`	`setDefaultTimeToLive(long ttl)`	Sets the value of the `DefaultTimeToLive` attribute.
`void`	`setForwardingPausedAtStartup(boolean forwardingPaused)`	Sets the value of the `ForwardingPausedAtStartup` attribute.
`void`	`setIncomingPausedAtStartup(boolean incomingPaused)`	Sets the value of the `IncomingPausedAtStartup` attribute.
`void`	`setLoggingEnabled(boolean loggingEnabled)`	Sets the value of the `LoggingEnabled` attribute.
`void`	`setMaximumMessageSize(int maxMessageSize)`	Sets the value of the `MaximumMessageSize` attribute.
`void`	`setMessageBufferSize(long bufferSize)`	Sets the value of the `MessageBufferSize` attribute.
`void`	`setMessageCompressionOptions(java.lang.String option)`	Sets the type of message compression used.
`void`	`setMessagesMaximum(long messagesMaximum)`	Sets the value of the `MessagesMaximum` attribute.
`void`	`setMessagesThresholdHigh(long messagesThresholdHigh)`	Sets the value of the `MessagesThresholdHigh` attribute.
`void`	`setMessagesThresholdLow(long messagesThresholdLow)`	Sets the value of the `MessagesThresholdLow` attribute.
`void`	`setPagingDirectory(java.lang.String directory)`	Sets the value of the `PagingDirectory` attribute.
`void`	`setPagingMessageCompressionEnabled(boolean allows)`	Sets the value of the isPagingMessageCompressionEnabled attribute.
`void`	`setReceivingPausedAtStartup(boolean receivingPaused)`	Sets the value of the `ReceivingPausedAtStartup` attribute.
`void`	`setServiceType(java.lang.String type)`	Sets the value of the `ServiceType` attribute.
`void`	`setStore(PersistentStoreMBean store)`	Sets the value of the `Store` attribute.
`void`	`setStoreMessageCompressionEnabled(boolean allows)`	Sets the value of the isStoreMessageCompressionEnabled attribute.
`void`	`setTargets(TargetMBean[] Targets)`	Sets the value of the getTargets attribute.
`void`	`setWindowInterval(long windowInterval)`	Sets the value of the `WindowInterval` attribute.
`void`	`setWindowSize(int size)`	Sets the value of the `WindowSize` attribute.

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getId, getInheritedProperties, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet

Methods inherited from interface weblogic.management.configuration.DeploymentMBean
addTarget, getDeploymentOrder, removeTarget, setDeploymentOrder

Methods inherited from interface weblogic.descriptor.DescriptorBean
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

Methods inherited from interface javax.management.DynamicMBean
getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface weblogic.management.WebLogicMBean
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent

- Field Detail
  - SENDING_ONLY
```
static final java.lang.String SENDING_ONLY
```
    See Also:
    
    Constant Field Values
  - RECEIVING_ONLY
```
static final java.lang.String RECEIVING_ONLY
```
    See Also:
    
    Constant Field Values
  - BOTH
```
static final java.lang.String BOTH
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
java.lang.String getName()
```
    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
    
    Specified by:
    
    getName in interface ConfigurationMBean
    
    Specified by:
    
    getName in interface WebLogicMBean
  - getTargets
```
TargetMBean[] getTargets()
```
    Description copied from interface: DeploymentMBean
    
    You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.
    
    Specified by:
    
    getTargets in interface DeploymentMBean
    
    Returns:
    
    The targets value
  - setTargets
```
void setTargets(TargetMBean[] Targets)
         throws javax.management.InvalidAttributeValueException,
                DistributedManagementException
```
    Description copied from interface: DeploymentMBean
    
    Sets the value of the getTargets attribute.
    
    Specified by:
    
    setTargets in interface DeploymentMBean
    
    Parameters:
    
    Targets - The new targets value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    DistributedManagementException
    
    See Also:
    
    DeploymentMBean.getTargets()
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - getStore
```
PersistentStoreMBean getStore()
```
    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.
    
    If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
    
    Returns:
    
    The store value
  - setStore
```
void setStore(PersistentStoreMBean store)
       throws javax.management.InvalidAttributeValueException
```
    Sets the value of the Store attribute.
    
    Parameters:
    
    store - The new store value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    See Also:
    
    getStore()
    
    Default Value:
    
    null
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
  - getBytesMaximum
```
long getBytesMaximum()
```
    The maximum bytes quota (total amount of bytes) that can be stored in this SAF agent.
    - The default value of -1 specifies that there is no WebLogic-imposed limit on the number of bytes that can be stored. However, excessive bytes volume can cause memory saturation, so this value should correspond to the total amount of available system memory relative to the rest of your application load.
    - Applies only to agents with sending capability.
    - Updating BytesMaximum affects only new requests.
    Range of Values: >= BytesThresholdHigh
    Returns:
    
    The bytesMaximum value
  - setBytesMaximum
```
void setBytesMaximum(long bytesMaximum)
              throws javax.management.InvalidAttributeValueException,
                     DistributedManagementException
```
    Sets the value of the BytesMaximum attribute.
    
    Parameters:
    
    bytesMaximum - The new bytesMaximum value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    DistributedManagementException
    
    See Also:
    
    getBytesMaximum()
    
    Default Value:
    
    -1
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Minimum Value:
    
    -1
  - getBytesThresholdHigh
```
long getBytesThresholdHigh()
```
    The upper threshold value that triggers events based on the number of bytes stored in the SAF agent.
    - The default value of -1 disables the events for this SAF agent.
    - Applies only to agents with sending capability.
    - Updating BytesThresholdHigh affects only new requests.
    - If the number of bytes exceeds this threshold, the triggered events are:
      
      Log Messages: A message is logged on the server indicating a high threshold condition.
      
      Flow Control: The agent becomes armed and instructs producers to begin decreasing their message flow.
    Range of Values: <= BytesMaximum; >= BytesThresholdLow
    Returns:
    
    The bytesThresholdHigh value
  - setBytesThresholdHigh
```
void setBytesThresholdHigh(long bytesThresholdHigh)
                    throws javax.management.InvalidAttributeValueException,
                           DistributedManagementException
```
    Sets the value of the BytesThresholdHigh attribute.
    
    Parameters:
    
    bytesThresholdHigh - The new bytesThresholdHigh value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    DistributedManagementException
    
    See Also:
    
    getBytesThresholdHigh()
    
    Default Value:
    
    -1
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Minimum Value:
    
    -1
  - getBytesThresholdLow
```
long getBytesThresholdLow()
```
    The lower threshold that triggers events based on the number of bytes stored in the SAF agent.
    - The default value of -1 disables the events for this SAF agent.
    - Applies only to agents with sending capability.
    - Updating BytesThresholdLow affects only new requests.
    - If the number of bytes falls below this threshold, the triggered events are:
      
      Log Messages: A message is logged on the server indicating that the threshold condition has cleared.
      
      Flow Control: The agent becomes disarmed and instructs producers to begin increasing their message flow.
    Range of Values: <= BytesThresholdHigh
    Returns:
    
    The bytesThresholdLow value
  - setBytesThresholdLow
```
void setBytesThresholdLow(long bytesThresholdLow)
                   throws javax.management.InvalidAttributeValueException,
                          DistributedManagementException
```
    Sets the value of the BytesThresholdLow attribute.
    
    Parameters:
    
    bytesThresholdLow - The new bytesThresholdLow value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    DistributedManagementException
    
    See Also:
    
    getBytesThresholdLow()
    
    Default Value:
    
    -1
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Minimum Value:
    
    -1
  - getMessagesMaximum
```
long getMessagesMaximum()
```
    The maximum message quota (total amount of messages) that can be stored in this SAF agent.
    - The default value of -1 specifies that the server instance has no limit on the number of messages that can be stored. However, excessive message volume can cause memory saturation, so this value should correspond to the total amount of available system memory relative to the rest of your application load.
    - Applies only to sending agents.
    - Updating the maximum message quota resets the message count so that only requests arriving after the update are charged against the new quota.
    Range of Values: >= MessagesThresholdHigh
    Returns:
    
    The messagesMaximum value
  - setMessagesMaximum
```
void setMessagesMaximum(long messagesMaximum)
                 throws javax.management.InvalidAttributeValueException,
                        DistributedManagementException
```
    Sets the value of the MessagesMaximum attribute.
    
    Parameters:
    
    messagesMaximum - The new messagesMaximum value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    DistributedManagementException
    
    See Also:
    
    getBytesThresholdLow()
    
    Default Value:
    
    -1
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Minimum Value:
    
    -1
  - getMessagesThresholdHigh
```
long getMessagesThresholdHigh()
```
    The upper threshold that triggers events based on the number of messages stored in the SAF agent.
    - The default value of -1 disables the events for this SAF agent.
    - Applies only to agents with sending capability.
    - Updating MessagesThresholdHigh affects only new requests.
    - If the number of messages exceeds this threshold, the triggered events are:
      
      Log Messages: A message is logged on the server indicating a high threshold condition.
      
      Flow Control: The agent becomes armed and instructs producers to begin decreasing their message flow.
    Range of Values: <= MessagesMaximum; >= MessagesThresholdLow
    Returns:
    
    The messagesThresholdHigh value
  - setMessagesThresholdHigh
```
void setMessagesThresholdHigh(long messagesThresholdHigh)
                       throws javax.management.InvalidAttributeValueException
```
    Sets the value of the MessagesThresholdHigh attribute.
    
    Parameters:
    
    messagesThresholdHigh - The new messagesThresholdHigh value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    See Also:
    
    getMessagesThresholdHigh()
    
    Default Value:
    
    -1
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Minimum Value:
    
    -1
  - getMessagesThresholdLow
```
long getMessagesThresholdLow()
```
    The low threshold that triggers events based on the number of messages stored in the SAF agent.
    - The default value of -1 disables the events for this SAF agent.
    - Applies only to agents with sending capability.
    - Updating MessagesThresholdLow affects only new requests.
    - If the number of messages falls below this threshold, the triggered events are:
      
      Log Messages: A message is logged on the server indicating that the threshold condition has cleared.
      
      Flow Control: The agent becomes disarmed and instructs producers to begin increasing their message flow.
    Range of Values: <= MessagesThresholdHigh.
    Returns:
    
    The messagesThresholdLow value
  - setMessagesThresholdLow
```
void setMessagesThresholdLow(long messagesThresholdLow)
                      throws javax.management.InvalidAttributeValueException,
                             DistributedManagementException
```
    Sets the value of the MessagesThresholdLow attribute.
    
    Parameters:
    
    messagesThresholdLow - The new messagesThresholdLow value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    DistributedManagementException
    
    See Also:
    
    getMessagesThresholdLow()
    
    Default Value:
    
    -1
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Minimum Value:
    
    -1
  - getMaximumMessageSize
```
int getMaximumMessageSize()
```
    The maximum number of bytes allowed in individual messages on this SAF agent.
    - The message size includes the message body, any user-defined properties, and the user-defined JMS header fields: JMSCorrelationID and JMSType.
    - Producers sending messages that exceed the configured maximum message size for the SAF agent will receive a ResourceAllocationException.
    - The maximum message size is only enforced for the initial production of a message. Messages that are redirected to an error destination or forwarded to a member of a distributed destination are not checked for size. For instance, if a destination and its corresponding error destination are configured with a maximum message size of 128K bytes and 64K bytes, respectively, a message of 96K bytes could be redirected to the error destination (even though it exceeds the 64K byte maximum), but a producer could not directly send the 96K byte message to the error destination.
    - Applies only to agents with sending capability.
    - Updating MaximumMessageSize affects only incoming messages; stored messages are not affected.
    Returns:
    
    The maximumMessageSize value
    
    Default Value:
    
    java.lang.Integer.MAX_VALUE
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Minimum Value:
    
    0
  - setMaximumMessageSize
```
void setMaximumMessageSize(int maxMessageSize)
                    throws javax.management.InvalidAttributeValueException,
                           DistributedManagementException
```
    Sets the value of the MaximumMessageSize attribute.
    
    Parameters:
    
    maxMessageSize - The new maximumMessageSize value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    DistributedManagementException
    
    See Also:
    
    getMaximumMessageSize()
    
    Default Value:
    
    java.lang.Integer.MAX_VALUE
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Minimum Value:
    
    0
  - getDefaultRetryDelayBase
```
long getDefaultRetryDelayBase()
```
    The amount of time, in milliseconds, between the original delivery attempt and the first retry.
    - If RetryDelayMultiplier is set to 1, this defines the interval between any two successive retry attempts.
    - Applies only to agents with sending capability.
    - Updating DefaultRetryDelayBase causes connections starting after the update to use the new value.
    Range of Values: <= RetryDelayMaximum if RetryDelayMultiplier is not 1.0.
    Returns:
    
    The defaultRetryDelayBase value
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - setDefaultRetryDelayBase
```
void setDefaultRetryDelayBase(long base)
                       throws javax.management.InvalidAttributeValueException
```
    Sets the value of the DefaultRetryDelayBase attribute.
    
    Parameters:
    
    base - The new defaultRetryDelayBase value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    See Also:
    
    getDefaultRetryDelayBase()
    
    Default Value:
    
    20000
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Minimum Value:
    
    1
  - getDefaultRetryDelayMaximum
```
long getDefaultRetryDelayMaximum()
```
    The maximum amount of time, in milliseconds, between two successive delivery retry attempts.
    - Applies only to agents with sending capability.
    - Updating DefaultRetryDelayMaximum causes connections starting after the update to use the new value.
    Range of Values: > = RetryDelayBase if RetryDelayMultiplier is not 1.0.
    Returns:
    
    The defaultRetryDelayMaximum value
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - setDefaultRetryDelayMaximum
```
void setDefaultRetryDelayMaximum(long maximum)
                          throws javax.management.InvalidAttributeValueException
```
    Sets the value of the DefaultRetryDelayMaximum attribute.
    
    Parameters:
    
    maximum - The new defaultRetryDelayMaximum value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    See Also:
    
    getDefaultRetryDelayMaximum()
    
    Default Value:
    
    180000
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Minimum Value:
    
    1
  - getDefaultRetryDelayMultiplier
```
double getDefaultRetryDelayMultiplier()
```
    The factor used to multiply the previous delay time to calculate the next delay time to be used.
    - Applies only to agents with sending capability.
    - Updating DefaultRetryDelayMuliplier causes connections starting after the update to use the new value.
    Range of Values: >= 1.
    Returns:
    
    The defaultRetryDelayMultiplier value
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - setDefaultRetryDelayMultiplier
```
void setDefaultRetryDelayMultiplier(double multiplier)
                             throws javax.management.InvalidAttributeValueException
```
    Sets the value of the DefaultRetryDelayMultiplier attribute.
    
    Parameters:
    
    multiplier - The new defaultRetryDelayMultiplier value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    See Also:
    
    getDefaultRetryDelayMultiplier()
    
    Default Value:
    
    1.0
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Minimum Value:
    
    1.0
  - getServiceType
```
java.lang.String getServiceType()
```
    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.
    - Sending-only Configures an agent that stores messages in persistent storage, forwards messages to the receiving side, and re-transmits messages when acknowledgements do not come back in time.
    - Receiving-only Configures an agent that detects and eliminates duplicate messages sent by a receiving agent, and delivers messages to the final destination.
    - Both Configures an agent that has sending and receiving agent functionality.
    If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
    Returns:
    
    The serviceType value
  - setServiceType
```
void setServiceType(java.lang.String type)
             throws javax.management.InvalidAttributeValueException
```
    Sets the value of the ServiceType attribute.
    
    Parameters:
    
    type - The value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    See Also:
    
    getServiceType()
    
    Default Value:
    
    SAFAgentMBean.BOTH
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
    
    Valid Values:
    
    SAFAgentMBean.BOTH,SAFAgentMBean.SENDING_ONLY,SAFAgentMBean.RECEIVING_ONLY
  - getWindowSize
```
int getWindowSize()
```
    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.
    
    Returns:
    
    The windowSize value
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - setWindowSize
```
void setWindowSize(int size)
            throws javax.management.InvalidAttributeValueException
```
    Sets the value of the WindowSize attribute.
    
    Parameters:
    
    size - The new windowSize value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    See Also:
    
    getWindowSize()
    
    Default Value:
    
    10
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Minimum Value:
    
    1
  - isLoggingEnabled
```
boolean isLoggingEnabled()
```
    Specifies whether a message is logged in the server log file when a message fails to be forwarded.
    - If selected, this applies to messages that fail to be forwarded and delivered to the final destination when there is no error handling in a SAF application or the application's error handling fails.
    - Applies only to agents with receiving capability.
    - Updating LoggingEnabled causes connections starting after the update to use the new value.
    Returns:
    
    The loggingEnabled value
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - setLoggingEnabled
```
void setLoggingEnabled(boolean loggingEnabled)
                throws javax.management.InvalidAttributeValueException
```
    Sets the value of the LoggingEnabled attribute.
    
    Parameters:
    
    loggingEnabled - The new loggingEnabled value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    See Also:
    
    isLoggingEnabled()
    
    Default Value:
    
    true
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - getConversationIdleTimeMaximum
```
long getConversationIdleTimeMaximum()
```
    The maximum amount of time allowed, in milliseconds, before a sending side releases the resources used by a conversation.
    - If there is no activity for a conversation for the specified amount of time, the sending agent releases all resources for that conversation and notifies the receiving agent to do the same.
    - A value of 0 specifies that resources for a conversation are not released unless the application explicitly closes the conversation.
    - Updating ConversationIdleTimeMaximum causes connections starting after the update to use the new value.
    Returns:
    
    The conversationIdleTimeMaximum value
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Minimum Value:
    
    0
  - setConversationIdleTimeMaximum
```
void setConversationIdleTimeMaximum(long conversationIdleTimeMaximum)
                             throws javax.management.InvalidAttributeValueException
```
    Sets the value of the ConversationIdleTimeMaximum attribute.
    
    Parameters:
    
    conversationIdleTimeMaximum - The new conversationIdleTimeMaximum value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    See Also:
    
    getConversationIdleTimeMaximum()
    
    Default Value:
    
    0
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Minimum Value:
    
    0
  - getAcknowledgeInterval
```
long getAcknowledgeInterval()
```
    The maximum interval between two successive acknowledgements sent by the receiving side.
    - Applies only to agents with receiving capability.
    - A value of -1 specifies that there is no time limit between successive acknowledgement.
    - Updating AcknowlegeInterval causes connections starting after the update to use the new value.
    Returns:
    
    The acknowledgeInterval value
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - setAcknowledgeInterval
```
void setAcknowledgeInterval(long interval)
                     throws javax.management.InvalidAttributeValueException
```
    Sets the value of the AcknowledgeInterval attribute.
    
    Parameters:
    
    interval - The new acknowledgeInterval value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    See Also:
    
    getAcknowledgeInterval()
    
    Default Value:
    
    -1
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - getDefaultTimeToLive
```
long getDefaultTimeToLive()
```
    The default amount of time, in milliseconds, that the agent guarantees to reliably send messages.
    - A value of 0 means the agent guarantees to reliably send messages for the duration of the conversation.
    - Updating DefaultTimeToLive causes conversations starting after the update to use the new value.
    Returns:
    
    The defaultTimeTolive value
    
    Default Value:
    
    0
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Minimum Value:
    
    0
  - setDefaultTimeToLive
```
void setDefaultTimeToLive(long ttl)
                   throws javax.management.InvalidAttributeValueException
```
    Sets the value of the DefaultTimeToLive attribute.
    
    Parameters:
    
    ttl - The new defaultTimeToLive value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    See Also:
    
    getDefaultTimeToLive()
    
    Default Value:
    
    0
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Minimum Value:
    
    0
  - isIncomingPausedAtStartup
```
boolean isIncomingPausedAtStartup()
```
    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.
    
    If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
  - setIncomingPausedAtStartup
```
void setIncomingPausedAtStartup(boolean incomingPaused)
                         throws javax.management.InvalidAttributeValueException
```
    Sets the value of the IncomingPausedAtStartup attribute.
    
    Parameters:
    
    incomingPaused - if the agent is paused for incoming messages
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    See Also:
    
    isIncomingPausedAtStartup()
    
    Default Value:
    
    false
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
  - isForwardingPausedAtStartup
```
boolean isForwardingPausedAtStartup()
```
    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.
    
    If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
  - setForwardingPausedAtStartup
```
void setForwardingPausedAtStartup(boolean forwardingPaused)
                           throws javax.management.InvalidAttributeValueException
```
    Sets the value of the ForwardingPausedAtStartup attribute.
    
    Parameters:
    
    forwardingPaused - if agent is paused for forwarding messages
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    See Also:
    
    isForwardingPausedAtStartup()
    
    Default Value:
    
    false
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
  - isReceivingPausedAtStartup
```
boolean isReceivingPausedAtStartup()
```
    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.
    
    If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
  - setReceivingPausedAtStartup
```
void setReceivingPausedAtStartup(boolean receivingPaused)
                          throws javax.management.InvalidAttributeValueException
```
    Sets the value of the ReceivingPausedAtStartup attribute.
    
    Parameters:
    
    receivingPaused - if agent is paused for receiving messages
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    See Also:
    
    isReceivingPausedAtStartup()
    
    Default Value:
    
    false
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
  - getMessageBufferSize
```
long getMessageBufferSize()
```
    The amount of memory used to store message bodies in memory before they are paged out to disk.
    - A value of -1 (the default) specifies that the server will automatically determine a size based on the maximum heap size of the JVM. This default will be set to either one-third the maximum heap size, or 512 megabytes, whichever is smaller.
    - The larger the buffer, the more memory JMS will consume when many messages are waiting on queues or topics. Once the buffer is surpassed, JMS may write message bodies to the directory specified by PagingDirectory in an effort to reduce memory usage below this buffer.
    - Surpassing the buffer size does not stop the JMS server from accepting new messages. It is still possible to run out of memory if messages are arriving faster than they can be written to disk. Users with high messaging loads who wish to support the highest possible availability should consider setting a quota or setting a threshold and enabling flow control.
    - Applies only to agents with sending capability.
    - Paging is always supported.
    - Updating the memory size resets the message count so that only requests arriving after the update are charged against the new memory size.
    See Also:
    
    getPagingDirectory()
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - setMessageBufferSize
```
void setMessageBufferSize(long bufferSize)
                   throws javax.management.InvalidAttributeValueException
```
    Sets the value of the MessageBufferSize attribute.
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    See Also:
    
    getMessageBufferSize()
    
    Default Value:
    
    JMSConstants.DEFAULT_MESSAGE_BUFFER_SIZE
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Minimum Value:
    
    -1
  - getPagingDirectory
```
java.lang.String getPagingDirectory()
```
    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 best performance, this directory should not be the same as the directory used by the SAF agent's persistent store.
    - Applies only to agents with sending capability.
    If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
    See Also:
    
    getMessageBufferSize()
    
    Default Value:
    
    null
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
  - setPagingDirectory
```
void setPagingDirectory(java.lang.String directory)
                 throws javax.management.InvalidAttributeValueException
```
    Sets the value of the PagingDirectory attribute.
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    See Also:
    
    getPagingDirectory()
    
    Default Value:
    
    null
    
    Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.
  - getWindowInterval
```
long getWindowInterval()
```
    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.
    
    Returns:
    
    The windowInterval value
    
    Default Value:
    
    0
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Minimum Value:
    
    0
  - setWindowInterval
```
void setWindowInterval(long windowInterval)
                throws javax.management.InvalidAttributeValueException
```
    Sets the value of the WindowInterval attribute.
    
    Parameters:
    
    windowInterval - The new windowInterval value
    
    Throws:
    
    javax.management.InvalidAttributeValueException
    
    See Also:
    
    getWindowInterval()
    
    Default Value:
    
    0
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Minimum Value:
    
    0
  - getJMSSAFMessageLogFile
```
JMSSAFMessageLogFileMBean getJMSSAFMessageLogFile()
```
    The jms message log file configuration for this saf agent
  - isStoreMessageCompressionEnabled
```
boolean isStoreMessageCompressionEnabled()
```
    Enables the JMS store to perform message body compression. When set to false, the default value, no compression is performed.
    
    Returns:
    
    true if compression is required
    
    See Also:
    
    getMessageCompressionOptions()
    
    Default Value:
    
    false
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - setStoreMessageCompressionEnabled
```
void setStoreMessageCompressionEnabled(boolean allows)
```
    Sets the value of the isStoreMessageCompressionEnabled attribute.
    
    Parameters:
    
    allows - true if JMS store should perform message body compression
    
    See Also:
    
    isStoreMessageCompressionEnabled()
    
    Default Value:
    
    false
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - isPagingMessageCompressionEnabled
```
boolean isPagingMessageCompressionEnabled()
```
    Enables the JMS paging store to perform message body compression on persistent and non-persistent messages. When false, the default value, no compression is performed.
    
    Returns:
    
    true if compression is required
    
    See Also:
    
    getMessageCompressionOptions()
    
    Default Value:
    
    false
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - setPagingMessageCompressionEnabled
```
void setPagingMessageCompressionEnabled(boolean allows)
```
    Sets the value of the isPagingMessageCompressionEnabled attribute.
    
    Parameters:
    
    allows - true if JMS paging store should perform compression
    
    See Also:
    
    isPagingMessageCompressionEnabled()
    
    Default Value:
    
    false
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
  - setMessageCompressionOptions
```
void setMessageCompressionOptions(java.lang.String option)
```
    Sets the type of message compression used.
    
    Parameters:
    
    option - the supported compression machanism
    
    Default Value:
    
    weblogic.jms.common.JMSConstants.GZIP_DEFAULT_COMPRESSION
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.
    
    Valid Values:
    
    weblogic.jms.common.JMSConstants.GZIP_DEFAULT_COMPRESSION, weblogic.jms.common.JMSConstants.GZIP_BEST_COMPRESSION, weblogic.jms.common.JMSConstants.GZIP_BEST_SPEED, weblogic.jms.common.JMSConstants.LZF
  - getMessageCompressionOptions
```
java.lang.String getMessageCompressionOptions()
```
    Specifies the type of message compression used when JMS message body compression is enabled for Persistent Stores and JMS Paging Stores.
    - Use GZIP_DEFAULT_COMPRESSION to enable message compression using the JDK GZIP API with DEFAULT_COMPRESSION level.
    - Use GZIP_BEST_COMPRESSION to enable message compression using the JDK GZIP API with BEST_COMPRESSION level.
    - Use GZIP_BEST_SPEED to enable message compression using the JDK GZIP API with BEST_SPEED level.
    - Use LZF to enable message compression using Open Source LZF.
    Returns:
    
    the defined message compression options
    
    See Also:
    
    isStoreMessageCompressionEnabled(), isPagingMessageCompressionEnabled()
    
    Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

Interface SAFAgentMBean

Field Summary

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean

Fields inherited from interface weblogic.management.configuration.DeploymentMBean

Method Summary

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

Methods inherited from interface weblogic.management.configuration.DeploymentMBean

Methods inherited from interface weblogic.descriptor.DescriptorBean

Methods inherited from interface javax.management.DynamicMBean

Methods inherited from interface javax.management.MBeanRegistration

Methods inherited from interface javax.management.NotificationBroadcaster

Methods inherited from interface weblogic.management.WebLogicMBean

Field Detail

SENDING_ONLY

RECEIVING_ONLY

BOTH

Method Detail

getName

getTargets

setTargets

getStore

setStore

getBytesMaximum

setBytesMaximum

getBytesThresholdHigh

setBytesThresholdHigh

getBytesThresholdLow

setBytesThresholdLow

getMessagesMaximum

setMessagesMaximum

getMessagesThresholdHigh

setMessagesThresholdHigh

getMessagesThresholdLow

setMessagesThresholdLow

getMaximumMessageSize

setMaximumMessageSize

getDefaultRetryDelayBase

setDefaultRetryDelayBase

getDefaultRetryDelayMaximum

setDefaultRetryDelayMaximum

getDefaultRetryDelayMultiplier

setDefaultRetryDelayMultiplier

getServiceType

setServiceType

getWindowSize

setWindowSize

isLoggingEnabled

setLoggingEnabled

getConversationIdleTimeMaximum

setConversationIdleTimeMaximum

getAcknowledgeInterval

setAcknowledgeInterval

getDefaultTimeToLive

setDefaultTimeToLive

isIncomingPausedAtStartup

setIncomingPausedAtStartup

isForwardingPausedAtStartup

setForwardingPausedAtStartup

isReceivingPausedAtStartup

setReceivingPausedAtStartup

getMessageBufferSize

setMessageBufferSize

getPagingDirectory

setPagingDirectory

getWindowInterval

setWindowInterval

getJMSSAFMessageLogFile

isStoreMessageCompressionEnabled

setStoreMessageCompressionEnabled

isPagingMessageCompressionEnabled

setPagingMessageCompressionEnabled

setMessageCompressionOptions

getMessageCompressionOptions