uCosminexus Service Platform, Basic Development Guide

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

8.6.10 Extracting Responses (TP1/EE or JMS)

Organization of this subsection
(1) In TP1/EE
(2) In JMS

(1) In TP1/EE

Using the API (database queue control) of TP1/EE, extract the response binary data by referencing the database in which the response queue (shared receive queue) is located. For details about how to send a normal request message, see the contents about the response queue in service invocation using an MDB (database queue), in the manual Cosminexus Service Platform System Setup and Operation Guide.

For details, see the manual TP1/Server Base Enterprise Option Program Creation Guide.

The following table shows the binary data format for the response message.

Table 8-18 Binary data format (response message)

Item No. Item Size (bytes) Data type# Explanation
1 Header tag 4 char Header tag for delivering HCSC messages (eye catcher).
DBQH is set.
ASCII-encoded binary data is set.
2 Byte order flag 1 byte The byte order flag that was specified during a request is set.
3 Reserved 3 byte Reserved area
4 Size 4 int Header size (size from Item 5 through Item 19) for HCSC messaging is set.
5 Tag 8 char Parameter identification tag (eye catcher).
ServiceN is set.
ASCII-encoded binary data is set.
6 Size 4 int Size of the next area (Item 7).
Size in bytes is set.
7 Service name Optional String The adapter or business process specified during the request is set.
UTF-8-encoded binary data is set.
8 Tag 8 byte Parameter identification tag (eye catcher).
ClientID is set.
ASCII-encoded binary data is set.
9 Size 4 int Size of the next area (Item 10).
Size in bytes is set.
10 Client correlation ID Optional String This is a correlation identifier for uniquely identifying the request message from the service requester.
Specified with alphanumeric characters, underscore (_), period (.), and hyphen (-) up to 255 characters.
UTF-8-encoded binary data is set.
11 Tag 8 byte Parameter identification tag (eye catcher).
Specify ResFmtID.
Use ASCII codes.
12 Size 4 int Size of the next area (Item 13).
Specify a size in bytes.
13 HCSC response format ID Optional String ID for uniquely identifying the response message format.
This parameter, size, and tag are not specified.
14 Tag 8 byte Parameter identification tag (eye catcher).
OperatiN is set.
ASCII-encoded binary data is set.
15 Size 4 int Size of the next area (Item 16).
Size in bytes is set.
16 Service operation name Optional String This is an operation name corresponding to the service name at the request destination.
The operation name is set with the 255-byte NCName definition characters of XMLSchema.
UTF-8-encoded binary data is set.
17 Tag 8 byte Parameter identification tag (eye catcher).
MessageT is set.
ASCII-encoded binary data is set.
18 Size 4 int Size of the next area (Item 19).
Size in bytes is set.
19 Response message type Optional String Message (response message) type.
If the message type is XML, XML is set. If there is no message (response message), this parameter is omitted.
UTF-8-encoded binary data is set.
20 Tag 8 byte Parameter identification tag (eye catcher).
MgLength is set.
ASCII-encoded binary data is set.
21 Size 4 int Size of the next area (Item 22).
4 is set.
22 Message size 4 int Message (response message) size is set.
If there is no message (response message), 0 bytes is set.
23 Message Optional byte[] Either of the following types of information is set:
  • Response message from a service component
  • Error information (fault information) from a service component, business process, or custom adapter
UTF-8-encoded binary data is set.

#
Java data type

(2) In JMS

A response (JMS message) can be extracted from the shared receive queue based on MDB or SessionBean installation. For details about MDB and SessionBean installation, see the manual Cosminexus Application Server Cosminexus Reliable Messaging.

For details about the format of the binary data that is set in the payload of the extracted response (JMS message), see Table 8-18.