Sending the schedule for a fixed-route, scheduled mobility service provider (example: Metro and Buses) (Java)

In this use case, the user views the schedule or time-table for a fixed route mobility service provider like a bus service, or a metro service

Code snippets

BPP receives protocol search

/*
Example Request JSON:
{
    "context": {
        "domain": "nic2004:60221",
        "country": "IND",
        "city": "std:080",
        "action": "search",
        "core_version": "0.9.1",
        "bap_id": "https://mock_bap.com/",
        "bap_uri": "https://mock_bap.com/beckn/",
        "transaction_id": "1209849124",
        "message_id": "12341242342",
        "timestamp": "2021-03-23T10:00:40.065Z"
    },
    "message": {
        "intent" : {
            "fulfillment": {
                "start" : {
                    "location" : {
                        "gps" : "10.109289, 76.349601"
                    }
                },
                "end" : {
                    "location" : {
                        "gps" : "10.087307, 76.342809"
                    }
                }
            }
        }
    }
}
*/
    // BPP Search endpoint
    @PostMapping("/bpp/search")
    public ResponseEntity search(
            @RequestHeader HttpHeaders headers,
            @RequestBody SearchRequest request) {
        var response = bppApplicationService.search(request, headers);
        return ResponseEntity.ok(response);
    }

BPP processes the search

    public Response search(SearchRequest request, HttpHeaders headers) {
        var searchResponse = new OnSearchRequest();
        // Validate the headers
        var isHeadersValid = validateHeaders(headers);
        // Construct and return error
        if (!isHeadersValid) return null;

        // Fetch the data based on the request
        var requestIntent = request.getMessage().getIntent();

        // Execute business logic here

        // Generate the response
        searchResponse = generateSearchResponse(searchResult);

        //invoke on_search api
        return invokeOnSearch(searchResponse, headers);
    }
}

BPP generates response

/*
Example Response JSON:
{
    "context": {
        "domain": "nic2004:60221",
        "country": "IND",
        "city": "std:080",
        "action": "on_search",
        "core_version": "0.9.1",
        "bap_id": "https://mock_bap.com/",
        "bap_uri": "https://mock_bap.com/beckn/",
        "bpp_id": "https://mock_bpp.com/",
        "bpp_uri": "https://mock_bpp.com/beckn/",
        "transaction_id": "1209849124",
        "message_id": "12341242343",
        "timestamp": "2021-03-23T10:00:40.065Z"
    },
    "message": {
        "catalog": {
            "bpp/descriptor": {
                "name": "Metro Corp"
            },
            "bpp/providers": [
                {
                    "id": "metro",
                    "descriptor" : {
                        "name": "Metro"
                    },
                    "locations": [
                        {
                            "id": "stop-1",
                            "station_code":"Aluva",
                            "gps": "10.109289, 76.349601",
                            "time":{
                                "schedule":{
                                    "times":[
                                        "2021-08-19T01:30:00.000Z",
                                        "2021-08-19T01:50:00.000Z",
                                        "2021-08-19T02:10:00.000Z",
                                        "2021-08-19T02:30:00.000Z",
                                        "2021-08-19T02:50:00.000Z",
                                        "2021-08-19T03:10:00.000Z",
                                        "2021-08-19T03:30:00.000Z",
                                        "2021-08-19T03:50:00.000Z",
                                        "2021-08-19T04:10:00.000Z",
                                        "2021-08-19T04:30:00.000Z",
                                        "2021-08-19T04:50:00.000Z"
                                    ]
                                }
                            }
                        },
                        {
                            "id": "stop-2",
                            "station_code":"Pulinchodu",
                            "gps": "10.095094, 76.346629",
                            "time":{
                                "schedule":{
                                    "times":[
                                        "2021-08-19T01:34:00.000Z",
                                        "2021-08-19T01:54:00.000Z",
                                        "2021-08-19T02:14:00.000Z",
                                        "2021-08-19T02:34:00.000Z",
                                        "2021-08-19T02:54:00.000Z",
                                        "2021-08-19T03:14:00.000Z",
                                        "2021-08-19T03:34:00.000Z",
                                        "2021-08-19T03:54:00.000Z",
                                        "2021-08-19T04:14:00.000Z",
                                        "2021-08-19T04:34:00.000Z",
                                        "2021-08-19T04:54:00.000Z"
                                    ]
                                }
                            }
                        },
                        {
                            "id": "stop-3",
                            "station_code":"Companypady",
                            "gps": "10.087307, 76.342809",
                            "time":{
                                "schedule":{
                                    "times":[
                                        "2021-08-19T01:38:00.000Z",
                                        "2021-08-19T01:58:00.000Z",
                                        "2021-08-19T02:18:00.000Z",
                                        "2021-08-19T02:38:00.000Z",
                                        "2021-08-19T02:58:00.000Z",
                                        "2021-08-19T03:18:00.000Z",
                                        "2021-08-19T03:38:00.000Z",
                                        "2021-08-19T03:58:00.000Z",
                                        "2021-08-19T04:18:00.000Z",
                                        "2021-08-19T04:38:00.000Z",
                                        "2021-08-19T04:58:00.000Z"
                                    ]
                                }
                            }
                        }
                    ],
                    "items": [
                        {
                            "id": "1-2",
                            "descriptor" : {
                                "name" : "Aluva to Pulinchodu"
                            },
                            "price" : {
                                "currency": "INR",
                                "value": "10"
                            },
                            "matched": true
                        },
                        {
                            "id": "1-3",
                            "descriptor" : {
                                "name" : "Aluva to Companypady"
                            },
                            "price" : {
                                "currency": "INR",
                                "value": "20"
                            },
                            "matched": true
                        }
                    ]
                }
            ]
        }
    }
}
*/
    public OnSearchRequest generateSearchResponse(List searchResult) {
        var searchResult = SearchResponseBuilder.builder.result(searchResult).build();
        // Convert response into protocol object similar to example above
        return searchResult;
    }

BPP calls protocol on_search

    public Response invokeOnSearch(OnSearchRequest searchResponse, HttpHeaders headers) {
        if(searchResponse.getError() == null) {
            // Call BAP on_search api with the search response

            // Call to look up function which returns the the public key and BAP/BG Endpoint to be called 
            var url = lookUp(headers);

            var response = apiClient.post(url[0] + Context.ActionEnum.on_search,
                    constructResponseHeaders(),
                    searchResponse,
                    OnSearchRequest.class);
            return Response.of("ACK", null);
        } else {
            return Response.of("NACK", null);
        }
    }