uCosminexus Service Platform, Reception and Adapter Definition Guide

[Contents][Glossary][Index][Back][Next]

3.3.9 Defining Message Queue adapters

The method of defining Message Queue adapters is described here.

Organization of this subsection
(1) Creating the message format definition file
(2) Defining data transformation
(3) Operations to be performed on the service adapter settings screen
(4) Editing the Message Queue adapter environment-definition file
(5) Editing the Message Queue adapter communication-configuration definition file
(6) Editing HITACHI Application Integrated Property File
(7) Creating Message Queue adapter runtime-environment property file

(1) Creating the message format definition file

There are 2 types of messages in Message Queue adapters, namely request message and response message. The contents of each of these messages are described here.

For details on the procedure for creating a message format, see 4. Creating a Message Format in the manual Service Platform Basic Development Guide.

You can specify the XML format message or the binary format message in request and response messages of Message Queue adapters.

When sending a message in the XML format, you can specify only an XML format message. When sending a binary message, you can specify only a binary format message. Also, when receiving an XML format message, you can specify only an XML format message. When receiving a binary message, you can specify only a binary format message.

Note
For the user data of the sent message or the received message, specify more than 1 byte. If length of the user data is 0 byte, an error occurs.
(a) Request message

A message used to request sending of a message from a calling Message Queue adapter to the transmission queue and receiving of a message from the reception queue, is called as a request message.

The information to be sent as a request message is described here.

Queue operation information
The queue operation information is the information required to access a queue. The following table describes the contents of the queue operation information:

Table 3-26 Queue operation information

Information Description
Transmission queue-specific information, reception queue-specific information Specify either the transmission queue or the reception queue to be accessed. Specify the name of resource-env-ref mentioned in the <resource-env-ref-name> tag, which is present in the <resource-env-ref> tag of HITACHI Application Integrated Property File.
Message correlation identifier Specify this identifier, when receiving a message matching with the message correlation identifier, in case of a request to receive a message or a request to browse and receive a message. Specify the message correlation identifier, which is set at the time of the message transmission response within 24 bytes as a value. For details on the format of the message correlation identifier, see the description related to the method of generating message correlation identifier in 2.10.2 Access to message queue using Message Queue adapter in the manual Service Platform Overview.

Sent message
A sent message is the user data to be specified in a request message, when requesting to send the XML format or binary format messages.
(b) Contents of a request message

Mention only the required information in a request message, from among the information regarding the existence of the transmission queue-specific information and the reception queue-specific information, existence of the specifying message correlation identifier , and the sent message format (binary format or XML format).

[Figure]For a request to send a message

The following table describes the request message format when specifying the transmission queue-specific information in the XML format:

Table 3-27 Format of the transmission request message in the XML format (when the destination queue-specific information is specified)

Information Tag name in a message Specified value Mandatory
Root element SendRequest - Y
Header information mqheader - Y
Transmission queue-specific information sndresname Transmission queue-specific information# Y
Sent message userdata Optional to user Y

Legend:
Y: Must be specified.
-: There is no specified value.

Note#
If you omit the <res_name> tag of Message Queue adapter communication-configuration definition, you must specify this transmission queue-specific information. If you specify the <res_name> tag of Message Queue adapter communication-configuration definition, this specification is ignored and the specified value of Message Queue adapter communication-configuration definition is used.

The following table describes the request message format, when you do not specify the transmission queue-specific information in the XML format:

Table 3-28 Format of the transmission request message in the XML format (when the destination queue-specific information is not specified)

Information Tag name in a message Specified value Mandatory
Root element SendRequest - Y
Header information mqheader - Y
Sent message userdata Optional to user Y

Legend:
Y: Must be specified.
-: There is no specified value.

The case of specifying the transmission queue-specific information in the binary format is described here.

When sending a binary message, the request message format will be the binary format. The following figure shows the structure of a request message in the binary format:

Figure 3-17 Structure of the transmission request message in the binary format

[Figure]

The entire length of a message must satisfy the following relation:

 
LL >= 10 + Ln

The following table describes the information required for a request message, when sending a binary message:

Table 3-29 Format of the transmission request message in the binary format (when the destination queue-specific information is specified)

