Difference between revisions of "GVForwards"

From GreenVulcano Wiki
Jump to: navigation, search
(Created page with "==Description== {{GVESB}} JMS Forward configuration. =={{VULCON}} / {{GVCONSOLE}} Configuration== The GVForwards Element is used by: GVCore. The following table show the elem...")
 
(ForwardConfiguration)
Line 43: Line 43:
 
Its subelements are:
 
Its subelements are:
 
* Description
 
* Description
* [[JBoss4ForwardDeployment]]
+
* JBoss4ForwardDeployment
 
* [[JBoss4ResourceManagerForwardDeployment]]
 
* [[JBoss4ResourceManagerForwardDeployment]]
 
* [[ErrorHandler]]
 
* [[ErrorHandler]]
 +
 +
====JBoss4ForwardDeployment====
 +
 +
Defining mechanisms for forward deployment on JBoss 4.x.
 +
 +
The JBoss4ForwardDeployment Element is used by: '''ForwardConfiguration'''.
 +
 +
The following table show the element's attributes JBoss4ForwardDeployment:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| forward-name || required || Forward name.
 +
|-
 +
| 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.
 +
|}
 +
 +
Its subelements are:
 +
* Description
 +
* [[DLQConfig]]
 +
 +
====JBoss4ResourceManagerForwardDeployment====
 +
 +
Defining mechanisms for forward deployment on JBoss 4.x with Resource Manager.
 +
 +
The JBoss4ResourceManagerForwardDeployment Element is used by: '''ForwardConfiguration'''.
 +
 +
The following table show the JBoss4ResourceManagerForwardDeployment element's attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| forward-name || required || Forward name.
 +
|-
 +
| 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 definesthe type of destination. The attribute's admitted values are:
 +
* queue
 +
* topic
 +
|-
 +
| destination-jndi-name || required || 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
 +
|-
 +
| resource-adapter-name || required || JMS ResourceManager name. The attribute's value can't be null.
 +
|}
 +
 +
Its subelements are:
 +
* Description
 +
* [[DLQConfig]]

Revision as of 20:13, 6 February 2012

Description

GreenVulcano® ESB JMS Forward configuration.

VulCon / GV Console Configuration

The GVForwards Element is used by: GVCore.

The following table show 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 show the element's attributes ForwardConfiguration:

Attribute Type Description
forwardName required Forward name. References the Core workflow of type "Forward".
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.
dump-message optional If true the dequeued message is dumped on log file, at DEBUG severity level. Default false.

Its subelements are:

JBoss4ForwardDeployment

Defining mechanisms for forward deployment on JBoss 4.x.

The JBoss4ForwardDeployment Element is used by: ForwardConfiguration.

The following table show the element's attributes JBoss4ForwardDeployment:

Attribute Type Description
forward-name required Forward name.
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.

Its subelements are:

JBoss4ResourceManagerForwardDeployment

Defining mechanisms for forward deployment on JBoss 4.x with Resource Manager.

The JBoss4ResourceManagerForwardDeployment Element is used by: ForwardConfiguration.

The following table show the JBoss4ResourceManagerForwardDeployment element's attributes:

Attribute Type Description
forward-name required Forward name.
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 definesthe type of destination. The attribute's admitted values are:
  • queue
  • topic
destination-jndi-name required 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
resource-adapter-name required JMS ResourceManager name. The attribute's value can't be null.

Its subelements are: