Introduce communication templates

[de-jcup]

Situation

When we want to communicate with external endpoints (for example: calling a REST service of an AI endpoint) we want to have this configurable.

Wanted

An easy way to define the way to communicate with an external service in a customizable way.

Solution

We differ here between READ and WRITE templates.

Template syntax

{
    "send" : {
        "targetType" : "$type",
        "mapping" : {
         "$sourceKey" : "$destinationKey"
        }
    },

    "receive" : {
        "sourceType" : "$type",
        "mapping" : {
         "$sourceKey" : "$destinationKey"
        }
    } 
   
}

Example

{
    "send" : {
        "targetType" : "JSON",
        "mapping" : {
          "cweId" : "cwe.id",
          "language" : "lang",
          "details" : "cwe.details"
        }
    },

    "receive" : {
        "sourceType" : "JSON",
        "mapping" : {
          "error" : "result.problem",
          "status" : "result.status.level",
          "description" : "content"
        }
    } 
}

Usage

CommunicationTemplate template = templateFactory.createFromFile("communicate-ai.json");

val mappingData = new HashMap<String,String>();
mappingData.set("cweId", "79");
mappingData.set("language", "java")
mappingData.set("details", "some technical details about the cwe problem"

String jsonToSend = template.processSend(data);

//  ...
// REST done, result returned as "resultText"
// ...

Map<String, String> resultMappingData= template.processReceive(resultText);
String content = resultMappingData.get("content");