Skip navigation links

weblogic.management.configuration
Interface SAFAgentMBean

All Superinterfaces:

ConfigurationMBean, DeploymentMBean, DescriptorBean, DynamicMBean, MBeanRegistration, 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.

Since:

9.0.0.0

SENDING_ONLY

static final String SENDING_ONLY

See Also:

Constant Field Values

RECEIVING_ONLY

static final String RECEIVING_ONLY

See Also:

Constant Field Values

BOTH

static final String BOTH

See Also:

Constant Field Values

getName

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

InvalidAttributeValueException

DistributedManagementException

See Also:

DeploymentMBean.getTargets()

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.

Returns:

The store value

setStore

void setStore(PersistentStoreMBean store)
              throws InvalidAttributeValueException

Sets the value of the Store attribute.

Parameters:

store - The new store value

Throws:

InvalidAttributeValueException

See Also:

SAFAgentMBean.getStore()

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 InvalidAttributeValueException,
                            DistributedManagementException

Sets the value of the BytesMaximum attribute.

Parameters:

bytesMaximum - The new bytesMaximum value

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

SAFAgentMBean.getBytesMaximum()

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 InvalidAttributeValueException,
                                  DistributedManagementException

Sets the value of the BytesThresholdHigh attribute.

Parameters:

bytesThresholdHigh - The new bytesThresholdHigh value

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

SAFAgentMBean.getBytesThresholdHigh()

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 InvalidAttributeValueException,
                                 DistributedManagementException

Sets the value of the BytesThresholdLow attribute.

Parameters:

bytesThresholdLow - The new bytesThresholdLow value

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

SAFAgentMBean.getBytesThresholdLow()

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 InvalidAttributeValueException,
                               DistributedManagementException

Sets the value of the MessagesMaximum attribute.

Parameters:

messagesMaximum - The new messagesMaximum value

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

SAFAgentMBean.getBytesThresholdLow()

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 InvalidAttributeValueException

Sets the value of the MessagesThresholdHigh attribute.

Parameters:

messagesThresholdHigh - The new messagesThresholdHigh value

Throws:

InvalidAttributeValueException

See Also:

SAFAgentMBean.getMessagesThresholdHigh()

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 InvalidAttributeValueException,
                                    DistributedManagementException

Sets the value of the MessagesThresholdLow attribute.

Parameters:

messagesThresholdLow - The new messagesThresholdLow value

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

SAFAgentMBean.getMessagesThresholdLow()

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

setMaximumMessageSize

void setMaximumMessageSize(int maxMessageSize)
                           throws InvalidAttributeValueException,
                                  DistributedManagementException

Sets the value of the MaximumMessageSize attribute.

Parameters:

maxMessageSize - The new maximumMessageSize value

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

SAFAgentMBean.getMaximumMessageSize()

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

setDefaultRetryDelayBase

void setDefaultRetryDelayBase(long base)
                              throws InvalidAttributeValueException

Sets the value of the DefaultRetryDelayBase attribute.

Parameters:

base - The new defaultRetryDelayBase value

Throws:

InvalidAttributeValueException

See Also:

SAFAgentMBean.getDefaultRetryDelayBase()

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

setDefaultRetryDelayMaximum

void setDefaultRetryDelayMaximum(long maximum)
                                 throws InvalidAttributeValueException

Sets the value of the DefaultRetryDelayMaximum attribute.

Parameters:

maximum - The new defaultRetryDelayMaximum value

Throws:

InvalidAttributeValueException

See Also:

SAFAgentMBean.getDefaultRetryDelayMaximum()

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

setDefaultRetryDelayMultiplier

void setDefaultRetryDelayMultiplier(double multiplier)
                                    throws InvalidAttributeValueException

Sets the value of the DefaultRetryDelayMultiplier attribute.

Parameters:

multiplier - The new defaultRetryDelayMultiplier value

Throws:

InvalidAttributeValueException

See Also:

SAFAgentMBean.getDefaultRetryDelayMultiplier()

getServiceType

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.

Returns:

The serviceType value

setServiceType

void setServiceType(String type)
                    throws InvalidAttributeValueException

Sets the value of the ServiceType attribute.

Parameters:

type - The value

Throws:

InvalidAttributeValueException

See Also:

SAFAgentMBean.getServiceType()

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

setWindowSize

void setWindowSize(int size)
                   throws InvalidAttributeValueException

Sets the value of the WindowSize attribute.

Parameters:

size - The new windowSize value

Throws:

InvalidAttributeValueException

See Also:

SAFAgentMBean.getWindowSize()

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

setLoggingEnabled

void setLoggingEnabled(boolean loggingEnabled)
                       throws InvalidAttributeValueException

Sets the value of the LoggingEnabled attribute.

Parameters:

loggingEnabled - The new loggingEnabled value

Throws:

InvalidAttributeValueException

See Also:

SAFAgentMBean.isLoggingEnabled()

getConversationIdleTimeMaximum

long getConversationIdleTimeMaximum()

The maximum amount of time allowed 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

setConversationIdleTimeMaximum

