HTTP Messaging¶

Can be prepared in the same way as MOM Messaging¶

Message send/receive is implemented in HTTP messaging using the same API as MOM Messaging given below. Therefore, if users have experience in using MOM Messaging, implementation time can be minimized.

• MessagingAction
• MessageSender

Configure settings to use HTTP messaging¶

In the case of receive message, no special configuration is required other than the handler configuration of the runtime platform.

In the case of send message, add the following classes to the component definition.

• MessageSenderClient implementation class (HTTP send/receive)

A configuration example is shown below.

Point

• HttpMessagingClient is provided as the default implementation of MessageSenderClient.
• Component name is specified as messageSenderClient because it is used as a lookup.

<component name="messageSenderClient"
           class="nablarch.fw.messaging.realtime.http.client.HttpMessagingClient" />

Receive message (HTTP receive message)¶

Receive a message from an external system and send a response.

Implementation examples

Point

• HTTP message receive is created with MessagingAction.
• Create the response message with RequestMessage.reply.

public class SampleAction extends MessagingAction {
    protected ResponseMessage onReceive(RequestMessage request,
                                        ExecutionContext context) {
        // Receive data process
        Map<String, Object> reqData = request.getParamMap();

        // (Omitted)

        // Returns response data
        return request.reply()
                .setStatusCodeHeader("200")
                .addRecord(new HashMap() {{     // Content of message body
                     put("FIcode",     "9999");
                     put("FIname",     "Nablarch bank");
                     put("officeCode", "111");
                     /*
                      * (Rest is omitted)
                      */
                  }});
    }
}

Send message (HTTP send message)¶

Send a message to an external system and receive the response. Wait until a response message is received or the wait timeout expires.

If a timeout occurs because a response cannot be received within the specified time, a compensation process needs to be performed.

Implementation examples

Point

• Create the request message with SyncMessage.
• To send a message, use MessageSender#sendSync. For details of how to use, refer to the linked Javadoc.

// Create a request message
SyncMessage requestMessage = new SyncMessage("RM11AC0202")        // Configure the message ID
                               .addDataRecord(new HashMap() {{    // Content of message body
                                    put("FIcode",     "9999");
                                    put("FIname",     "Nablarch bank");
                                    put("officeCode", "111");
                                    /*
                                     * (Rest is omitted)
                                     */
                                }})
// Send request message
SyncMessage responseMessage = MessageSender.sendSync(requestMessage);

To send an unique text as HTTP header, configure in the header record of the message created as follows.

// Message header content
requestMessage.getHeaderRecord().put("Accept-Charset", "UTF-8");

Change the reading and writing of the framework control header¶

In some cases, reading and writing of the framework control header may require to be changed when the message format is already defined in the external system. To support this, add the implementation in the project. The following shows the support method for each type of send and receive.

For HTTP send message

The framework control header is read and written according to the format definition of the message body. Therefore, the format definition of the message body may be changed according to the content.

For HTTP receive message

Reading and writing to the framework control header is performed by the class with the FwHeaderDefinition interface implementation. StandardFwHeaderDefinition is used by default.

Therefore, referring to StandardFwHeaderDefinition, a class that implements the FwHeaderDefinition interface is created in the project and configured in HTTP Messaging Request Conversion Handler and HTTP Messaging Response Conversion Handler.

Change the HTTP client process of HTTP send message¶

As explained in Configure settings to use HTTP messaging, HttpMessagingClient is used for HTTP send message.

HttpMessagingClient performs various processes as an HTTP client. For example, Accept: text/json,text/xml is fixedly configured in the HTTP header of the message to be sent.

If the default operation of HttpMessagingClient does not meet the project requirements, customize by creating a class that inherits HttpMessagingClient and configuring to the component definition with the method given in Configure settings to use HTTP messaging.