Information Tag name in a message Specified value Mandatory
Length of transmission queue-specific information Specify the byte length in the transmission queue-specific information by using a decimal number and a string 10 bytes Y
Transmission queue-specific information Transmission queue-specific information (string) Optional Y
Sent message Optional to user Optional Y

Legend:
Y: Must be specified.

The following table describes the request message format, when you do not specify the transmission queue-specific information in the binary format:

Table 3-30 Format of the transmission request message in the binary format (when the destination queue-specific information is not specified)

Information Tag name in a message Specified value Mandatory
Sent message Optional to user Optional Y

Legend:
Y: Must be specified.

[Figure]For a request to receive a message

You cannot specify a request to receive a message in the binary format.

The following table describes the format of a request to receive a message in the XML format:

Table 3-31 Format of a request to receive a message in the XML format

Information Tag name in a message Specified value Mandatory
Root element RecvRequest - Y
Header information mqheader - Y
Reception queue-specific information rcvresname Reception queue-specific information#1 N
Message correlation identifier correlationid Correlation identifier of a received message#2 N

Legend:
Y: Must be specified.
N: Can be omitted.
-: There is no specified value.

Note#1
If you omit the <res_name> tag of Message Queue adapter communication-configuration definition, you must specify this reception queue-specific information. If you specify the <res_name> tag of Message Queue adapter communication-configuration definition, this specification is ignored, and the specified value of Message Queue adapter communication-configuration definition is used.

Note#2
If the specified value of the <id_type> tag of Message Queue adapter communication-configuration definition is Type2, you must specify this message correlation identifier. If you omit the <id_type> tag of Message Queue adapter communication-configuration definition or if you specify Type1, this specification is ignored.

[Figure]For a request to browse and receive a message

You cannot specify a request to browse and receive a message in the binary format.

The following table describes the format of a request message used to browse and receive a message in the XML format:

Table 3-32 Format of a request message used to browse and receive a message in the XML format

Information Tag name in a message Specified value Mandatory
Root element BrowseRequest - Y
Header information mqheader - Y
Reception queue-specific information rcvresname Reception queue-specific information#1 N
Message correlation identifier correlationid Correlation identifier of the received message#2 N

Legend:
Y: Must be specified.
N: You can omit this information.
-: There is no specified value.

Note#1
If you omit the <res_name> tag of Message Queue adapter communication-configuration definition, you must specify this reception queue-specific information. If you specify the <res_name> tag of Message Queue adapter communication-configuration definition, this specification is ignored, and the specified value of Message Queue adapter communication-configuration definition is used.

Note#2
If the specified value of the <id_type> tag of Message Queue adapter communication-configuration definition is Type2, you must specify this message correlation identifier. If you omit the <id_type> tag of Message Queue adapter communication-configuration definition or specify Type1, this specification is ignored.

[Figure]For a request to send and receive messages

The following table describes the request message format used when specifying the transmission queue-specific information and the reception queue-specific information in the XML format:

Table 3-33 Format of the request to send and receive messages in the XML format (when the transmission and reception queue-specific information is specified)

Information Tag name in a message Specified value Mandatory
Root element SndRcvRequest - Y
Header information mqheader - Y
Transmission queue-specific information sndresname Transmission queue-specific information# Y
Reception queue-specific information rcvresname Reception queue-specific information# Y
Sent message userdata Optional Y

Legend:
Y: Must be specified.
-: There is no specified value.

Note#
If you omit the <res_inf> tag of Message Queue adapter communication-configuration definition, you must specify this transmission queue-specific information and reception queue-specific information. If you specify the <res_inf> tag of Message Queue adapter communication-configuration definition, this specification is ignored, and the specified value of Message Queue adapter communication-configuration definition is used.

The following table describes the request message format used when you do not specify the transmission queue-specific information and the reception queue-specific information in the XML format:

Table 3-34 Format of the request to send and receive messages in the XML format (when the transmission and reception queue-specific information is not specified)

Information Tag name in a message Specified value Mandatory
Root element SndRcvRequest - Y
Header information mqheader - Y
Sent message userdata Optional Y

