Difference between revisions of "GVForwards"

From GreenVulcano Wiki
Jump to: navigation, search
(→‎ErrorHandler)
 
(7 intermediate revisions by 2 users not shown)
Line 24: Line 24:
 
The ForwardConfiguration Element is used by: '''GVForwards'''.
 
The ForwardConfiguration Element is used by: '''GVForwards'''.
  
−
The following table shows the element's attributes ForwardConfiguration:
+
The following table shows the ForwardConfiguration element's attributes:
 
{|class="gvtable"
 
{|class="gvtable"
 
! Attribute !! Type !! Description
 
! Attribute !! Type !! Description
 
|-
 
|-
 
| forwardName || required || Forward name. References the Core workflow of type "Forward".
 
| forwardName || required || Forward name. References the Core workflow of type "Forward".
 +
|-
 +
| enabled || required || Property that defines if the forward must be activated.
 
|-
 
|-
 
| flow-system || optional || Default System name to be used to invoke the workflow. Can be extracted from the received JMS message.
 
| flow-system || optional || Default System name to be used to invoke the workflow. Can be extracted from the received JMS message.
Line 36: Line 38:
 
| sleep-timeout || optional || Sleep in ms to perform in case of error. Default to 2000 and if <= 0 disable the sleep.
 
| sleep-timeout || optional || Sleep in ms to perform in case of error. Default to 2000 and if <= 0 disable the sleep.
 
|-
 
|-
−
| ref-dp || optional || Data Provider to be used for extract data from the received JMS message.
+
| ref-dp || optional || Data Provider to be used for extract data from the received JMS message. If not defined the dequeued JMS message is passed as payload to the workflow.
 
|-
 
|-
 
| dump-message || optional || If true the dequeued message is dumped on log file, at DEBUG severity level. Default false.
 
| dump-message || optional || If true the dequeued message is dumped on log file, at DEBUG severity level. Default false.
 +
|-
 +
| full-debug || optional || If true ALL forward operations are logged on log file, at DEBUG severity level. Use with caution.  Default false.
 
|}
 
|}
  
−
Its subelements are:
+
<div class="version_ge3.3.3">
−
* Description
 
−
* JBoss4ForwardDeployment
 
−
* JBoss4ResourceManagerForwardDeployment
 
−
* ErrorHandler
 
−
 
 
−
====JBoss4ForwardDeployment====
 
−
 
 
−
Defining mechanisms for forward deployment on JBoss 4.x.
 
−
 
 
−
The JBoss4ForwardDeployment Element is used by: '''ForwardConfiguration'''.
 
