View This Queue
/management/weblogic/{version}/serverConfig/JMSSystemResources/{name}/JMSResource/queues/{name}
View this queue.
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 queue.
This method can return the following links:
- rel=deliveryFailureParams uri=/management/weblogic/{version}/serverConfig/JMSSystemResources/{name}/JMSResource/queues/{name}/deliveryFailureParams
This resource's deliveryFailureParams singleton resource.
- rel=deliveryParamsOverrides uri=/management/weblogic/{version}/serverConfig/JMSSystemResources/{name}/JMSResource/queues/{name}/deliveryParamsOverrides
This resource's deliveryParamsOverrides singleton resource.
- rel=messageLoggingParams uri=/management/weblogic/{version}/serverConfig/JMSSystemResources/{name}/JMSResource/queues/{name}/messageLoggingParams
This resource's messageLoggingParams singleton resource.
- rel=quota
This resource's quota reference to a quota resource.
- rel=template
This resource's template reference to a template resource.
- rel=thresholds uri=/management/weblogic/{version}/serverConfig/JMSSystemResources/{name}/JMSResource/queues/{name}/thresholds
This resource's thresholds singleton resource.
object
-
attachSender(optional):
string
Default Value:
supports
Allowed Values:[ "supports", "never", "always" ]
Specifies whether messages landing on this destination should attach the credential of the sending user. You should consult the JMSXUserID documentation in Programming WebLogic JMS before using this feature.
Supports The JMSXUserID property is set with the security principal of the sending user if requested. The sender can request its identity to be attached to its messages by using a connection factory with the AttachJMSXUserID security property enabled.
Never The JMSXUserID property is never set with the security principal of the sending user no matter how the AttachJMSXUserID property is configured on connection factories.
Always The JMSXUserID property is always set with the security principal of the sending user no matter how the AttachJMSXUserID property is configured on connection factories.
This attribute is dynamically configurable. A dynamic change of this attribute will affect only messages received after the update has been made.
-
consumptionPausedAtStartup(optional):
boolean
Default Value:
false
Specifies whether consumption is paused on a destination at startup.
default If a JMS template is specified, then this value inherits the template's Consumption Paused At Startup value. If no JMS template is configured for the destination, then the Default value is equivalent to false
false Consumption Paused is explicitly disabled for this destination.
true Consumption Paused is explicitly turned on for this destination.
-
defaultTargetingEnabled(optional):
boolean
Default Value:
false
Specifies whether this JMS resource defaults to the parent module's targeting or uses the subdeployment targeting mechanism.
When set to true, this resource implicitly inherits the targeting of its parent module. When set to false, this resource gets targeted based its subdeployment's targets, if one is specified.
-
defaultUnitOfOrder(optional):
boolean
Default Value:
false
Specifies whether WebLogic Server creates a system-generated unit-of-order name based on the domain, JMS server, and destination name. Any message arriving at this destination that does not already belong to a unit-of-order is assigned this default name.
This field is recommended for advanced use. Generally, it is recommended to set a message unit-of-order using application calls or connection factory configuration. When relying on a destination default unit order to enforce ordering with a distributed destination, the application must be aware that unit-of-order routing doesn't apply. Instead the application must specifically ensure that any particular set of messages that must be processed in order are all sent to the same specific member destination even in the event of process failures or service migration.
-
destinationKeys(optional):
array Items
Title:
Items
The list of potential destination keys for sorting the messages that arrive on a JMS destination.
The keys are ordered from most significant to least significant. If more than one key is specified, a key based on the JMSMessageID can only be the last key in the list.
Note: If JMSMessageID is not defined in the key, it is implicitly assumed to be the last key and is set as "Ascending" (FIFO) for the sort order.
-
forwardDelay(optional):
integer(int32)
Default Value:
-1
The number of seconds after which a uniform distributed queue member with no consumers will wait before forwarding its messages to other uniform distributed queue members that do have consumers.
The default value of -1 disables this feature so that no messages are forwarded to other uniform distributed queue members.
Note: This attribute is ignored by standalone/singleton Queues, it only applies to distributed queues.
Constraints
- secure default : -1
-
id(optional):
integer(int64)
Read Only:
true
Return the unique identifier of this bean instance.
-
incompleteWorkExpirationTime(optional):
integer(int32)
Default Value:
-1
Specifies the maximum length of time, in milliseconds, before undelivered messages in an incomplete UOW are expired. Such messages will then follow the expiration policy defined for undeliverable messages.
Note: An error destination for UOW messages cannot be configured with a Unit-of-Work Handling Policy of Single Message Delivery value.
This attribute is effective only if the Unit-of-Work Handling Policy is set to Single Message Delivery value. A value of -1 means that UOW messages will never expire.
-
insertionPausedAtStartup(optional):
boolean
Default Value:
false
Specifies whether new message insertion is paused on a destination at startup.
default If a JMS template is specified, then this value inherits the template's Insertion Paused At Startup value. If no JMS template is configured for the destination, then the Default value is equivalent to false
false Insertion Paused is explicitly disabled for this destination.
true Insertion Paused is explicitly turned on for this destination.
-
JMSCreateDestinationIdentifier(optional):
string
Default Value:
oracle.doceng.json.BetterJsonNull@27f89d3b
A reference name for a destination or a member of a distributed destination that provides a way to lookup that destination without JNDI using
javax.jms.Session createQueue
orcreateTopic
. See "How to Lookup a Destination" in Programming JMS for more information on how to use this attribute.This name must be unique within the scope of the JMS server to which this destination is targeted. However, it does not need to be unique within the scope of an entire JMS module or WebLogic Cluster. For example, two queues can have the same destination name as long as those queues are targeted to different JMS servers.
Note: Since this name must be unique within the scope of a JMS server, verify whether other JMS modules may contain destination names that conflict with this name. It is the responsibility of the deployer to resolve the destination names targeted to JMS servers.
-
JNDIName(optional):
string
Default Value:
oracle.doceng.json.BetterJsonNull@3a8857d8
The global JNDI name used to look up the destination within the JNDI namespace.
In a clustered environment, this name is propagated to the entire cluster. If you want the JNDI name to be bound only on the local server, and not propagated to the rest of the cluster, then use the
Local JNDI Name
parameter.If not specified, the destination name will not be advertised through the global JNDI namespace.
-
loadBalancingPolicy(optional):
string
Default Value:
Round-Robin
Allowed Values:[ "Round-Robin", "Random" ]
Determines how messages are distributed to the members of this destination.
Choose from the following distribution techniques:
Round-Robin The system maintains an ordering of physical topic members within the set by distributing the messaging load across the topic members one at a time in the order that they are defined in the configuration file. Each WebLogic Server instance maintains an identical ordering, but may be at a different point within the ordering. If weights are assigned to any of the topic members in the set, then those members appear multiple times in the ordering.
Random The weight assigned to the topic members is used to compute a weighted distribution for the members of the set. The messaging load is distributed across the topic members by pseudo-randomly accessing the distribution. In the short run, the load will not be directly proportional to the weight. In the long run, the distribution will approach the limit of the distribution. A pure random distribution can be achieved by setting all the weights to the same value, which is typically set to 1.
Note: This attribute is ignored by standalone/singleton Queues and Topics, it only applies to distributed destinations.
-
localJNDIName(optional):
string
Default Value:
oracle.doceng.json.BetterJsonNull@8394219
The local JNDI name used to look up the destination within the JNDI namespace of the server where the destination resource is targeted. In a clustered environment, this name is bound only on the local server instance and is not propagated to the rest of the cluster.
A destination can have both a local JNDI name and a (global) JNDI name.
-
maximumMessageSize(optional):
integer(int32)
Minimum Value:
0
Maximum Value:2147483647
Default Value:2147483647
The maximum size of a message that is accepted from producers on this destination.
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 destination receive aResourceAllocationException
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.
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
-
messagingPerformancePreference(optional):
integer(int32)
Minimum Value:
0
Maximum Value:100
Default Value:25
Controls how long destinations are willing to wait to create full batches of available messages (if at all) for delivery to consumers. At the minimum value, batching is disabled; at the default value, less-than-full batches will not wait and are delivered immediately with currently available messages; tuning higher than the default value controls the maximum wait time for additional messages before less-than-full batches are delivered to consumers.
The maximum message count of a full batch is controlled by the JMS connection factory's Messages Maximum setting.
-
name(optional):
string
Read Only:
true
The name of this entity, represented in XML as an attribute.
Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.
This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.
Constraints
- legal null
-
notes(optional):
string
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.
-
productionPausedAtStartup(optional):
boolean
Default Value:
false
Specifies whether new message production is paused on a destination at startup.
default If a JMS template is specified, then this value inherits the template's Production Paused At Startup value. If no JMS template is configured for the destination, then the Default value is equivalent to false
false Production Paused is explicitly disabled for this destination.
true Production Paused is explicitly turned on for this destination.
-
quota(optional):
array Quota Reference
Title:
Quota Reference
Contains the quota reference.A Quota controls the allotment of system resources available to destinations. For example, the number of bytes a destination is allowed to store can be configured with a Quota.
-
resetDeliveryCountOnForward(optional):
boolean
Default Value:
true
Determines whether or not the delivery count is reset during message forwarding between distributed queue members.
The default value of true resets the delivery counts on messages when they are forwarded to another distributed queue member.
Note: This attribute is ignored by standalone/singleton Queues, it only applies to distributed queues.
-
SAFExportPolicy(optional):
string
Default Value:
All
Allowed Values:[ "All", "None" ]
Specifies whether a user can send messages to a destination using Store-and-Forward.
All All users can send messages to this destination using Store-and-Forward.
None Remote users can not send messages to a destination using Store-and-Forward.
This attribute is dynamically configurable. A dynamic change of this attribute will affect only messages sent after the update has been made.
-
subDeploymentName(optional):
string
Gets the name of the sub-deployment to use when targeting this entity
Entities are targeted using a sub-deployment with this name. The targets of the sub-deployment will be the targets of this entity.
-
template(optional):
array Template Reference
Title:
Template Reference
Contains the template reference.The JMS template from which the destination is derived. A template provides an efficient means of defining multiple destinations with similar configuration values.
If a JMS template is specified, destination parameters that are set to their default values will instead inherit their values from the JMS template at run-time. However, if a JMS template is not defined, then the configuration values for the destination must be specified as part of the destination.
Although you can dynamically modify the configuration of a JMS template, the configuration values on a destination are static.
Constraints
- restart required
-
unitOfOrderRouting(optional):
string
Default Value:
Hash
Determines how a distributed destination member is selected as the destination for a message that is part of a unit-of-order. Hash, indicates that a message producer computes the member destination from the
hashCode
of the unit-of-order. PathService indicates that the configured Path Service determines the member destination.Unit-of-Order Routing can be set programmatically with WLProducer, or administratively on the connection factory or destination.
Unit of Order Routing is not dynamically configurable.
Note: This attribute is ignored by standalone/singleton Queues and Topics, it only applies to distributed destinations.
-
unitOfWorkHandlingPolicy(optional):
string
Default Value:
PassThrough
Allowed Values:[ "PassThrough", "SingleMessageDelivery" ]
Specifies whether the Unit-of-Work (UOW) feature is enabled for this destination. A UOW is a set of messages that are processed as a single unit.
Pass-Through By default, this destination does not treat messages as part of a UOW.
Single Message Delivery This value should only be selected if UOW consumers are receiving messages on this destination. When selected, UOW messages are formed into a list and are consumed as an
ObjectMessage
containing the list.
array
Items
The list of potential destination keys for sorting the messages that arrive on a JMS destination.
The keys are ordered from most significant to least significant. If more than one key is specified, a key based on the JMSMessageID can only be the last key in the list.
Note: If JMSMessageID is not defined in the key, it is implicitly assumed to be the last key and is set as "Ascending" (FIFO) for the sort order.
array
Quota Reference
A Quota controls the allotment of system resources available to destinations. For example, the number of bytes a destination is allowed to store can be configured with a Quota.
array
Template Reference
The JMS template from which the destination is derived. A template provides an efficient means of defining multiple destinations with similar configuration values.
If a JMS template is specified, destination parameters that are set to their default values will instead inherit their values from the JMS template at run-time. However, if a JMS template is not defined, then the configuration values for the destination must be specified as part of the destination.
Although you can dynamically modify the configuration of a JMS template, the configuration values on a destination are static.
Constraints
- restart required