Legend:
Y: Must be specified.
-: There is no specified value.

The case of specifying transmission queue and reception queue-specific information in the binary format is described here.

When sending and receiving a binary message, the request message will be in the binary format. The following figure shows the structure of a request message in the binary format:

Figure 3-18 Structure of the message transmission and reception request in the binary format

[Figure]

The entire length of a message must satisfy the following relation:

 
LL >= 10 + Ln + 10 + Lo

The following table describes the information required for a request message when sending and receiving a binary message:

Table 3-35 Format of the transmission request message in the binary format (when the destination queue and the reception queue-specific information is specified)

Tag name in a message Specified value Mandatory
Length of transmission queue-specific information Specify the byte length of the transmission queue-specific information using the decimal number and string 10 bytes Y
Transmission queue-specific information Transmission queue-specific information (string) Optional Y
Length of receive-queue specific information Specify the byte length of the reception queue-specific information using the decimal number and string 10 bytes Y
Transmission queue-specific information Reception queue-specific information (string) Optional Y
Sent message Optional to user Optional Y

Legend:
Y: Must be specified.

The following table describes the request message format used when you do not specify the transmission queue and the reception queue-specific information in the binary format:

Table 3-36 Format of the transmission request message in the binary format (when the destination queue and the reception queue-specific information is not specified)

Information Tag name in a message Specified value Mandatory
Sent message Optional to user Optional Y

Legend:
Y: Must be specified.

(c) Response message

A message that is returned to the invoker of Message Queue adapter is called as response message. The information returned as a response message is described here.

Received message
Specifies a user data that is stored in a response message, when receiving a message in the XML format or the binary format.

Result of message transmission
The result of the transmission process is stored in a response message, when sending a message in the XML format or the binary format. If the sending process fails, Message Queue adapter notifies an exception to the custom adapter development framework and does not return a response message. When a message is sent successfully, the result of the message transmission is stored in a response message. Therefore, return value of a response message will surely be "OK" at the time of sending a message.

Message correlation identifier
Specifies a message correlation identifier set in JMSCorrelationID header field, when sending a message in XML format or the binary format.
(d) Contents of a response message

The contents of a response message differ according to the format of a received message (binary format or XML format).

Note that you cannot specify a response for message transmission in the binary format.

The format of the transmission response message in the XML format is as follows:

[Figure]In case of a response message for a request to send a message

The following table describes the format of the transmission response message in the XML format:

Table 3-37 Format of the transmission response message in the XML format

Information Tag name in a message Return value
Root element SendResponse -
Result of message transmission status OK
Message correlation identifier correlationid Message correlation identifier#

Legend:
-: There is no return value.

Note#
The message correlation identifier is returned, when you specify Type2 in the <id_type> of Message Queue adapter communication-configuration definition.

[Figure]In case of a response message for a request to receive a message

The following table describes the format of a response message for receiving messages in the XML format:

Table 3-38 Format of a response message for receiving messages in the XML format

Information Tag name in a message Return value
Received message Optional to user Optional to user

The following table describes the format of a response message for receiving messages in the binary format:

Table 3-39 Format of a response message for receiving messages reception in the binary format

Information Tag name in a message
Received message Optional to user

[Figure]In case of a response message for a request to browse and receive a message

The following table describes the format of a response message for a request to browse and receive a message in XML format:

Table 3-40 Format of a response message for a request to browse and receive a message in XML format

Information Tag name in a message Return value
Received message Optional to user Optional to user

The following table describes the response message for a request to browse and receive a message in the binary format:

Table 3-41 Format of a response message for a request to browse and receive a message in the binary format

Information Tag name in a message
Received message Optional to user

[Figure]Response message for a request to send and receive a message

The following table describes the format of a response message for a request to send and receive a message in the XML format:

Table 3-42 Format of a response message for a request to send and receive a message in the XML format

Information Tag name in a message Return value
Received message Optional to user Optional to user

The following table describes the format of a response message for a request to send and receive a message in the binary format:

Table 3-43 Format of a response message for a request to send and receive a message in the binary format

Information Tag name in a message
Received message Optional to user
(e) Creating a format definition file

