org.zaproxy.clientapi.gen.Exportreport Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of zap-clientapi Show documentation

Java implementation to access OWASP ZAP API.

There is a newer version: 1.14.0

/*
 * Zed Attack Proxy (ZAP) and its related class files.
 *
 * ZAP is an HTTP/HTTPS proxy for assessing web application security.
 *
 * Copyright 2020 The ZAP Development Team
 *
 * Licensed 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.zaproxy.clientapi.gen;

import java.util.HashMap;
import java.util.Map;
import org.zaproxy.clientapi.core.ApiResponse;
import org.zaproxy.clientapi.core.ClientApi;
import org.zaproxy.clientapi.core.ClientApiException;

/** This file was automatically generated. */
@SuppressWarnings("javadoc")
public class Exportreport {

    private final ClientApi api;

    public Exportreport(ClientApi api) {
        this.api = api;
    }

    /** This component is optional and therefore the API will only work if it is installed */
    public ApiResponse formats() throws ClientApiException {
        return api.callApi("exportreport", "view", "formats", null);
    }

    /** This component is optional and therefore the API will only work if it is installed */
    public ApiResponse generate(
            String absolutepath,
            String fileextension,
            String sourcedetails,
            String alertseverity,
            String alertdetails,
            String scanid,
            String includepassivealerts)
            throws ClientApiException {
        Map map = new HashMap<>();
        map.put("absolutePath", absolutepath);
        map.put("fileExtension", fileextension);
        map.put("sourceDetails", sourcedetails);
        map.put("alertSeverity", alertseverity);
        map.put("alertDetails", alertdetails);
        if (scanid != null) {
            map.put("scanId", scanid);
        }
        if (includepassivealerts != null) {
            map.put("includePassiveAlerts", includepassivealerts);
        }
        return api.callApi("exportreport", "action", "generate", map);
    }
}