Package weblogic.j2ee.descriptor.wl

Interface DefaultSAFAgentBean

All Superinterfaces:

SettableBean

public interface DefaultSAFAgentBean
extends SettableBean

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.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime.

Access limited to the following security roles:

Deployer

Method Summary

Modifier and Type	Method	Description
long	getBytesMaximum()	The maximum bytes quota (total amount of bytes) that can be stored in this SAF agent.
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.
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.
long	getMessagesMaximum()	The maximum message quota (total amount of messages) that can be stored in this SAF agent.
java.lang.String	getNotes()	Optional information that you can include to describe this named JMS descriptor bean.
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.
long	getWindowInterval()	The default amount of time, in milliseconds, that a JMS sending agent waits before forwarding messages in a single batch.
int	getWindowSize()	The default number of messages (batch size) that a sending agent waits to forward a message batch until the source destination message count is greater than or equal to this value.
boolean	isLoggingEnabled()	Deprecated. since WebLogic 9.0.1 release
void	setBytesMaximum(long bytesMaximum)	Sets the value of the BytesMaximum 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	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	setMessagesMaximum(long messagesMaximum)	Sets the value of the MessagesMaximum attribute.
void	setNotes(java.lang.String notes)	Sets the notes attribute of the named JMS descriptor bean
void	setPagingDirectory(java.lang.String directory)	Sets the value of the PagingDirectory attribute.
void	setWindowInterval(long windowInterval)	Sets the value of the WindowInterval attribute.
void	setWindowSize(int size)	Sets the value of the WindowSize attribute.

Method Detail

getNotes

java.lang.String getNotes()

Optional information that you can include to describe this named JMS descriptor bean.

JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.

Note:

If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

Returns:

The notes value

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setNotes

void setNotes(java.lang.String notes)

Sets the notes attribute of the named JMS descriptor bean

Parameters:

notes - The new notes value

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)

Sets the value of the BytesMaximum attribute.

Parameters:

bytesMaximum - The new bytesMaximum value

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

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)

Sets the value of the MessagesMaximum attribute.

Parameters:

messagesMaximum - The new messagesMaximum value

See Also:

getMessagesMaximum()

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)

Sets the value of the MaximumMessageSize attribute.

Parameters:

maxMessageSize - The new maximumMessageSize value

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)

Sets the value of the DefaultRetryDelayBase attribute.

Parameters:

base - The new defaultRetryDelayBase value

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)

Sets the value of the DefaultRetryDelayMaximum attribute.

Parameters:

maximum - The new defaultRetryDelayMaximum value

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)

Sets the value of the DefaultRetryDelayMultiplier attribute.

Parameters:

multiplier - The new defaultRetryDelayMultiplier value

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

getWindowSize

int getWindowSize()

The default number of messages (batch size) that 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.

Updating WindowSize causes connections starting after the update to use the new value.

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)

Sets the value of the WindowSize attribute.

Parameters:

size - The new windowSize value

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

@Deprecated
boolean isLoggingEnabled()

Deprecated.

since WebLogic 9.0.1 release

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)

Sets the value of the LoggingEnabled attribute.

Parameters:

loggingEnabled - The new loggingEnabled value

See Also:

isLoggingEnabled()

Default Value:

true

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)

Sets the value of the DefaultTimeToLive attribute.

Parameters:

ttl - The new defaultTimeToLive value

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

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 larger.

• 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)

Sets the value of the MessageBufferSize attribute.

See Also:

getMessageBufferSize()

Default Value:

-1

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.

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)

Sets the value of the PagingDirectory attribute.

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 default amount of time, in milliseconds, that a JMS sending agent waits before forwarding messages in a single batch. For a distributed queue or topic, the WindowInterval setting is ignored.

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)

Sets the value of the WindowInterval attribute.

Parameters:

windowInterval - The new windowInterval value

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