From among the various message formats, the message format set up in a service component is the message format of a Message Queue adapter. The method of creating the message format of a Message Queue adapter is described here.

Request message in XML format
To create an XML format definition file for a request message, the user uses either the template file or the file provided with the product. In other cases, the user creates this definition file on his own.
When using XML format definition template file
  • Specify the transmission queue in a request to send a message.
  • Specify the transmission queue and the reception queue in a request to send and receive a message.
When using the file provided with the product
  • Specify the reception queue and the message correlation identifier in a request to receive a message.
  • Specify the reception queue and the message correlation identifier in a request to browse and receive a message.

When the user creates the definition file on his own

When the case is other than the above-mentioned case of using the XML format definition template file and the case of using the file provided with the product, the user must create the definition file on his own.

The following figure gives a description on the XML format definition template file and customization:

Figure 3-19 Template file for a request to send a message (adpmq_snd_request.xsd)

[Figure]

Table 3-44 Contents of the template file for a request to send a message

Line number Description
4th line Indicates name space declaration of this template file. The user declares any prefix in the value of targetName space attribute specified in the 6th line.
6th line Indicates the target name space of this template file. The user specifies a unique target name space in the value of targetName space attribute.
8th line When importing the XML schema information for the user data on the 25th line, mention the target name space of the schema to be imported in the 5th line and mention import statement of the schema to be imported in the 8th line.
10th line~16th line Indicates declaration of SendRequest element. These lines contain mqheader element and userdata element which becomes the root element of a request message. The user describes the prefix declared in the 4th line as the prefix of mqheader element and userdata element.
18th~22nd line Indicates declaration of mqheader element.
24th line Indicates declaration of userdata element.
25th line Describes the XML schema information for the user data.

Description method
There are 2 types of description methods. One is to describe directly in this file and another is to create a separate file for describing the XML schema information for the user data and to import the description from this file. When importing the description, mention the target name space of the schema to be imported in the 5th line and the import statement of the schema to be imported in the 8th line.

Notes
When specifying the XML schema information for the user data, you should not declare multiple elements in the child element of userdata element. You must declare only 1 child element of the userdata element, since the child element of userdata element becomes the root element, when an XML file is to be output.

Figure 3-20 Format definition template file for a request to send and receive a message (adpmq_sndrcv_request.xsd)

[Figure]

Table 3-45 Contents of the template file used for a request to send and receive a message

Line number Description
4th line Indicates name space declaration of this template file. The user declares any prefix in the value of targetName space attribute specified in the 6th line.
6th line Indicates the target name space of this template file. The user specifies a unique target name space in the value of targetName space attribute.
8th line When importing the XML schema information for the user data on the 26th line, mention the target name space of the schema to be imported in the 5th line and mention import statement of the schema to be imported in the 8th line.
10th line~16th line Indicates declaration of SndRcvRequest element. These lines contain mqheader element and userdata element which becomes the root element of a request message. The user describes the prefix declared in the 4th line as the prefix of mqheader element and userdata element.
18th line~23rd line Indicates declaration of mqheader element.
21st line Indicates the specified element of reception queue-specific information. This specification location differs from the template file for a request to send a message.
25th line Indicates declaration of userdata element.
26th line Describes the XML schema information for the user data.

Description method
There are 2 types of description methods. One is to describe directly in this file and another is to create a separate file for describing the XML schema information for the user data and to import the description from this file. When importing the description, mention the target name space of the schema to be imported in the 5th line and the import statement of the schema to be imported in the 8th line.

Notes
When specifying the XML schema information for the user data, you should not declare multiple elements in the child element of userdata element. You can declare only 1 child element of userdata element, since the child element of userdata element becomes the root element, when an XML file is to be output.

Response message in the XML format
To create an XML format definition file for a response message, the user either uses the format definition file provided with the product or creates this definition file on his own.
When using the file provided with the product
Use the file provided with the product when the following conditions are true:
  • When you send a response for message transmission.
  • When you receive the fault response information message in in response to receiving a message reception, response to browsing and receiving a message, or response for sending and receiving messages.
