GET A Create Form For This SAF Agent Collection
/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/SAFAgentCreateForm
This resource returns a pre-populated SAF agent model that can be customized then posted (using the POST method) to the SAFAgents collection resource to create a new SAF agent.
Request
-
name: string
The name property of the instance in the collection.
-
version: string
The version of the WebLogic REST interface.
-
excludeFields(optional): string
The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
-
excludeLinks(optional): string
The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
-
fields(optional): string
The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
-
links(optional): string
The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.
-
Admin: basic
Type:
basic
Description:A user in the Admin security role.
-
Deployer: basic
Type:
basic
Description:A user in the Deployer security role.
-
Monitor: basic
Type:
basic
Description:A user in the Monitor security role.
-
Operator: basic
Type:
basic
Description:A user in the Operator security role.
Response
- application/json
200 Response
Returns this SAF agent.
This method can return the following links:
- rel=create uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/SAFAgents
The collection resource for this create form resource.
object
-
acknowledgeInterval(optional):
integer(int64)
Default Value:
-1
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.
-
bytesMaximum(optional):
integer(int64)
Minimum Value:
-1
Default Value:-1
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
-
bytesThresholdHigh(optional):
integer(int64)
Minimum Value:
-1
Default Value:-1
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=>
-
bytesThresholdLow(optional):
integer(int64)
Minimum Value:
-1
Default Value:-1
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< p>=>
-
conversationIdleTimeMaximum(optional):
integer(int64)
Minimum Value:
0
Default Value:0
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
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.
-
defaultRetryDelayBase(optional):
integer(int64)
Minimum Value:
1
Default Value:20000
The amount of time, in milliseconds, between the original delivery attempt and the first retry.
If
RetryDelayMultiplier
is set to, 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. < p>=>
-
defaultRetryDelayMaximum(optional):
integer(int64)
Minimum Value:
1
Default Value:180000
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.
-
defaultRetryDelayMultiplier(optional):
number(double)
Minimum Value:
1
Default Value:1
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.
-
defaultTimeToLive(optional):
integer(int64)
Minimum Value:
0
Default Value:0
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.
-
deploymentOrder(optional):
integer(int32)
Minimum Value:
0
Maximum Value:2147483647
Default Value:1000
A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.
For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.
Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.
-
dynamicallyCreated(optional):
boolean
Read Only:
true
Default Value:false
Return whether the MBean was created dynamically or is persisted to config.xml
-
forwardingPausedAtStartup(optional):
boolean
Default Value:
false
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).
-
id(optional):
integer(int64)
Read Only:
true
Return the unique id of this MBean instance
-
incomingPausedAtStartup(optional):
boolean
Default Value:
false
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).
-
loggingEnabled(optional):
boolean
Default Value:
true
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.
-
maximumMessageSize(optional):
integer(int32)
Minimum Value:
0
Default Value:2147483647
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
andJMSType
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.
-
messageBufferSize(optional):
integer(int64)
Minimum Value:
-1
Default Value:-1
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.
-
messageCompressionOptions(optional):
string
Default Value:
GZIP_DEFAULT_COMPRESSION
Allowed Values:[ "GZIP_DEFAULT_COMPRESSION", "GZIP_BEST_COMPRESSION", "GZIP_BEST_SPEED", "LZF" ]
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 withDEFAULT_COMPRESSION
level.Use
GZIP_BEST_COMPRESSION
to enable message compression using the JDK GZIP API withBEST_COMPRESSION
level.Use
GZIP_BEST_SPEED
to enable message compression using the JDK GZIP API withBEST_SPEED
level.Use
LZF
to enable message compression using Open Source LZF.
-
messagesMaximum(optional):
integer(int64)
Minimum Value:
-1
Default Value:-1
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
-
messagesThresholdHigh(optional):
integer(int64)
Minimum Value:
-1
Default Value:-1
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=>
-
messagesThresholdLow(optional):
integer(int64)
Minimum Value:
-1
Default Value:-1
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.< p>=>
-
name(optional):
string
Read Only:
true
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
Constraints
- legal null
-
notes(optional):
string
Optional information that you can include to describe this configuration.
WebLogic Server saves this note in the domain's configuration file (
config.xml
) as XML PCDATA. All left angle brackets (<) are converted to the xml entity<. 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.
-
pagingDirectory(optional):
string
Default Value:
oracle.doceng.json.BetterJsonNull@4aca2782
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).
Constraints
- legal null
-
pagingMessageCompressionEnabled(optional):
boolean
Default Value:
false
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. -
receivingPausedAtStartup(optional):
boolean
Default Value:
false
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).
-
serviceType(optional):
string
Default Value:
Both
Allowed Values:[ "Both", "Sending-only", "Receiving-only" ]
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).
-
store(optional):
array Persistent Store Reference
Title:
Persistent Store Reference
Contains the persistent store reference.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).
Constraints
- restart required
-
storeMessageCompressionEnabled(optional):
boolean
Default Value:
false
Enables the JMS store to perform message body compression. When set to
false
, the default value, no compression is performed. -
tags(optional):
array Items
Title:
Items
Return all tags on this Configuration MBean
-
targets(optional):
array Target References
Title:
Target References
Contains the array of target references. -
type(optional):
string
Read Only:
true
Returns the type of the MBean.
Constraints
- unharvestable
-
windowInterval(optional):
integer(int64)
Minimum Value:
0
Default Value:0
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 specifiedWindow Interval
, whichever comes first. -
windowSize(optional):
integer(int32)
Minimum Value:
1
Default Value:10
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.
array
Persistent Store Reference
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).
Constraints
- restart required
array
Target References
-
Array of:
object Target Reference
Title:
Target Reference
Contains the target reference.
object
Target Reference
-
identity(optional):
array Identity
Title:
Identity
DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.
array
Identity