−
 
 
−
The following table shows the element's attributes JBoss4ForwardDeployment:
 
 
{|class="gvtable"
 
{|class="gvtable"
 
! Attribute !! Type !! Description
 
! Attribute !! Type !! Description
 
|-
 
|-
−
| forward-name || required || Forward name.
+
| name || required || forward configuration name, required in order to enable the configuration of the same forwardName on multiple JMS destinations.
−
|-
 
−
| type || fixed || This attribute must assume the value '''forward-deployment'''.
 
−
|-
 
−
| server-name-property-name || fixed || Property that defines the name of the JBoss server as a parameter to be passed to the forward. This attribute must assume the value '''jboss.server.name'''.
 
−
|-
 
−
| enabled || required || Property that defines if the forward configuration must be transfered in the MDB deployment descriptor. The attribute's admitted values are:
 
−
** true
 
−
** false
 
−
|-
 
−
| destination-type || required || Property that defines the type of destination. The attribute's admitted values are:
 
−
** queue
 
−
** topic
 
−
|-
 
−
| destination-jndi-name || required || The attribute's value can't be null.
 
−
|-
 
−
| local-jndi-name || optional || This parameter specifies the local-jndi-name for the MDB. Do not set when number-of-mdb parameter is set more than 1. The attribute's value can't be null.
 
−
|-
 
−
| trans-attribute || required || The trans-attribute element specifies how the container must manage the transaction boundaries when invoking an MDB. The attribute's admitted values are:
 
−
* Required
 
−
* NotSupported
 
−
* UserTransaction
 
−
|-
 
−
| trans-timeout-seconds || optional ||
 
−
|-
 
−
| jms-provider || optional || JMSProvider name specified in the configuration of JBoss. If is not specified, defaults is '''DefaultJMSProvider'''.
 
−
|-
 
−
| jms-pool || optional || Pool name that handles MDB specified in the configuration of JBoss. If is not specified, defaults to '''StdJMSPool'''.
 
−
|-
 
−
| MaximumSize || optional || This specifies the upper limit to the number of concurrent MDBs that will be allowed for the JMS destination. Defaults to '''15'''.
 
−
|-
 
−
| MaxMessages || optional || This specifies the maxMessages parameter value for the createConnectionConsumer method of javax.jms.QueueConnection and javax.jms.TopicConnection interfaces, as well as the maxMessages parameter value for the createDurableConnectionConsumer method of javax.jms.TopicConnection. It is the maximum number of messages that can be assigned to a server session at one time. Defaults to 1. This value should not be modified from the default unless your JMS provider indicates this is supported.
 
−
|-
 
−
| ReconnectIntervalSec || required || The time to wait (in seconds) before trying to recover the connection to the JMS server.
 
−
|-
 
−
| number-of-mdb || optional || This parameter specifies the number of MDB to be created for the forward.
 
−
|-
 
−
| mdb-user || optional || The attribute's value can't be null.
 
−
|-
 
−
| mdb-passwd || optional ||
 
−
|-
 
−
| mdb-client-id || optional || The attribute's value can't be null.
 
−
|-
 
−
| mdb-subscription-id || optional || The attribute's value can't be null.
 
 
|}
 
|}
 +
</div>
  
 
Its subelements are:
 
Its subelements are:
 
* Description
 
* Description
−
* DLQConfig
+
* ForwardDeployment
 +
* ErrorHandler
 +
<div class="version_ge3.4/3.3.4">
 +
* PreProcessor
 +
</div>
  
−
====JBoss4ResourceManagerForwardDeployment====
+
====ForwardDeployment====
  
−
Defining mechanisms for forward deployment on JBoss 4.x with Resource Manager.
+
This element defines JMS details for Forward configuration.
  
−
The JBoss4ResourceManagerForwardDeployment Element is used by: '''ForwardConfiguration'''.
+
The following table shows the ForwardDeployment element's attributes:
−
 
 
−
The following table shows the JBoss4ResourceManagerForwardDeployment element's attributes:
 
 
{|class="gvtable"
 
{|class="gvtable"
 
! Attribute !! Type !! Description
 
! Attribute !! Type !! Description
 
|-
 
|-
−
| forward-name || required || Forward name.
+
| connection-factory || required ||  JMS Connection factory JNDI name.
 +
|-
 +
| destination-type || required || Property that defines the type of destination: queue or topic.
 +
|-
 +
| destination || required || Destination JNDI name.
 
|-
 
|-
−
| type || fixed || This attribute must assume the value '''forward-deployment'''.
+
| transacted || required || The transacted attribute specifies if the JMS dequeue must be executed in a XA transaction.
 
|-
 
|-
−
| server-name-property-name || fixed || Property that defines the name of the JBoss server as a parameter to be passed to the forward. This attribute must assume the value '''jboss.server.name'''.
+
| transaction-timeout-sec || optional || XA transaction timeout. Default to 30 seconds.
 
|-
 
|-
−
| enabled || required || Property that defines if the forward configuration must be transferred in the MDB deployment descriptor. The attribute's admitted values are:
+
| reconnect-interval-sec || optional || Defines the timeout between reconnection attempt on JMS connection failure. Default to 10 seconds.
−
* true
 
−
* false
 
 
|-
 
|-
−
| destination-type || required || Property that defines the type of destination. The attribute's admitted values are:
+
| initial-size || optional || This specifies the lower limit to the number of concurrent Listeners. Defaults to 1.
−
* queue
 
−
* topic
 
 
|-
 
|-
−
| destination-jndi-name || required || The attribute's value can't be null.
+
| maximum-size || optional || This specifies the upper limit to the number of concurrent Listeners. Defaults to 10.
 
|-
 
|-
−
| trans-attribute || required || The trans-attribute element specifies how the container must manage the transaction boundaries when invoking an MDB. The attribute's admitted values are:
+
| receive-timeout-sec || optional || Defines the receive timeout of Listener. If XA transaction are active this timeout is contained in the XA transaction timeout. Default to 1 second.
−
* Required
 
−
* NotSupported
 
−
* UserTransaction
 
 
|-
 
|-
−
| resource-adapter-name || required || JMS ResourceManager name. The attribute's value can't be null.
+
| read-block-count || optional || Defines the number of receive operations (succesfull or not) performed by the Listener before reinitialization. Default to 60 operations. A value of -1 means ignore count.
 
|}
 
|}
  