When the user creates the XML format definition file for a response message on his own
Apart from the above-mentioned case of using the file provided with the product, in other cases, the user should create the XML format definition file for a response message on his own.

Request message in the binary format
The user should either edit the binary format definition file for a request message on the binary format definition screen using the template file provided with the product or he should create this file on his own.
When using the binary format definition template file
  • When you specify the transmission queue-specific information in a request to send a message
  • When you specify the transmission queue-specific information and the reception queue-specific information in a request to send and receive a message.
When the user creates a binary format definition file for a request message on his own
When the case is other than the above-mentioned case of using the file provided with the product, the user should create the binary format definition file for a request message on his own.

Response message in the binary format

The following are the cases with respect to binary format definition file for a response message. However, the user should create the binary format definition file on his own.

(2) Defining data transformation

Set the message format definition file of the transformation source and the message format definition file of the transformation destination on the data transformation (mapping) definition screen and define the data transformation.

For details on how to define data transformation, see 6. Defining Data Transformation in the manual Service Platform Basic Development Guide.

(3) Operations to be performed on the service adapter settings screen

The procedure for defining a Message Queue adapter is described here. For details on the setting contents, see 3.3.15(7) For Message Queue adapters.

  1. Display the service adapter settings screen.
    For details on how to display the service adapter settings screen, see 3.3.1(4) Displaying the service adapter settings screen.
  2. Edit [Service name] and [Service ID] of the service component control information, if necessary.
  3. Click the [Add] button of the service component control information and specify the definition pattern, operation name, and field name#.
    The operation name must match with the operation name of Message Queue adapter communication-configuration definition (op_name).
    Note# Specify these details when the definition pattern is not "Send a message".
  4. Select "Synchronous" from the drop-down list of "Communication model" of the operation information.
  5. For a request message, perform steps from 6. to 17.
  6. Perform the following operations:
    When you specify the standard message format
    Perform steps from 7. to 10. And proceed to step 11.
    When you do not specify the standard message format
    Proceed to step 11.
  7. Check the [Use] check box for the standard message.
  8. Specify [Format ID] of the standard message.
  9. Click the [Browse] button of the standard message, and then specify the standard message format in [Message format].
    For details on the message format that can be specified, see 2.6.5 Scoping of XML schema in the manual Service Platform Basic Development Guide.
  10. Click the [Display] button of the standard message.
    If the message format is XML, the standard message format is displayed. Confirm the specified standard message format, if necessary.
  11. Specify [Format ID] of the service component message.
  12. Confirm that the following message format is set as per the definition pattern specified in step 3:
    If the definition pattern is "Send a message"
    Service component of a request message: None
    Service component of a response message: adpmq_snd_response.xsd
    Fault message: None
    If the definition pattern is "Receive a message"
    Service component of a request message: adpmq_rcv_request.xsd
    Service component of a response message: None
    Fault message: adpmq_fault_response.xsd
    If the definition pattern is "Browse and receive a message"
    Service component of a request message: adpmq_browse_request.xsd
    Service component of a response message: None
    Fault message: adpmq_fault_response.xsd
    If the definition pattern is "Send and receive a message"
    Service component of a request message: None
    Service component of a response message: None
    Fault message: adpmq_fault_response.xsd
  13. Click the [Display] button of a service component message.
    The service component message format is displayed. Confirm the service component message format, if necessary.
  14. Perform the following operations:
    If you check the [Use] check box for the standard message
    Perform the steps from 15. to 17. and proceed to step 18.
    If you do not check the [Use] check box of the standard message
    Proceed to step 18.
  15. Enter the file name of the data transformation definition.
  16. Click the [Edit] button.
    The data transformation definition screen is displayed. When defining data transformation for the first time, the [Select root element] dialog box is displayed.
  17. Map the contents of a standard message with the contents of a service message.
  18. Perform steps from 6. to 17. even for a response message.
  19. Click the service adapter settings (details) tab.
    The service adapter settings screen (details) is displayed.
  20. Confirm the names of the service adapter (EJB-JAR file) and the utility class (JAR file).
    Confirm that the name of the service adapter (EJB-JAR file) is "cscmsg_adpejb.jar" and the name of the utility class (JAR file) is "adpmqpc.jar".
  21. Confirm that the following files are added in the self-defined file:
    • customadapter_properties.xml (Message Queue adapter environment-definition file)
    • adpmq_communication (Message Queue adapter communication-configuration definition file)
    • cscadapter_property.xml (HITACHI Application Integrated Property File)

