Sending the fare products of a mobility service (Java)

In this use case, the user views the various fare products a mobility service provider offers. Fare products are various offerings on a particular service like "Monthly Pass", "Single Journey Adult Ticket", "Return Ticket", "Day Pass" etc. These fare products are usually represented as items of a mobility service catalog. Other examples include products like "Uber Go", "Uber X" etc

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" : "12.9349377,77.6055586"
                    }
                },
                "end" : {
                    "location" : {
                        "gps" : "12.4535445,77.9283792"
                    }
                }
            }
        }
    }
}
*/
    // 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": "Mock BPP"
            },
            "bpp/providers": [
                {
                    "id": "metro-one",
                    "descriptor" : {
                        "name": "Metro One"
                    },
                    "categories": [
                        {
                            "id": "monthly",
                            "descriptor": {
                                "name": "Monthly Pass"
                            }
                        },
                        {
                            "id": "day",
                            "descriptor": {
                                "name": "Day Pass"
                            }
                        }
                    ],
                    "items": [
                        {
                            "id": "monthly_one_way",
                            "descriptor" : {
                                "name" : "One way monthly pass",
                                "images" : [
                                    "https://mock_bpp.com/images/m1.jpg"
                                ]
                            },
                            "category_id": "monthly",
                            "price" : {
                                "currency": "INR",
                                "value": "500"
                            },
                            "time": {
                                "range": {
                                    "start": "2021-08-17T05:22:34.861Z",
                                    "end": "2021-09-17T05:22:34.861Z"
                                }
                            },
                            "matched": true
                        },
                        {
                            "id": "monthly_two_way",
                            "descriptor" : {
                                "name" : "Two way monthly pass",
                                "images" : [
                                    "https://mock_bpp.com/images/m2.jpg"
                                ]
                            },
                            "category_id": "monthly",
                            "price" : {
                                "currency": "INR",
                                "value": "1000"
                            },
                            "time": {
                                "range": {
                                    "start": "2021-08-17T05:22:34.861Z",
                                    "end": "2021-09-17T05:22:34.861Z"
                                }
                            },
                            "matched": true
                        },
                        {
                            "id": "unlimited_day",
                            "descriptor" : {
                                "name" : "Unlimited Day Pass",
                                "images" : [
                                    "https://mock_bpp.com/images/du.jpg"
                                ]
                            },
                            "category_id": "day",
                            "price" : {
                                "currency": "INR",
                                "value": "200"
                            },
                            "time": {
                                "range": {
                                    "start": "2021-08-17T05:22:34.861Z",
                                    "end": "2021-08-18T05:22:34.861Z"
                                }
                            },
                            "matched": true
                        },
                        {
                            "id": "day_two_way",
                            "descriptor" : {
                                "name" : "Two way day pass",
                                "images" : [
                                    "https://mock_bpp.com/images/d2.jpg"
                                ]
                            },
                            "category_id": "day",
                            "price" : {
                                "currency": "INR",
                                "value": "50"
                            },
                            "time": {
                                "range": {
                                    "start": "2021-08-17T05:22:34.861Z",
                                    "end": "2021-08-18T05:22:34.861Z"
                                }
                            },
                            "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);
        }
    }