Mappings and Transformations

TIBCO API Exchange Gateway provides message transformations using the mappings. Using the mappings, you can map the gateway endpoint operation request and response messages to the gateway reference operation request and response messages with another format. The mapping capabilities of TIBCO API Exchange Gateway allows you to decouple the northbound operations interface and southbound services interface by providing a mutual common canonical message format between the operations interface and services interface.

TIBCO API Exchange Gateway supports mappings at various levels and reduces the number of point-to-point mappings between gateway endpoint operations (exposed by the gateway) and gateway reference operations (service clients of the gateway that invoke internal service operations).

TIBCO API Exchange Gateway provides the transformation of request and response messages at the following four points:

• Facade Request Handler to Router Boundary

  After the request has been received by the Facade Request Handler and before it is been passed to the Router

• Router to Service Endpoint Handler Boundary

  After the request has been routed, but before it is passed to the Service Endpoint Handler.

• Service Endpoint Handler to Router Boundary

  After a response has been received from the Service Endpoint Handler, and before it is passed to the Router

• Router to Facade Request Handler

  After the response has been routed from the Router to the Facade Request Handler, and before the response is sent back to the original requestor

You can do the following actions using the mapping transformations:

• Access the multiple versions and formats of service APIs
• Add semantic content validation rules to the incoming requests
• Access the fields from the request context and payload
• Change the routing of request and response messages based on error handling in case of message validation failures
• Protect the service end-points using service validation policies

TIBCO API Exchange Gateway supports the transformations of both request and response messages as follows:

• Forward mapping - The transformations are done from request canonical form to back-end service API as per defined mapping
• Reverse mapping - The transformations are done from the back-end service API to the response canonical form as per defined mapping

The mapper of TIBCO API Exchange Gateway provides the six different versions of documents as follows:

• Northbound request message
• Canonical request message
• Southbound request message
• Southbound response message
• Canonical response message
• Nouthbound response message

TIBCO API Exchange Gateway supports mapping at both northbound and southbound sides.