void setConversationIdleTimeMaximum(long conversationIdleTimeMaximum)
                                    throws InvalidAttributeValueException

Sets the value of the ConversationIdleTimeMaximum attribute.

Parameters:

conversationIdleTimeMaximum - The new conversationIdleTimeMaximum value

Throws:

InvalidAttributeValueException

See Also:

SAFAgentMBean.getConversationIdleTimeMaximum()

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

setAcknowledgeInterval

void setAcknowledgeInterval(long interval)
                            throws InvalidAttributeValueException

Sets the value of the AcknowledgeInterval attribute.

Parameters:

interval - The new acknowledgeInterval value

Throws:

InvalidAttributeValueException

See Also:

SAFAgentMBean.getAcknowledgeInterval()

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

setDefaultTimeToLive

void setDefaultTimeToLive(long ttl)
                          throws InvalidAttributeValueException

Sets the value of the DefaultTimeToLive attribute.

Parameters:

ttl - The new defaultTimeToLive value

Throws:

InvalidAttributeValueException

See Also:

SAFAgentMBean.getDefaultTimeToLive()

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.

setIncomingPausedAtStartup

void setIncomingPausedAtStartup(boolean incomingPaused)
                                throws InvalidAttributeValueException

Sets the value of the IncomingPausedAtStartup attribute.

Parameters:

incomingPaused - if the agent is paused for incoming messages

Throws:

InvalidAttributeValueException

See Also:

SAFAgentMBean.isIncomingPausedAtStartup()

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.

setForwardingPausedAtStartup

void setForwardingPausedAtStartup(boolean forwardingPaused)
                                  throws InvalidAttributeValueException

Sets the value of the ForwardingPausedAtStartup attribute.

Parameters:

forwardingPaused - if agent is paused for forwarding messages

Throws:

InvalidAttributeValueException

See Also:

SAFAgentMBean.isForwardingPausedAtStartup()

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.

setReceivingPausedAtStartup

void setReceivingPausedAtStartup(boolean receivingPaused)
                                 throws InvalidAttributeValueException

Sets the value of the ReceivingPausedAtStartup attribute.

Parameters:

receivingPaused - if agent is paused for receiving messages

Throws:

InvalidAttributeValueException

See Also:

SAFAgentMBean.isReceivingPausedAtStartup()

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:

SAFAgentMBean.getPagingDirectory()

setMessageBufferSize

void setMessageBufferSize(long bufferSize)
                          throws InvalidAttributeValueException

Sets the value of the MessageBufferSize attribute.

Throws:

InvalidAttributeValueException

See Also:

SAFAgentMBean.getMessageBufferSize()

getPagingDirectory

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.

See Also:

SAFAgentMBean.getMessageBufferSize()

setPagingDirectory

void setPagingDirectory(String directory)
                        throws InvalidAttributeValueException

Sets the value of the PagingDirectory attribute.

Throws:

InvalidAttributeValueException

See Also:

SAFAgentMBean.getPagingDirectory()

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

setWindowInterval

void setWindowInterval(long windowInterval)
                       throws InvalidAttributeValueException

Sets the value of the WindowInterval attribute.

Parameters:

windowInterval - The new windowInterval value

Throws:

InvalidAttributeValueException

See Also:

SAFAgentMBean.getWindowInterval()

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.

This attribute should be enabled only when configuring a WebLogic domain in an Oracle Exalogic environment.

Returns:

true if compression is required

See Also:

SAFAgentMBean.getMessageCompressionOptions()

setStoreMessageCompressionEnabled

void setStoreMessageCompressionEnabled(boolean allows)

Sets the value of the isStoreMessageCompressionEnabled attribute.

This attribute should be enabled only when configuring a WebLogic domain in an Oracle Exalogic environment.

Parameters:

allows - true if JMS store should perform message body compression

See Also:

SAFAgentMBean.isStoreMessageCompressionEnabled()

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.

This attribute should be enabled only when configuring a WebLogic domain in an Oracle Exalogic environment.

Returns:

true if compression is required

See Also:

SAFAgentMBean.getMessageCompressionOptions()

setPagingMessageCompressionEnabled

void setPagingMessageCompressionEnabled(boolean allows)

Sets the value of the isPagingMessageCompressionEnabled attribute.

This attribute should be enabled only when configuring a WebLogic domain in an Oracle Exalogic environment.

Parameters:

allows - true if JMS paging store should perform compression

See Also:

SAFAgentMBean.isPagingMessageCompressionEnabled()

setMessageCompressionOptions

void setMessageCompressionOptions(String option)

Sets the type of message compression used.

This attribute should be used only when configuring a WebLogic domain in an Oracle Exalogic environment.

Parameters:

option - the supported compression machanism

getMessageCompressionOptions

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.

This attribute should be used only when configuring a WebLogic domain in an Oracle Exalogic environment.

Returns:

the defined message compression options

See Also:

SAFAgentMBean.isStoreMessageCompressionEnabled(), SAFAgentMBean.isPagingMessageCompressionEnabled()

Skip navigation links