This appendix describes the Java EE JMS resource definition elements and properties in the following sections:
This section describes the elements that you specify when you configure the connection factory in an application module by using the JMS resource definitions as described in Defining JMS Resources Using Java EE Resource Definitions.
The following example defines a connection factory using the @JMSConnectionFactoryDefinition
annotation:
@JMSConnectionFactoryDefinition( name="java:global/jms/demoConnectionFactory", className= "javax.jms.ConnectionFactory", description="Sample description for Connection Factory", clientId="client_Id01", transactional=true, properties= {"UserName=myuser", "delivery-mode=Persistent", "load-balancing-enabled=true"}
For more information about the JMSConnectionFactoryDefinition
annotation, see http://docs.oracle.com/javaee/7/api/javax/jms/JMSConnectionFactoryDefinition.html
.
Table A-1 describes the elements that you can use with @JMSConnectionFactoryDefinition
.
For the element definitions in the JMS application module, see the weblogic-jms.xsd
schema available at http://xmlns.oracle.com/weblogic/weblogic-jms/1.4/weblogic-jms.xsd
.
Table A-1 @JMSConnectionFactoryDefinition Elements
Element in @JMSConnectionFactoryDefinition | Equivalent Element in the JMS Application Module | Type | Description |
---|---|---|---|
|
|
String |
The JNDI name of the JMS connection factory that is being defined. Note: This is a mandatory element. |
|
|
String |
A description of the connection factory. |
|
|
String |
The client id to be used for the connection. |
|
|
Boolean |
Specifies whether the connections participate in transactions. Set this property to Default value is |
|
None |
String |
The name of the resource adapter. |
|
None |
String |
This value is ignored. |
|
None |
String |
This value is ignored |
|
None |
Int |
This value is ignored |
|
None |
Int |
This value is ignored. |
|
None |
String |
This value is ignored. |
|
None |
String |
This value is ignored. |
JMS Connection Factory Properties
Note:
The properties defined in this section apply only when the connection factory definition does not specify an adapter. When an adapter is specified, properties that are unique to the adapter will be considered.Table A-2 describes the properties that you can use with the properties
element of @JMSConnectionFactoryDefinition
.
Table A-2 @JMSConnectionFactoryDefinition Properties
@JMSConnectionFactoryDefinition Property | Equivalent Element in the JMS Application Module | Type | Description |
---|---|---|---|
|
|
String |
A name for the connection factory. When not specified, the name will be |
|
|
String |
The JMS server to which the resource will be targeted. If the |
|
|
Boolean |
Set this property to This value is ignored when |
Table A-3 describes the default message delivery properties that you can specify in the properties
element of @JMSConnectionFactoryDefinition
.
For more information about these properties, see "JMS Connection Factory: Configuration: Default Delivery" section in Oracle WebLogic Server Administration Console Online Help.
Table A-3 @JMSConnectionFactoryDefinition Properties for Default Message Delivery
@JMSConnectionFactoryDefinition Property | Equivalent default-delivery-params element in the JMS Application Module | Type | Description |
---|---|---|---|
|
|
String |
The delivery mode assigned to all messages sent by a producer using the connection factory that is being defined. Accepted values: |
|
|
String |
The delay time, in milliseconds, between when a message is produced and when it is made visible on its destination. |
|
|
Long |
The maximum length of time, in milliseconds, that a message will exist. This value is used for messages when a priority is not explicitly defined. |
|
|
Int |
The default priority used for messages when a priority is not explicitly defined. |
|
|
Long |
The delay time, in milliseconds, before rolled back or recovered messages are redelivered. |
|
|
Int |
The number of bytes for a serialized message body so any message that exceeds this limit will trigger message compression when the message is sent or received by the JMS message producer or consumer. |
|
|
String |
The default Unit-of-Order producer for this connection factory. Options are: System-generated and User-Generated |
|
|
Long |
The maximum length of time, in milliseconds, that a sender will wait when there is not enough available space (no quota) on a destination to accommodate the message being sent. |
Table A-4 describes the client parameters that you can specify in the properties
element of @JMSConnectionFactoryDefinition
.
For more information about these properties, see "JMS Connection Factory: Configuration: Client" in Oracle WebLogic Server Administration Console Online Help.
Table A-4 @JMSConnectionFactoryDefinition Client Properties
@JMSConnectionFactoryDefinition Property | Equivalent client-params element in the JMS Application Module | Type | Description |
---|---|---|---|
|
|
String |
Specifies whether more than one JMS connection can use the same Client ID. Valid options are |
|
|
String |
The subscription sharing policy on the connection. Valid options are |
|
|
String |
The client acknowledge policy for non-transacted sessions that use the Valid options are |
|
|
Boolean |
Specifies whether the connection factory creates message consumers that allow a Note: The default value of this property is |
|
|
Int |
The maximum number of messages that can exist for an asynchronous session and that have not yet been passed to the message listener. |
|
|
String |
The policy to be used when the number of outstanding multicast messages reaches the value specified in Valid options are |
|
|
String |
Specifies whether a synchronous consumer will prefetch messages (that is, messages sent from the server to the client) in one server access. Valid options are |
|
|
String |
Specifies which types of JMS clients will be explicitly and implicitly refreshed after a lost network connection with a server or upon a server reboot. Valid options are |
|
|
Long |
The maximum length of time, in milliseconds, that any synchronous JMS calls will block the calling thread before giving up on a JMS client reconnect in progress. |
|
|
Long |
The maximum length of time, in milliseconds, that JMS clients (particularly asynchronous consumers) will continue to try to reconnect to the server after either the initial network disconnect or the last synchronous call attempt, whichever occurred most recently, before giving up retrying. |
Table A-5 describes the transaction parameters that you can specify in the properties
element of @JMSConnectionFactoryDefinition
.
For more information about these properties, see "JMS Connection Factory: Configuration: Transaction" in Oracle WebLogic Server Administration Console Online Help.
Table A-5 @JMSConnectionFactoryDefinition Transaction Properties
@JMSConnectionFactoryDefinition Property | Equivalent transaction-params element in the JMS Application Module | Type | Description |
---|---|---|---|
|
|
Long |
The timeout value (in seconds) for all transactions on connections created with the connection factory. Set this property only when |
Table A-6 describes the flow control parameters that you can specify in the properties
element of @JMSConnectionFactoryDefinition
.
For more information about these properties, see "JMS Connection Factory: Configuration: Flow Control" in Oracle WebLogic Server Administration Console Online Help.
Table A-6 @JMSConnectionFactoryDefinition Flow Control Properties
@JMSConnectionFactoryDefinition Property | Equivalent flow-control-params element in the JMS Application Module | Type | Description |
---|---|---|---|
|
|
Int |
The maximum number of messages-per-second allowed for a producer that is experiencing a threshold condition. When a producer is flow controlled it will never be allowed to go faster than the FlowMaximum messages per second. |
|
|
Int |
The minimum number of messages-per-second allowed for a producer that is experiencing a threshold condition. This is the lower boundary of a producer's flow limit. That is, WebLogic JMS will not further slow down a producer whose message flow limit is at its FlowMinimum. |
|
|
Int |
The adjustment period of time, in seconds, when a producer adjusts its flow from the FlowMaximum number of messages to the FlowMinimum amount, or vice versa. |
|
|
Int |
The number of steps used when a producer is adjusting its flow from the Flow Maximum amount of messages to the Flow Minimum amount, or vice versa. |
|
|
Boolean |
Specifies whether a producer created using a connection factory allows flow control. |
|
|
String |
Specifies whether message producers created using this connection factory are allowed to do one-way message sends to improve typical non-persistent, non-transactional messaging performance. Valid options are |
|
|
Int |
The maximum number of sent messages per window when |
Table A-7 describes the load balancing parameters that you can specify in the properties
element of @JMSConnectionFactoryDefinition
.
For more information about these properties, see "JMS Connection Factory: Configuration: Load Balancing" in Oracle WebLogic Server Administration Console Online Help.
Table A-7 @JMSConnectionFactoryDefinition Load Balancing Properties
@JMSConnectionFactoryDefinition Property | Equivalent load-balancing-params element in the JMS Application Module | Type | Description |
---|---|---|---|
|
|
Boolean |
Specifies whether non-anonymous producers created through a connection factory are load balanced within a distributed destination on a per-call basis. |
|
|
Boolean |
Specifies whether a server instance that is load balancing consumers or producers across multiple members destinations of a distributed destination, will first attempt to load balance across any other physical destinations that are also running on the same server instance. |
Table A-8 describes the security parameters that you can specify in the properties
element of @JMSConnectionFactoryDefinition
.
For more information about these properties, see "JMS Connection Factory: Configuration: Security" in Oracle WebLogic Server Administration Console Online Help.
Table A-8 @JMSConnectionFactoryDefinition Load Balancing Properties
@JMSConnectionFactoryDefinition Property | Equivalent security-params element in the JMS Application Module | Type | Description |
---|---|---|---|
|
|
Boolean |
Specifies whether non-anonymous producers created through a connection factory are load balanced within a distributed destination on a per-call basis. |
This section describes the elements that you specify when you configure a JMS destination resource in an application module by using the JMS resource definitions as described in Defining JMS Resources Using Java EE Resource Definitions.
The following example defines a destination using the @JMSDestinationDefinition
annotation:
@JMSDestinationDefinition( name="java:global/jms/demoDestination", interfaceName="javax.jms.Queue", className= "javax.jms.Queue", description="Sample description for Queue", destinationName="myQueue", properties= {"default-unit-of-order=true", "time-to-deliver=Persistent", "attach-sender=always"}
For more information about the JMSDestinationDefinition
annotation, see http://docs.oracle.com/javaee/7/api/javax/jms/JMSDestinationDefinition.html
.
Table A-9 describes the elements that you can use with @JMSDestinationDefinition
.
For the element definitions in the JMS application module, see the weblogic-jms.xsd
schema available at http://xmlns.oracle.com/weblogic/weblogic-jms/1.4/weblogic-jms.xsd
.
Table A-9 @JMSDestinationDefinition Elements
Element in @JMSDestinationDefinition | Equivalent Element in the JMS Application Module | Type | Description |
---|---|---|---|
|
|
String |
The JNDI name of the JMS destination resource that is being defined. Note: This is a mandatory element. |
|
or
|
String |
The fully qualified name of the JMS destination interface. Valid options are The JMS destination definition will be converted to a JMS module with entity of type Note: This is a mandatory element. |
|
|
String |
A description for the JMS destination that is being defined. |
|
|
String |
The runtime MBean name of the queue or topic. When not specified, the destination name will be |
|
None |
- |
This value is ignored. |
|
None |
- |
This value is ignored |
Table A-10 describes the properties that you can define using the properties
element of @JMSDestinationDefinition
.
Table A-10 @JMSDestinationDefinition Properties
@JMSDestinationDefinition Property | Equivalent Element in the JMS Application Module | Type | Description |
---|---|---|---|
|
|
String |
The JMS server to which the resource will be targeted. If the |
|
|
Boolean |
Set this property to This value is ignored when |
Table A-11 describes the properties that define upper and lower byte and/or message thresholds for a destination. You can define these parameters in the properties
element of @JMSDestinationDefinition
.
For more information about these properties, see "Uniform Distributed Topic: Configuration: Thresholds and Quotas" section in Oracle WebLogic Server Administration Console Online Help.
Table A-11 @JMSDestinationDefinition Threshold Properties
@JMSDestinationDefinition Property | Equivalent thresholds element in the JMS Application Module |
Type | Description |
---|---|---|---|
|
|
Long |
The upper threshold (total number of bytes in this destination) that triggers logging or flow control events. |
|
|
Long |
The lower threshold (total number of bytes in this destination) that triggers logging or flow control events. |
|
|
Long |
The upper threshold (total number of messages in this destination) that triggers logging or flow control events. |
|
|
Long |
The lower threshold (total number of messages in this destination) that triggers logging or flow control events. |
Table A-12 describes the properties that define message delivery overrides for a destination. You can define these parameters in the properties
element of @JMSDestinationDefinition
.
For more information about these properties, see "Uniform Distributed Topic: Configuration: Overrides" section in Oracle WebLogic Server Administration Console Online Help.
Table A-12 @JMSDestinationDefinition Message Delivery Override Properties
@JMSDestinationDefinition Property | Equivalent delivery-params-overrides element in the JMS Application Module |
Type | Description |
---|---|---|---|
|
|
String |
The delivery mode assigned to all messages that arrive at the destination regardless of the DeliveryMode specified by the message producer. Valid options are |
|
|
String |
The delivery delay, either in milliseconds or as a schedule, between when a message is produced and when it is made visible on its target distributed destination. |
|
|
Long |
The time-to-live assigned to all messages that arrive at the destination, regardless of the TimeToLive value specified by the message producer. |
|
|
Int |
The priority assigned to all messages that arrive at the destination, regardless of the Priority specified by the message producer. |
|
|
Long |
The delay, in milliseconds, before rolled back or recovered messages are redelivered, regardless of the RedeliveryDelay specified by the consumer and/or connection factory. For more information, see "Uniform Distributed Topic: Configuration: Redelivery" section in Oracle WebLogic Server Administration Console Online Help. |
Table A-13 describes the message delivery failure parameters for a destination. You can define these parameters in the properties
element of @JMSDestinationDefinition
.
For more information about these properties, see "Uniform Distributed Topic: Configuration: Redelivery" section in Oracle WebLogic Server Administration Console Online Help.
Table A-13 @JMSDestinationDefinition Message Delivery Failure Properties
@JMSDestinationDefinition Property | Equivalent delivery-failure-params element in the JMS Application Module |
Type | Description |
---|---|---|---|
|
|
Int |
The number of redelivery tries a message can have before it is moved to the error destination. |
|
|
String |
The message Expiration Policy to be used when an expired message is encountered on a destination. Valid options are |
|
|
String |
Specifies what information about the message is logged when the Expiration Policy is set to |
Table A-14 describes the message life cycle logging options for a distributed destination. You can define these parameters in the properties
element of @JMSDestinationDefinition
.
For more information about these properties, see "Uniform Distributed Topic: Configuration: Logging" section in Oracle WebLogic Server Administration Console Online Help.
Table A-14 @JMSDestinationDefinition Message Logging Properties
@JMSDestinationDefinition Property | Equivalent message-logging-params element in the JMS Application Module |
Type | Description |
---|---|---|---|
|
|
Boolean |
Specifies whether the module logs information about the message life cycle. |
|
|
String |
Defines which information about the message is logged. This property is defined as shown in the following example: @JMSDestinationDefinition(name = "java:global/jms/testDestination", interfaceName = "javax.jms.Queue", destinationName = "testDestination", properties={"message-logging-format=%header%,%properties%"}) For more information about the valid values for this property, see the description for |
Table A-15 describes the advanced configuration options for a distributed destination. You can define these parameters in the properties
element of @JMSDestinationDefinition
.
For more information about these properties, see Advanced Configuration Options in "Uniform Distributed Topic: Configuration: General" section in Oracle WebLogic Server Administration Console Online Help.
Table A-15 @JMSDestinationDefinition Advanced Configuration Options
@JMSDestinationDefinition Property | Equivalent Element in the JMS Application Module | Type | Description |
---|---|---|---|
|
|
String |
Determines how messages are distributed to the members of this destination. Valid options are |
|
|
Boolean |
Specifies whether new message production is paused on a destination at startup. |
|
|
Boolean |
Specifies whether new message insertion is paused on a destination at startup. |
|
|
Boolean |
Specifies whether consumption is paused on a destination at startup. |
|
|
Boolean |
Specifies whether WebLogic Server creates a system-generated unit-of-order name based on the domain, JMS server, and destination name. |
|
|
String |
Determines how a distributed destination member is selected as the destination for a message that is part of a unit-of-order. Valid options are |
|
|
String |
Specifies whether messages landing on this destination should attach the credential of the sending user. Valid options are |
|
|
String |
A reference name for a destination or a member of a distributed destination that provides a way to lookup that destination without JNDI using |
|
|
String |
Specifies whether a user can send messages to a destination using Store-and-Forward. Valid options are |
|
|
Int |
This parameter determines how long destinations are willing to wait to create full batches of available messages (if at all) for delivery to consumers. |
|
|
String |
Specifies whether the Unit-of-Work (UOW) feature is enabled for this destination. Valid options are |
|
|
Int |
Specifies the maximum length of time, in milliseconds, before undelivered messages in an incomplete UOW are expired. |
|
|
Int |
The maximum size of a message that is accepted from producers on the destination. For more information, see the description for Maximum Message Size in "Uniform Distributed Topic: Configuration: Thresholds and Quotas" in Oracle WebLogic Server Administration Console Online Help. |
Table A-16 describes the properties that are specific to a uniform distributed queue. You can define these parameters in the properties
element of @JMSDestinationDefinition
.
Note:
These properties are applicable only when theinterfaceName
element of @JMSDestinationDefinition
is set to javax.jms.Queue
.For more information about these properties, see "Uniform Distributed Queue: Configuration: General" section in Oracle WebLogic Server Administration Console Online Help.
Table A-16 @JMSDestinationDefinition Properties for Queue Destinations
@JMSDestinationDefinition Property | Equivalent element in the JMS Application Module | Type | Description |
---|---|---|---|
|
|
Int |
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. |
|
|
Boolean |
Determines whether or not the delivery count is reset during message forwarding between distributed queue members. |
Table A-17 describes the properties that are specific to a uniform distributed topic. You can define these parameters in the properties
element of @JMSDestinationDefinition
.
Note:
These properties are applicable only when theinterfaceName
element of @JMSDestinationDefinition
is set to javax.jms.Topic
.For more information about these properties, see "Uniform Distributed Topic: Configuration: General" and "Uniform Distributed Topic: Multicast" sections in Oracle WebLogic Server Administration Console Online Help.
Table A-17 @JMSDestinationDefinition Properties for Topic Destinations
@JMSDestinationDefinition Property | Equivalent element in the JMS Application Module | Type | Description |
---|---|---|---|
|
|
String |
The uniform distributed topic message Forwarding Policy specifies whether a sent message is forwarded to all members. Valid options are When a destination is created by using JMS destination definition, the default value of this property will be Note: You cannot deploy the JMS module to a Resource Group or a Resource Group Template if the Uniform Distributed Topic has the forwarding policy set to |
|
|
String |
The address used by the topic to transmit messages to multicast consumers. |
|
|
Int |
The Time-To-Live value used for multicasting, which specifies the number of routers that the message can traverse en route to the consumers. |
|
|
Int |
The port used by the topic to transmit messages to multicast consumers. |