−
Its subelements are:
+
Its sub-elements are:
 
* Description
 
* Description
−
* DLQConfig
+
* [[message-selector]]
−
 
+
* [[JNDIHelper]]
−
=====DLQConfig=====
+
* [[XAHelper]]
−
 
 
−
Configuring the Dead Letter Queue. Queue contains messages that fail delivery.
 
−
 
 
−
The DLQConfig Element is used by: '''JBoss4ForwardDeployment''', '''JBoss4ResourceManagerForwardDeployment'''.
 
−
 
 
−
The following table shows the element's attributes DLQConfig:
 
−
{|class="gvtable"
 
−
! Attribute !! Type !! Description
 
−
|-
 
−
| DestinationQueue || required || The attribute's value can't be null.
 
−
|-
 
−
| MaxTimesRedelivered || required ||
 
−
|-
 
−
| TimeToLive || required || In milliseconds.
 
−
|-
 
−
| DLQUser || optional || The attribute's value can't be null.
 
−
|-
 
−
| DLQPassword || optional
 
−
|}
 
  
 
====ErrorHandler====
 
====ErrorHandler====
Line 174: Line 104:
 
The ExceptionCondition element must be configured to handle only GVPublicException.
 
The ExceptionCondition element must be configured to handle only GVPublicException.
  
−
The ErrorHandler Element is used by: '''ForwardConfiguration'''.
+
The following table shows the ErrorHandler element's attributes:
−
 
 
−
The following table shows the element's attributes ErrorHandler:
 
 
{|class="gvtable"
 
{|class="gvtable"
 
! Attribute !! Type !! Description
 
! Attribute !! Type !! Description
 
|-
 
|-
−
| name || required || Instance name, used in log messages. The attribute's value can't be null.
+
| name || required || Instance name, used in log messages.
 
|-
 
|-
−
| error-id_service || required || Service to be used in error service invocation. The attribute's value can't be null.
+
| error-id_service || required || Service to be used in error service invocation.
 
|-
 
|-
−
| error-id_system || required || System to be used in error service invocation. The attribute's value can't be null.
+
| error-id_system || required || System to be used in error service invocation.
 
|-
 
|-
 
| error-operation || required || Operation to be used in error service invocation.
 
| error-operation || required || Operation to be used in error service invocation.
 
|-
 
|-
−
| original-system-field || required || Name of the property to be used to contain the original [[System]].
+
| original-system-field || required || Name of the property to be used to contain the original [[System]] value.
 
|-
 
|-
−
| original-service-field || required || Name of the property to be used to contain the original [[Service]].
+
| original-service-field || required || Name of the property to be used to contain the original [[Service]] value.
 
|}
 
|}
  
Line 196: Line 124:
 
* Description
 
* Description
 
* [[ExceptionCondition]]
 
