Difference between revisions of "Jms-dequeue"

From GreenVulcano Wiki
Jump to: navigation, search
(→‎{{VULCON}} / {{GVCONSOLE}} Configuration)
 
(7 intermediate revisions by 2 users not shown)
Line 20: Line 20:
 
|retCode ||    RET_CODE
 
|retCode ||    RET_CODE
 
|-
 
|-
−
|properties || p$<property name> (only GVBuffer properties with names that are valid Java identifier are managed)
+
|properties || p$<property name> (only [[GVBuffer]] properties with names that are valid Java identifier are managed)
 
|}
 
|}
  
−
If it is not defined a Data Provider, the GVBuffer object field contains the received message.
+
If it is not defined a Data Provider, the [[GVBuffer]] object field contains the received message.
 
Can be defined a JMS message selector to filter messages.
 
Can be defined a JMS message selector to filter messages.
  
 
It has the attributes:
 
It has the attributes:
−
 
+
{|class="gvtable"
−
* ''type'': dequeue.
+
! Attribute !! Type !! Description
−
* ''class'': it.greenvulcano.gvesb.virtual.j2ee.JMSDequeueOperation.
+
|-
−
* ''name'': Operation name. Used in the [[Flow]] section to associate workflow nodes to VCL operations.
+
| type || fixed || This attribute must assume the value '''dequeue'''.
−
* ''connection-factory'': JMS connection factory JNDI name.
+
|-
−
* ''destination-name'': Destination JNDI name. Set appropriately the ''destination-type'' parameter.
+
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.j2ee.JMSDequeueOperation'''.
−
* ''destination-type'': Destination type. Default: queue. <br/> The attribute's admitted values are:
+
|-
−
** queue
+
| name || required || Operation name. Used in the [[Flow]] section to associate workflow nodes to VCL operations.
−
** topic
+
|-
−
* ''transacted'': Specifies whether the dequeue has to open his own transaction or fall in a global transaction.
+
| connection-factory || required || JMS connection factory JNDI name.
−
** 'true' open his own transaction and do not fall in the global transaction.
+
|-
−
** 'false' fall in the active global transaction. Must be used a XA connection factory.
+
| destination-name || required || Destination JNDI name. Set appropriately the ''destination-type'' parameter.
 +
|-
 +
| destination-type || optional || Destination type. Default: queue. <br/> The attribute's admitted values are:
 +
* queue
 +
* topic
 +
|-
 +
| transacted || optional || Specifies whether the dequeue has to open his own transaction or fall in a global transaction.
 +
* 'true' open his own transaction and do not fall in the global transaction.
 +
* 'false' fall in the active global transaction. Must be used a XA connection factory.
 
: This parameter is not relevant if the connection factory is not XA. Default: false.
 
: This parameter is not relevant if the connection factory is not XA. Default: false.
−
* ''acknowledge-type'':In transactional dequeue acknowledgment is managed by the application server. <br/> This parameter is meaningful only for non-transactional dequeue and can take the following values:
+
|-
−
** auto-acknowledge: the acknowledgment from application server is automatically given upon delivery of the message.
+
| acknowledge-type || optional || In transactional dequeue acknowledgement is managed by the application server. <br/> This parameter is meaningful only for non-transactional dequeue and can take the following values:
−
** client-acknowledge: the client must explicitly acknowledgment the message.
+
* auto-acknowledge: the acknowledgement from application server is automatically given upon delivery of the message.
−
** dups-ok-acknowledge: allows the JMS server to perform optimizations on the logic of acknowledgment messages, but can cause the redelivery of messages. Should only be used with systems that are tolerant to duplicated message. Default: auto-acknowledge
+
* client-acknowledge: the client must explicitly acknowledgement the message.
−
* ''receive-type'': Allows you to specify whether the receipt should be made in blocking mode, non-blocking mode, or with timeout.
+
* dups-ok-acknowledge: allows the JMS server to perform optimizations on the logic of acknowledgement messages, but can cause the redelivery of messages. Should only be used with systems that are tolerant to duplicated message. Default: auto-acknowledge
−
** non-blocking: is performed a non-blocking receive. If a message is already queued then it's immediately read. <br> If there are no messages available then {{GVESB}} throws a time-out exception.
+
|-
−
** timeout: is performed a timeout receive. {{GVESB}} wait for the specified time. If a message is queued then it's immediately read. <br/> If there are no messages available then {{GVESB}} throws a time-out exception.
+
| receive-type || required || Allows you to specify whether the receipt should be made in blocking mode, non-blocking mode, or with timeout.
−
** blocking: the current thread blocks indefinitely until a message arrives. Use with caution.
+
* non-blocking: is performed a non-blocking receive. If a message is already queued then it's immediately read. <br> If there are no messages available then {{GVESB}} throws a time-out exception.
−
* ''receive-timeout'': Time-out duration in ms. This parameter is meaningful only if ''receive-type'' is set to ''time out''. <br/> If 'receive-type' is set to 'time out' and 'receive-timeout' is not defined, then is assumed a timeout of 1000 ms.
+
* timeout: is performed a timeout receive. {{GVESB}} wait for the specified time. If a message is queued then it's immediately read. <br/> If there are no messages available then {{GVESB}} throws a time-out exception.
−
* ''receive-timeout-overridable'': Specifies whether the value set to 'receive-timeout' can be overwritten at runtime. Reserved for future use. The attribute's default value is: false. The attribute's admitted values are:
+
* blocking: the current thread blocks indefinitely until a message arrives. Use with caution.
−
** false
+
|-
−
** true
+
| receive-timeout || optional || Time-out duration in ms. This parameter is meaningful only if ''receive-type'' is set to ''time out''. <br/> If 'receive-type' is set to 'time out' and 'receive-timeout' is not defined, then is assumed a timeout of 1000 ms.
−
* ''durable-subscriber'': Specifies the name of the durable subscriber. Durable subscriptions provide the receipt of all messages sent to the topic, even if the subscribers are not running when the messages are sent.
+
|-
−
* ''no-local'': Avoid receiving local messages. Reserved for future use. The attribute's admitted values are:
+
| receive-timeout-overridable || optional || Specifies whether the value set to 'receive-timeout' can be overwritten at runtime. Reserved for future use. The attribute's default value is: false. The attribute's admitted values are:
−
** true
+
* false
−
** false
+
* true
−
* ''use-vcl-pool'': Indicates whether to use connection pooling capabilities of the VCL. Set to false if the container provides pooling capabilities.
+
|-
 +
| durable-subscriber || optional || Specifies the name of the durable subscriber. Durable subscriptions provide the receipt of all messages sent to the topic, even if the subscribers are not running when the messages are sent.
 +
|-
 +
| no-local || optional || Avoid receiving local messages. Reserved for future use. The attribute's admitted values are:
 +
* true
 +
* false
 +
|-
 +
| use-vcl-pool || optional || Indicates whether to use connection pooling capabilities of the VCL. Set to false if the container provides pooling capabilities.
 
Default: true
 
Default: true
−
* ''invalidate-conn-on-pool-insertion'': Indicates whether connections should be marked as invalid before reinsertion on the pool. Is significant only if the pooling feature is enabled. Default: false. The attribute's admitted values are:
+
|-
−
** false
+
| invalidate-conn-on-pool-insertion || optional || Indicates whether connections should be marked as invalid before reinsertion on the pool. Is significant only if the pooling feature is enabled. Default: false. The attribute's admitted values are:
−
** true
+
* false
−
* ''ref-dp'': Name of Data Provider to use. This Data Provider will receive in input a JMS Message and must return the object to be inserted in GVBuffer.
+
* true
−
* ''dump-message'': If true the dequeued message is dumped on log file, at DEBUG severity level. Default false. The attribute's admitted values are:
+
|-
−
** true
+
| ref-dp || optional || Name of [[Data_provider|Data Provider]] to use. This Data Provider will receive in input a JMS Message and must return the object to be inserted in [[GVBuffer]].
−
** false
+
|-
 +
| dump-message || optional || If true the dequeued message is dumped on log file, at DEBUG severity level. Default false. The attribute's admitted values are:
 +
* true
 +
* false
 +
|}
 +
<div class="version_ge3.4/3.3.4">
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| keep-input-extra-properties || optional || Specifies if the dequeue must keep input GVBuffer properties, not present in the JMS message, in the output GVBuffer. Default false. The attribute's admitted values are:
 +
* true
 +
* false
 +
|}
 +
</div>
 +
<div class="version_ge3.4.0.7">
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| decorate-gvbuffer || optional || If true the output GVBuffer is enriched with the received message properties value. Default true. The attribute's admitted values are:
 +
* true
 +
* false
 +
|}
 +
</div>
  
 
Its subelements are:
 
Its subelements are:
Line 70: Line 107:
 
* Description
 
* Description
 
* [[JNDIHelper]]
 
* [[JNDIHelper]]
−
* message-selector
+
* [[message-selector]]
 
* [[ServiceAlias]]
 
* [[ServiceAlias]]
−
* XAHelper
+
* [[XAHelper]]
−
 
 
−
===message-selector===
 
−
 
 
−
This element allows you to specify a selector for receiving messages. See the JMS documentation for the selector syntax.
 
−
 
 
−
The properties (and their types) provided by {{GVESB}} for selectors are:
 
−
* SYSTEM (String)
 
−
* SERVICE (String)
 
−
* ID (String)
 
−
* RETCODE (int)
 
−
 
 
−
Even [[GVBuffer]] properties are present in the form of message properties.
 
−
 
 
−
The properties are all string and their names have the prefix ''$p'' (only [[GVBuffer]] properties with names that are valid
 
−
Java identifier are managed). For example, a [[GVBuffer]] property named PROPERTY will be identified by a property name p$PROPERTY.
 
−
 
 
−
As {{GVESB}} can in turn generate selectors, you can define how they should be combined with the selector specified by this element, see ''combining'' attribute.
 
−
 
 
−
The message-selector Element is used by '''jms-dequeue''' and has the following attributes:
 
−
* ''combining'': {{GVESB}} can dynamically generate selectors. This parameter defines how the dynamicselector should be combined with the selector configured to obtain the actual selector used for reception of JMS message. Can take the following values:
 
−
** dynamic-and-configured (DYNAMIC) AND (CONFIGURED)
 
−
** dynamic-or-configured (DYNAMIC) OR (CONFIGURED)
 
−
** dynamic-only DYNAMIC
 
−
** configured-only CONFIGURED
 
−
** configured-if-no-dynamic DYNAMIC != null ? DYNAMIC : CONFIGURED. The attribute's default value is: dynamic-and-configured.
 
−
 
 
−
===XAHelper===
 
−
 
 
−
The XAHelper Element is used by [[jms-dequeue]] and '''jms-enqueue'''.
 
−
 
 
−
Its attributes are:
 
−
* ''auto-enlist'': The attribute's default value is: false.
 
−
* ''transaction-status'': The attribute's admitted values are:
 
−
** TMSUCCESS: default value
 
−
** TMFAIL
 
−
 
 
−
and its subelements:
 
−
* Description
 
−
* [[JNDIHelper]]
 

Latest revision as of 15:46, 10 June 2015

Description

The jms-dequeue element allows you to perform a dequeue from a JMS destination.

VulCon / GV Console Configuration

It is used by Channel and routed-dequeue.

JMS message properties are mapped to GVBuffer fields:

Field JMS
system SYSTEM
service SERVICE
id ID
retCode RET_CODE
properties p$<property name> (only GVBuffer properties with names that are valid Java identifier are managed)

If it is not defined a Data Provider, the GVBuffer object field contains the received message. Can be defined a JMS message selector to filter messages.

It has the attributes:

Attribute Type Description
type fixed This attribute must assume the value dequeue.
class fixed This attribute must assume the value it.greenvulcano.gvesb.virtual.j2ee.JMSDequeueOperation.
name required Operation name. Used in the Flow section to associate workflow nodes to VCL operations.
connection-factory required JMS connection factory JNDI name.
destination-name required Destination JNDI name. Set appropriately the destination-type parameter.
destination-type optional Destination type. Default: queue.
The attribute's admitted values are:
  • queue
  • topic
transacted optional Specifies whether the dequeue has to open his own transaction or fall in a global transaction.
  • 'true' open his own transaction and do not fall in the global transaction.
  • 'false' fall in the active global transaction. Must be used a XA connection factory.
This parameter is not relevant if the connection factory is not XA. Default: false.
acknowledge-type optional In transactional dequeue acknowledgement is managed by the application server.
This parameter is meaningful only for non-transactional dequeue and can take the following values:
  • auto-acknowledge: the acknowledgement from application server is automatically given upon delivery of the message.
  • client-acknowledge: the client must explicitly acknowledgement the message.
  • dups-ok-acknowledge: allows the JMS server to perform optimizations on the logic of acknowledgement messages, but can cause the redelivery of messages. Should only be used with systems that are tolerant to duplicated message. Default: auto-acknowledge
receive-type required Allows you to specify whether the receipt should be made in blocking mode, non-blocking mode, or with timeout.
  • non-blocking: is performed a non-blocking receive. If a message is already queued then it's immediately read.
    If there are no messages available then GreenVulcano® ESB throws a time-out exception.
  • timeout: is performed a timeout receive. GreenVulcano® ESB wait for the specified time. If a message is queued then it's immediately read.
    If there are no messages available then GreenVulcano® ESB throws a time-out exception.
  • blocking: the current thread blocks indefinitely until a message arrives. Use with caution.
receive-timeout optional Time-out duration in ms. This parameter is meaningful only if receive-type is set to time out.
If 'receive-type' is set to 'time out' and 'receive-timeout' is not defined, then is assumed a timeout of 1000 ms.
receive-timeout-overridable optional Specifies whether the value set to 'receive-timeout' can be overwritten at runtime. Reserved for future use. The attribute's default value is: false. The attribute's admitted values are:
  • false
  • true
durable-subscriber optional Specifies the name of the durable subscriber. Durable subscriptions provide the receipt of all messages sent to the topic, even if the subscribers are not running when the messages are sent.
no-local optional Avoid receiving local messages. Reserved for future use. The attribute's admitted values are:
  • true
  • false
use-vcl-pool optional Indicates whether to use connection pooling capabilities of the VCL. Set to false if the container provides pooling capabilities.

Default: true

invalidate-conn-on-pool-insertion optional Indicates whether connections should be marked as invalid before reinsertion on the pool. Is significant only if the pooling feature is enabled. Default: false. The attribute's admitted values are:
  • false
  • true
ref-dp optional Name of Data Provider to use. This Data Provider will receive in input a JMS Message and must return the object to be inserted in GVBuffer.
dump-message optional If true the dequeued message is dumped on log file, at DEBUG severity level. Default false. The attribute's admitted values are:
  • true
  • false
Attribute Type Description
keep-input-extra-properties optional Specifies if the dequeue must keep input GVBuffer properties, not present in the JMS message, in the output GVBuffer. Default false. The attribute's admitted values are:
  • true
  • false
Attribute Type Description
decorate-gvbuffer optional If true the output GVBuffer is enriched with the received message properties value. Default true. The attribute's admitted values are:
  • true
  • false

Its subelements are:

Retrieved from "https://gvwiki.greenvulcano.com/gvwiki/index.php?title=Jms-dequeue&oldid=4380"