/**
 * Copyright (c) 2023, WSO2 LLC. (https://www.wso2.com).
 *
 * WSO2 LLC. licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package com.wso2.openbanking.accelerator.event.notifications.service.handler;

import com.wso2.openbanking.accelerator.event.notifications.service.dto.EventPollingDTO;
import com.wso2.openbanking.accelerator.event.notifications.service.response.EventPollingResponse;
import net.minidev.json.JSONObject;

/**
 * EventPolling Service handler is used to validate and map the polling request to the DTO before calling the
 * polling service. For custom validations this class can be extended and the extended class
 * can be added to the deployment.toml under event_polling_handler to execute the specific class.
 */
public interface EventPollingServiceHandler {
    /**
     * This method follows the IETF Specification for SET delivery over HTTP.
     * The method supports event acknowledgment in both positive and negative.
     * Also, can be used to POLL for available OPEN notifications.
     * @param eventPollingRequest  JSON request for event polling
     * @return EventPollingResponse to the polling endpoint.
     */
    EventPollingResponse pollEvents(JSONObject eventPollingRequest);

    /**
     * This method is used to map the eventPollingRequest to EventPollingDTO.
     * @param eventPollingRequest JSON request for event polling
     * @return eventPollingDTO with the request parameters.
     */
    EventPollingDTO mapPollingRequest(JSONObject eventPollingRequest);

}

