Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.2)

Part Number E27170-01

weblogic.management.configuration
Interface SAFAgentMBean

All Superinterfaces:
ConfigurationMBean, DeploymentMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, TargetMBean, WebLogicMBean

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.


Field Summary
static String BOTH
           
static String RECEIVING_ONLY
           
static String SENDING_ONLY
           
 
Fields inherited from interface weblogic.management.configuration.DeploymentMBean
DEFAULT_ORDER, MAX_ORDER, MIN_ORDER
 
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY
 
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY
 
Method Summary
 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 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.
 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.
 String getPagingDirectory()
           Specifies where message bodies are written when the size of the message bodies in the JMS server exceeds the message buffer size.
 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(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(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(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.DeploymentMBean
addTarget, getDeploymentOrder, removeTarget, setDeploymentOrder
 
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet
 
Methods inherited from interface weblogic.management.WebLogicMBean
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent
 
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.descriptor.DescriptorBean
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener
 
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet
 
Methods inherited from interface weblogic.management.WebLogicMBean
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent
 
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.descriptor.DescriptorBean
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener
 

Field Detail

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
Method Detail

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()
Changes take effect after you redeploy the module or restart the server.

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()
Default Value:
null

getBytesMaximum

long getBytesMaximum()

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

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()
Default Value:
-1
Minimum Value:
-1

getBytesThresholdHigh

long getBytesThresholdHigh()

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

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()
Default Value:
-1
Minimum Value:
-1

getBytesThresholdLow

long getBytesThresholdLow()

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

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()
Default Value:
-1
Minimum Value:
-1

getMessagesMaximum

long getMessagesMaximum()

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

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()
Default Value:
-1
Minimum Value:
-1

getMessagesThresholdHigh

long getMessagesThresholdHigh()

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

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()
Default Value:
-1
Minimum Value:
-1

getMessagesThresholdLow

long getMessagesThresholdLow()

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

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()
Default Value:
-1
Minimum Value:
-1

getMaximumMessageSize

int getMaximumMessageSize()

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

Returns:
The maximumMessageSize value
Default Value:
java.lang.Integer.MAX_VALUE
Minimum Value:
0

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()
Default Value:
java.lang.Integer.MAX_VALUE
Minimum Value:
0

getDefaultRetryDelayBase

long getDefaultRetryDelayBase()

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.

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()
Default Value:
20000
Minimum Value:
1

getDefaultRetryDelayMaximum

long getDefaultRetryDelayMaximum()

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

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()
Default Value:
180000
Minimum Value:
1

getDefaultRetryDelayMultiplier

double getDefaultRetryDelayMultiplier()

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

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()
Default Value:
1.0
Minimum Value:
1.0

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.

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()
Default Value:
SAFAgentMBean.BOTH
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

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()
Default Value:
10
Minimum Value:
1

isLoggingEnabled

boolean isLoggingEnabled()

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

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()
Default Value:
true

getConversationIdleTimeMaximum

long getConversationIdleTimeMaximum()

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

Returns:
The conversationIdleTimeMaximum value
Minimum Value:
0

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()
Default Value:
0
Minimum Value:
0

getAcknowledgeInterval

long getAcknowledgeInterval()

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

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()
Default Value:
-1

getDefaultTimeToLive

long getDefaultTimeToLive()

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

Returns:
The defaultTimeTolive value
Default Value:
0
Minimum Value:
0

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()
Default Value:
0
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.


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()
Default Value:
false

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()
Default Value:
false

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()
Default Value:
false

getMessageBufferSize

long getMessageBufferSize()

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

See Also:
SAFAgentMBean.getPagingDirectory()

setMessageBufferSize

void setMessageBufferSize(long bufferSize)
                          throws InvalidAttributeValueException

Sets the value of the MessageBufferSize attribute.

Throws:
InvalidAttributeValueException
See Also:
SAFAgentMBean.getMessageBufferSize()
Default Value:
JMSConstants.DEFAULT_MESSAGE_BUFFER_SIZE
Minimum Value:
-1

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.

See Also:
SAFAgentMBean.getMessageBufferSize()
Default Value:
null

setPagingDirectory

void setPagingDirectory(String directory)
                        throws InvalidAttributeValueException

Sets the value of the PagingDirectory attribute.

Throws:
InvalidAttributeValueException
See Also:
SAFAgentMBean.getPagingDirectory()
Default Value:
null

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
Minimum Value:
0

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()
Default Value:
0
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.

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()
Changes take effect after you redeploy the module or restart the server.
Default Value:
false

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()
Changes take effect after you redeploy the module or restart the server.
Default Value:
false

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()
Changes take effect after you redeploy the module or restart the server.
Default Value:
false

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()
Changes take effect after you redeploy the module or restart the server.
Default Value:
false

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
Changes take effect after you redeploy the module or restart the server.
Default Value:
weblogic.jms.common.JMSConstants.GZIP_DEFAULT_COMPRESSION
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

String getMessageCompressionOptions()

Specifies the type of message compression used when JMS message body compression is enabled for Persistent Stores and JMS Paging Stores.

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()
Changes take effect after you redeploy the module or restart the server.

Copyright 1996, 2013, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.2)

Part Number E27170-01