(4) Editing the Message Queue adapter environment-definition file

Define the information required for the environment definition of a Message Queue adapter in the Message Queue adapter environment-definition file in XML format.

The procedure for editing the Message Queue adapter environment-definition file is as follows:

  1. Select "customadapter_properties.xml" in "Self-defined file" of the service adapter settings screen, and then click the [Edit] button.
    The editor required for editing the Message Queue adapter environment-definition file is started.
  2. Edit the Message Queue adapter environment-definition file using the editor.
    For details on the Message Queue adapter environment definition file, see Message Queue adapter environment definition file in the manual Service Platform Reference Guide.
  3. From the Eclipse menu select [File] - [Save], and then save the definition contents.

(5) Editing the Message Queue adapter communication-configuration definition file

Define the information required for the communication-configuration definition of a Message Queue adapter in the Message Queue adapter communication-configuration definition file in the XML format.

The procedure to edit the Message Queue adapter communication-configuration definition file is as follows:

  1. Select "adpmq_communication.xml" in "Self-defined file" of the service adapter settings screen (details), and then click the [Edit] button.
    The editor required for editing the Message Queue adapter communication-configuration definition file is started.
  2. Edit the Message Queue adapter communication-configuration definition file using the editor.
    For details on the Message Queue adapter communication-configuration definition file, see Message Queue adapter communication-configuration definition file in the manual Service Platform Reference Guide.
  3. From the Eclipse menu Select [File] - [Save] , and then save the definition contents.

(6) Editing HITACHI Application Integrated Property File

The method of editing the HITACHI Application Integrated Property File is described here.

(a) Editing procedure

The procedure for editing the HITACHI Application Integrated Property File is as follows:

  1. Select "cscadapter_property.xml" in "Self-defined file" in the Service adapter settings screen (details), and click the "Edit" button.
    Start the editor used for editing HITACHI Application Integrated Property File.
  2. Edit the HITACHI Application Integrated Property File using the editor.
    For details on the setup contents, see (b) Definition details.
  3. From the Eclipse menu, select [File] - [Save], and then save the definition contents.
(b) Definition details

The contents of the HITACHI Application Integrated Property File are as follows:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE hitachi-application-all-property PUBLIC 
'-//Hitachi, Ltd.//DTD Application All Property 7.6//EN' 'http://localhost/hitachi-application-all-property_7_6.dtd'>
<!-- All Rights Reserved. Copyright (C) 2008, Hitachi, Ltd. -->
 
<hitachi-application-all-property>
  <hitachi-application-property>
    <lookup-name>CSCMQ</lookup-name>
    <security-prop>
      <security-method>no_security_for_methods_without_roles</security-method>
    </security-prop>
    <managed-by-ctm>false</managed-by-ctm>
  </hitachi-application-property>
  <ejb-jar>
    <hitachi-ejb-jar-property>
      <display-name>CSCMsgServiceAdapter</display-name>
    </hitachi-ejb-jar-property>
    <hitachi-session-bean-property>
      <display-name>CSCMsgServiceAdapterEJB</display-name>
      <session-type>Stateless</session-type>
      <transaction-type>Container</transaction-type>
      <resource-ref>
        <res-ref-name>jms/resource adapter-specific information</res-ref-name>
        <res-type>javax.jms.QueueConnectionFactory</res-type>
        <res-auth>Container</res-auth>
        <res-sharing-scope>Unshareable</res-sharing-scope>
        <linked-to>name displayed for resource adapter</linked-to>
      </resource-ref>
      <resource-env-ref>
        <resource-env-ref-name>transmission queue-specific information or reception queue-specific information</resource-env-ref-name>
        <resource-env-ref-type>javax.jms.Queue</resource-env-ref-type>
        <linked-adminobject>
          <resourceadapter-name> name displayed for resource adapter</resourceadapter-name>
          <adminobject-name>name of the admin object</adminobject-name>
        </linked-adminobject>
      </resource-env-ref>
      <container-transaction>
        <description></description>
        <method>
          <description></description>
          <method-intf></method-intf>
          <method-name>*</method-name>
        </method>
        <trans-attribute>Required</trans-attribute>
      </container-transaction>
      <session-runtime>
        <lookup-name>CSCMsgServiceAdapterEJB</lookup-name>
        <optional-name></optional-name>
        <maximum-sessions>0</maximum-sessions>
        <stateless>
          <pooled-instance>
            <minimum>minimum number of instances</minimum>
            <maximum>maximum number of instances</maximum>
          </pooled-instance>
        </stateless> 
      </session-runtime>
   </hitachi-session-bean-property>
  </ejb-jar>
