/*
 * Copyright (c) 2020, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
 *
 * WSO2 Inc. 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 org.wso2.carbon.siddhi.editor.core.util.errorhandler.api;

import com.google.gson.JsonArray;
import com.google.gson.JsonObject;
import org.wso2.carbon.siddhi.editor.core.exception.ErrorHandlerServiceStubException;

/**
 * Describes methods that communicate with the Error Handler API, exposed from the SI server.
 */
public interface ErrorHandlerApiHelperService {

    JsonArray getSiddhiAppList(String hostAndPort, String username, String password)
        throws ErrorHandlerServiceStubException;

    JsonObject getTotalErrorEntriesCount(String hostAndPort, String username, String password)
        throws ErrorHandlerServiceStubException;

    JsonObject getErrorEntriesCount(String siddhiAppName, String hostAndPort, String username, String password)
        throws ErrorHandlerServiceStubException;

    JsonArray getMinimalErrorEntries(String siddhiAppName, String limit, String offset, String hostAndPort,
                                     String username, String password) throws ErrorHandlerServiceStubException;

    JsonObject getDescriptiveErrorEntry(String id, String hostAndPort, String username, String password)
        throws ErrorHandlerServiceStubException;

    boolean replay(JsonArray payload, String hostAndPort, String username, String password)
        throws ErrorHandlerServiceStubException;

    boolean discardErrorEntry(String id, String hostAndPort, String username, String password)
        throws ErrorHandlerServiceStubException;

    boolean discardErrorEntries(String siddhiAppName, String hostAndPort, String username, String password)
        throws ErrorHandlerServiceStubException;

    boolean doPurge(int retentionDays, String hostAndPort, String username, String password)
        throws ErrorHandlerServiceStubException;
}
