uCosminexus Service Platform, Basic Development Guide

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

8.2.5 Specifying Parameters

To invoke a method of the synchronous reception (Web Services), specify parameters that become the arguments of the method. The following figure shows parameter details.

Table 8-3 Parameter details (standard synchronous reception (Web Services))

Parameter name Data type Parameter Explanation
invokeXML invokeBinary
Service name
(serviceName)
java.lang.String in0(type="xsd:string") 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
(clientID)
java.lang.String in1(type="xsd:string") 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.
To omit the client correlation ID, specify NULL.
Request format ID
(requestFormatID)
java.lang.String in2(type="xsd:string") This is an ID for uniquely identifying the request message format from the service requester.
Specify NULL for this parameter.
Response format ID
(responseFormatID)
java.lang.String in3(type="xsd:string") This is an ID for uniquely identifying the response message from the HCSC server.
Specify NULL for this parameter.
Operation name
(operationName)
java.lang.String in4(type="xsd:string") 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. To omit it, specify NULL.
User message
(userData)
java.lang.String in5
(type=
"xsd:string")
-- 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, specify NULL or an empty character (""). For details about request messages, see 8.2.6 Creating Request Messages.
User message length
(userDataBinary.length)
int -- in5(type=
"xsd:int")
This is the request message length.
Specify this parameter when the request message is binary. This parameter is required when the request message is binary.
If there is no request message, specify 0.
User message
(userDataBinary)
byte[] -- in6(type=
"base64Binary")
This is the request message from the service requester.#
Specify this parameter when the request message is binary. For details about request messages, see 8.2.6 Creating Request Messages.
If there is no request message, specify NULL or a 0-byte byte array.

Legend:
inX (X=1 to 6): Parameter for each method indicated by a stub
--: 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.