uCosminexus Service Platform, Basic Development Guide

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

8.5.4 Specifying Parameters

To invoke a method of the asynchronous reception (MDB (WS-R)), specify parameters for the JMS message.

Organization of this subsection
(1) Property specification
(2) Headers and properties that are inherited
(3) Payload specification
(4) Parameter details

(1) Property specification

Specify properties for the JMS message. For details about the properties to be specified, see 8.5.4(4) Parameter details.

Example: When the request message is in XML
 
textMessage = qSession.createTextMessage();
textMessage.setStringProperty("CSCServiceName", serviceName);
     // Service component name
textMessage.setStringProperty("CSCCorrelationID", clientID);
     // Client correlation ID
textMessage.setStringProperty("CSCRequestFormatID", requestFormatID);
     // Request format ID
textMessage.setStringProperty("CSCResponseFormatID", responseFormatID);
     // Response format ID
textMessage.setStringProperty("CSCServiceOperationName", operationName);
     // Operation name
textMessage.setStringProperty("CSCReplyToQueueName", replyToQueueName);
     // Queue name for response
textMessage.setStringProperty("CSCMessageType", "XML");
     // Message type
 
Note
A binary request message can be sent only when the message format used on the service component side is binary. A request message to be sent to a database queue service component must be converted to binary format. For binary conversion, use the same encoding method for the service requester side and the service component side.

(2) Headers and properties that are inherited

The headers and properties listed below are inherited from the request side to the queue on the service component side. Therefore, set up these headers and properties as needed.

#1
The maximum specifiable range is 255 bytes.

#2
Note that the following properties are not inherited by the queue on the service component side:
  • JMS-defined property name that begins with JMSX
  • Provider-specified property name that begins with JMS_
  • Property name that begins with CSC
  • Property name that begins with HCSC

(3) Payload specification

Specify a request message (user message) in the JMS message payload. For details about the payload, see 8.5.4(4) Parameter details.

Example: When the request message is in XML
 
textMessage.setText( userData );
 

(4) Parameter details

The following figure shows parameter details.

Table 8-14 Parameter details (standard asynchronous reception (MDB (WS-R)))

Parameter name Data type Parameter Property/payload Explanation
TextMessage BytesMessage
Service name String StringProperty
("CSCServiceName")
Property This is the service name of the request destination.
This parameter is required.
For the service name of the request destination, specify the adapter or business process defined in the development environment.
Client correlation ID String StringProperty
("CSCCorrelationID")
Property This is a correlation identifier for uniquely identifying the request message from the service requester.
Specify alphanumeric characters, underscore (_), period (.), and hyphen (-) up to 255 characters.
This parameter is used to map the request message from the service requester to the execution history, logs, and traces managed by the HCSC server. Therefore, specify a different ID for each request message sent to the HCSC server.
By not specifying this parameter, you can omit the client correlation ID.
Request format ID String StringProperty
("CSCRequestFormatID")
Property This is an ID for uniquely identifying the request message format from the service requester.
Specify alphanumeric characters, underscore (_), period (.), and hyphen (-) up to 1,024 characters.
Specify NULL for this parameter. If you do not specify this parameter, NULL is specified.
Response format ID String StringProperty
("CSCResponseFormatID")
Property This is an ID for uniquely identifying the response message from the HCSC server.
Specify alphanumeric characters, underscore (_), period (.), and hyphen (-) up to 1,024 characters.
Specify NULL for this parameter. If you do not specify this parameter, NULL is specified.
Operation name String StringProperty
("CSCServiceOperationName")
Property This is an operation name corresponding to the service name at the request destination.#
This operation name specifies a service component defined in the development environment. Specify the operation name with NCName definition characters of XMLSchema within 255 bytes.
This parameter is required when the service component at the request destination is a synchronous service (Web Services or SessionBean) or business process.
When the service at the request destination is an asynchronous service, the operation name can be omitted. By not specifying this parameter, you can omit the operation name.
Response queue name String StringProperty
("CSCReplyToQueueName")
Property This is the queue name that receives a response from a service component or business process when the service component at the request destination is a synchronous service (Web Services or SessionBean) or business process.
By specifying this parameter when you cannot determine whether the service component at the request destination is synchronous or asynchronous, you can receive responses.
For details about the response queue, see 8.5.7 Setting Up a Response Queue.
By not specifying this parameter, you can omit the response queue name. If you omit this parameter, NULL is specified, and you cannot receive responses.
Message type String StringProperty
("CSCMessageType")
Property Specify one of the following request message types:
  • For XML message (whose payload is TextMessage): XML
  • For binary message (whose payload is BytesMessage): Binary
This parameter must be specified when there is a request message.
When there is no request message, you can omit the message type by not specifying this parameter.
User message -- TextMessage N Payload This is the request message from the service requester.#
Specify this parameter when the request message is in XML. If there is no request message, you do not need to specify this parameter. For details about request messages, see 8.5.5 Creating Request Messages.
User message length Long N LongProperty
("CSCMessageLength")
Property This is the request message length.
Specify this parameter when the request message is binary.
User message -- N BytesMessage Payload This is the request message from the service requester.#
Specify this parameter when the request message is binary. If there is no request message, you do not need to specify this parameter. For details about request messages, see 8.5.5 Creating Request Messages.

Legend:
--: Not applicable
N: Cannot be specified.

#
When the service component protocol of request destination is SOAP, decide an operation to be invoked from the name of a root element of user message (in the case of data transformation, it is the name of root element of the message after data transformation). Therefore, take note that if you specify an invalid name in the root element of user message, an unintended operation may be invoked.