Difference between revisions of "J2ee-jca-call"
(→param-gvbuffer) |
(→{{VULCON}} / {{GVCONSOLE}} Configuration) |
||
Line 39: | Line 39: | ||
| byteArray-encoding || optional || Defines the encoding to be used in case byteArray-handling is set to 'string'. | | byteArray-encoding || optional || Defines the encoding to be used in case byteArray-handling is set to 'string'. | ||
|- | |- | ||
− | | namespace-prefix | + | | namespace-prefix || optional || The XML used to describe JCA records provides a particular namespace (http://www.eaisoftware.it/jca/xml http://www.eaisoftware.it/jca/xml). The default prefix used for namespace is ''jca''. <br/> Warning: Changing this value will force a change of xpath |
used in sub-elements ''xml-data'' and ''param-gvdata''. | used in sub-elements ''xml-data'' and ''param-gvdata''. | ||
|} | |} |
Revision as of 13:57, 17 February 2012
Contents
Description
This feature allows you to define an invocation to a JCA adapter that exposes the CCI interface.
VulCon / GV Console Configuration
There are no limitations on the structure of records that the JCA adapter can use. The body of GVBuffer must contain an XML structure that describes the JCA record, and in response the output record is converted in the same XML format.
The j2ee-jca-call Element is used by Channel and routed-call.
Its attributes are:
Attribute | Type | Description |
---|---|---|
type | fixed | This attribute must assume the value call. |
class | fixed | This attribute must assume the value it.greenvulcano.gvesb.virtual.j2ee.JCACallOperation. |
name | required | Operation name. Used in the 'Flow' section to associate workflow nodes to VCL operations. |
jndi-name-eis | required | JNDI name under which the resource adapter is installed. Is the JNDI name of connection factory. |
exec-type | required | Invocation description:
|
output-name | optional | If you specify exec_in_out to attribute exec-type, you must specify the name of the output record. Refer to the documentation of particular JCA adapter to see which is the name to be used. |
output-type | optional | If you specify 'exec_in_out' to attribute 'exec-type', specify the type of output record. Refer to the documentation of particular JCA adapter to see what kind of records is returned by invoked function. The attribute's admitted values are:
|
byteArray-handling | optional | Defines how to deal with returns of type byte[].
|
byteArray-encoding | optional | Defines the encoding to be used in case byteArray-handling is set to 'string'. |
namespace-prefix | optional | The XML used to describe JCA records provides a particular namespace (http://www.eaisoftware.it/jca/xml http://www.eaisoftware.it/jca/xml). The default prefix used for namespace is jca. Warning: Changing this value will force a change of xpath used in sub-elements xml-data and param-gvdata. |
j2ee-jca-call has the following subelements:
- Description
- JNDIHelper
- jca-interaction-spec
- jca-connection-spec
- xml-data
- param-gvbuffer
- ServiceAlias
jca-interaction-spec
The element jca-interaction-spec is used only by j2ee-jca-call and specifies the properties for the object javax.resource.cci.InteractionSpec. The InteractionSpec object must be a JavaBeans and its properties are used to provide the necessary parameters for JCA connector to complete the interaction with the EIS.
Refer to the documentation of particular JCA adapter for a list of properties supported by InteractionSpec. It has the attributes:
Attribute | Type | Description |
---|---|---|
class | required | Class that implements the InteractionSpec. Consult the documentation of particular JCA adapter for the value of this parameter. |
function-name | optional | Many EIS provides different functions. This property allows you to specify the function to invoke. JCA specifications require implementation of this standard property only if applicable to the particular EIS. Refer to the documentation of the particular EIS for a list of available functions. |
interaction-verb | optional | The functions exposed by an EIS can be invoked in a standard way:
|
execution-timeout | optional | Timeout in milliseconds for a given interaction. Not all EIS support this parameter. JCA specifications require implementation of this standard property only if applicable to the particular EIS. |
It has the following subelements:
- Description,
- spec-constructor (see bellow),
- spec-property (see bellow)
jca-connection-spec
The element jca-connection-spec is used to specify the properties for the object javax.resource.cci.ConnectionSpec.
The ConnectionSpec object must be a JavaBeans and its properties are used to provide initial parameters to JCA connector in order to establish a connection with the EIS. Refer to the documentation of particular JCA adapter for a list of properties supported by ConnectionSpec.
The jca-connection-spec Element is used only by j2ee-jca-call.
It has the following attributes:
Attribute | Type | Description |
---|---|---|
class | required | Class that implements the ConnectionSpec. Consult the documentation of particular JCA adapter for the value of this parameter. |
and accepts the subelements:
- Description
- spec-constructor (see bellow)
- spec-property (see bellow)
spec-constructor
spec-constructor allows you to build InteractionSpec or ConnectionSpec objects using constructors with a list of parameters.
This element identifies constructors that accept only simple types as parameters.
Refer to the documentation of the particular EIS to see which objects constructors are supported.
The spec-constructor element is used by jca-connection-spec and jca-interaction-spec.
It has the subelements
- Description,
- parameter.
parameter
The parameter Element specify a constructor parameter. It is used only by spec-constructor.
Its attributes are:
- type: Parameter type. Only supports simple types. The attribute's admitted values are:
- byte
- boolean
- char
- double
- float
- int
- long
- short
- String
- value: Parameter value. The attribute's admitted values are:
- true
- false
spec-property
Property used to initialize the connection spec to connect the JCA adapter.
The properties to be specified depend on the particular resource adapter. Refer to the documentation of the resource adapter.
The spec-property Element is used by jca-connection-spec, jca-interaction-spec.
Its attributes are:
- name: Property name.
- value: Property value.
xml-data
According to the JCA specification, the Record may contain only simple data types or other records. However, it is frequently that some return strings contain XML data.
This element allows you to specify the xpath for string data to be transformed into XML.
The xml-data Element is used only by j2ee-jca-call and has the subelements:
- Description,
- string-to-xml.
string-to-xml
Specifies that a particular string returned by EIS must be interpreted as XML. The string-to-xml Element is used only by xml-data and has an only attribute:
- xpath: XPath to identify the data to be interpreted as XML.
param-gvbuffer
This feature allows you to set some fields GVBuffer output with the output values of the EIS. Can only be used if the output of the EIS is in XML format.
The param-gvbuffer Element is used only by j2ee-jca-call.
It has the attribute:
Attribute | Type | Description |
---|---|---|
xpath-retCode | required | Specifies an XPath expression to be applied to EIS output XML to select the return code set in the output GVBuffer. |
and the subelements:
- Description,
- property
property
Specifies an XPath expression to be applied to EIS output XML to select the value of a propery to set in the output GVBuffer.
Its attributes are:
Attribute | Type | Description |
---|---|---|
name | required | Name of property to set on output GVBuffer. |
xpath | required | Specifies an XPath expression to be applied to EIS output XML to select the value of a propery to set in the output |
default | optional | Specifies a default value to use in case the XPath does not select any value. If not specified, if the XPath does not identify any value, the field will not be set. |