</hitachi-application-all-property>

Setup value of the definition is described here.

[Figure]Application attribute <hitachi-application-property>
<lookup-name>
Specify "CSCMQ" as the name to be used when looking up EJB from the client.
<security-method>
Specify "no_security_for_methods_without_roles" as the method for managing security.
<managed-by-ctm>
Specify "false (Do not link to CTM)" for linkage to CTM.

[Figure]EJB-JAR attribute <hitachi-ejb-jar-property>
<display-name>
Specify "CSCMsgServiceAdapter" as the name to be displayed for EJB-JAR.

[Figure]Session Bean attribute <hitachi-session-bean-property>
<display-name>
Specify "CSCMsgServiceAdapterEJB" as the name to be displayed for Session Bean.
<session-type>
Specify "Stateless" as the Session Bean type.
<transaction-type>
Specify "Container" as Transaction Management Type.
<res-ref-name>
Specify resource adapter-specific information. Specify any name to identify a resource adapter for this specified value. Mention "jms/" in the beginning when specifying the name.
Set a value same as this element in the <res_ref_name> element of Message Queue adapter communication-configuration definition.
<res-type>
Specify a resource type. Specify "javax.QueueConnectionFactory" as the connection definition identifier (setup value of <connectionfactory-interface> tag) of the destination resource adapter.
<res-auth>
Specify "Container" as the authentication method.
<res-sharing-scope>
Specify "Unshareable" for the option to indicate whether the referenced resource adapter can be shared.
<linked-to>
Specify the name to be displayed for the resource adapter to be referenced.
Specify <name to displayed for resource adapter>!<connection definition identifier> for Outbound resource adapter.
<Connection definition identifier > is a value specified in the <connectionfactory-interface> tag of the deploy descriptor of a resource adapter (ra.xml).
<res-env-ref-name>
Specify the transmission queue-specific information or the reception queue-specific information. Specify any name to identify the destination queue for this specified value. Mention "jms/" in the beginning when specifying the name.
Set a value same as this element in <res_name>, <snd_res_name> or <rcv_res_name> elements of Message Queue adapter communication-configuration definition.
<res-env-ref-type>
Specify "javax.jms.Queue" as the class type of the value of a resource environment variable.
<resourceadapter-name>
Specify the name to be displayed for a resource adapter of a resource environment variable.
<adminobjectname>
Specify the name of an admin object. Specify a value same as <adminobject-name> of deploy descriptor (ra.xml) of a resource adapter.
<trans-attribute>
Specify "Required" as the transaction attribute assigned to a method.
<lookup-name>
Specify "CSCMsgServiceAdapterEJB" as the name to be used at the location where you look up EJB from a client.
<maximum-sessions>
Specify "0 (unlimited)" as maximum number of sessions.
<minimum>
Specify minimum number of instances in a pool.
<maximum>
Specify maximum number of instances in a pool.

For details on the HITACHI Application Integrated Property File, see the following sections:

(7) Creating Message Queue adapter runtime-environment property file

You must create Message Queue adapter runtime-environment property file for Message Queue adapter.

For details on the Message Queue adapter runtime-environment property file, see Message Queue adapter runtime-environment property file in the manual Service Platform Reference Guide.

[Contents][Back][Next]

[Trademarks]

All Rights Reserved. Copyright (C) 2015, Hitachi, Ltd.