* [[ExceptionCondition]]
 +
 +
<div class="version_ge3.4/3.3.4">
 +
====PreProcessor====
 +
 +
Provides to JMS Forward a pre-processor validation framework, that add the capability to check some condition before dequeuing a JMS message from the queue.
 +
 +
Its sub-elements are:
 +
* DUMMY
 +
* [[HL7ConnectionValidator]]
 +
</div>

Latest revision as of 11:06, 31 December 2014

Description

GreenVulcano® ESB JMS Forward configuration.

VulCon / GV Console Configuration

The GVForwards Element is used by: GVCore.

The following table shows the element's attributes GVForwards:

Attribute Type Description
type fixed Element type module.
name fixed Module ID always set to JMS_FORWARD.

Its subelements are:

  • Description
  • ForwardConfiguration

ForwardConfiguration

The ForwardConfiguration Element is used by: GVForwards.

The following table shows the ForwardConfiguration element's attributes:

Attribute Type Description
forwardName required Forward name. References the Core workflow of type "Forward".
enabled required Property that defines if the forward must be activated.
flow-system optional Default System name to be used to invoke the workflow. Can be extracted from the received JMS message.
flow-service optional Default Service name to be used to invoke the workflow. Can be extracted from the received JMS message.
sleep-timeout optional Sleep in ms to perform in case of error. Default to 2000 and if <= 0 disable the sleep.
ref-dp optional Data Provider to be used for extract data from the received JMS message. If not defined the dequeued JMS message is passed as payload to the workflow.
dump-message optional If true the dequeued message is dumped on log file, at DEBUG severity level. Default false.
full-debug optional If true ALL forward operations are logged on log file, at DEBUG severity level. Use with caution. Default false.
Attribute Type Description
name required forward configuration name, required in order to enable the configuration of the same forwardName on multiple JMS destinations.

Its subelements are:

  • Description
  • ForwardDeployment
  • ErrorHandler
  • PreProcessor

ForwardDeployment

This element defines JMS details for Forward configuration.

The following table shows the ForwardDeployment element's attributes:

Attribute Type Description
connection-factory required JMS Connection factory JNDI name.
destination-type required Property that defines the type of destination: queue or topic.
destination required Destination JNDI name.
transacted required The transacted attribute specifies if the JMS dequeue must be executed in a XA transaction.
transaction-timeout-sec optional XA transaction timeout. Default to 30 seconds.
reconnect-interval-sec optional Defines the timeout between reconnection attempt on JMS connection failure. Default to 10 seconds.
initial-size optional This specifies the lower limit to the number of concurrent Listeners. Defaults to 1.
maximum-size optional This specifies the upper limit to the number of concurrent Listeners. Defaults to 10.
receive-timeout-sec optional Defines the receive timeout of Listener. If XA transaction are active this timeout is contained in the XA transaction timeout. Default to 1 second.
read-block-count optional Defines the number of receive operations (succesfull or not) performed by the Listener before reinitialization. Default to 60 operations. A value of -1 means ignore count.

Its sub-elements are:

ErrorHandler

Handle the invocation of an error service, if configured.

The ErrorHandler are checked in the same sequence as they are configured. If the ExceptionCondition element ISN'T configured the handler is active by default, and if it's the first of the list then the others are never checked.

The ExceptionCondition element must be configured to handle only GVPublicException.

The following table shows the ErrorHandler element's attributes:

Attribute Type Description
name required Instance name, used in log messages.
error-id_service required Service to be used in error service invocation.
error-id_system required System to be used in error service invocation.
error-operation required Operation to be used in error service invocation.
original-system-field required Name of the property to be used to contain the original System value.
original-service-field required Name of the property to be used to contain the original Service value.

Its subelements are:

PreProcessor

Provides to JMS Forward a pre-processor validation framework, that add the capability to check some condition before dequeuing a JMS message from the queue.

Its sub-elements are:

Retrieved from "https://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVForwards&oldid=4278"