br.com.softplan.security.zap.zaproxy.clientapi.gen.Spider Maven / Gradle / Ivy

Go to download
/* Zed Attack Proxy (ZAP) and its related class files.
 *
 * ZAP is an HTTP/HTTPS proxy for assessing web application security.
 *
 * Copyright 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 br.com.softplan.security.zap.zaproxy.clientapi.gen;

import java.util.HashMap;
import java.util.Map;

import br.com.softplan.security.zap.zaproxy.clientapi.core.ApiResponse;
import br.com.softplan.security.zap.zaproxy.clientapi.core.ClientApi;
import br.com.softplan.security.zap.zaproxy.clientapi.core.ClientApiException;


/**
 * This file was automatically generated.
 */
public class Spider {

	private ClientApi api = null;

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

	public ApiResponse status(String scanid) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		map.put("scanId", scanid);
		return api.callApi("spider", "view", "status", map);
	}

	public ApiResponse results(String scanid) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		map.put("scanId", scanid);
		return api.callApi("spider", "view", "results", map);
	}

	public ApiResponse fullResults(String scanid) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		map.put("scanId", scanid);
		return api.callApi("spider", "view", "fullResults", map);
	}

	public ApiResponse scans() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "scans", map);
	}

	public ApiResponse excludedFromScan() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "excludedFromScan", map);
	}

	public ApiResponse optionDomainsAlwaysInScope() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "optionDomainsAlwaysInScope", map);
	}

	public ApiResponse optionDomainsAlwaysInScopeEnabled() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "optionDomainsAlwaysInScopeEnabled", map);
	}

	public ApiResponse optionHandleParameters() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "optionHandleParameters", map);
	}

	public ApiResponse optionMaxDepth() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "optionMaxDepth", map);
	}

	public ApiResponse optionMaxScansInUI() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "optionMaxScansInUI", map);
	}

	public ApiResponse optionRequestWaitTime() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "optionRequestWaitTime", map);
	}

	public ApiResponse optionScope() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "optionScope", map);
	}

	public ApiResponse optionScopeText() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "optionScopeText", map);
	}

	public ApiResponse optionSkipURLString() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "optionSkipURLString", map);
	}

	public ApiResponse optionThreadCount() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "optionThreadCount", map);
	}

	public ApiResponse optionUserAgent() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "optionUserAgent", map);
	}

	public ApiResponse optionHandleODataParametersVisited() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "optionHandleODataParametersVisited", map);
	}

	public ApiResponse optionParseComments() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "optionParseComments", map);
	}

	public ApiResponse optionParseGit() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "optionParseGit", map);
	}

	public ApiResponse optionParseRobotsTxt() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "optionParseRobotsTxt", map);
	}

	public ApiResponse optionParseSVNEntries() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "optionParseSVNEntries", map);
	}

	public ApiResponse optionParseSitemapXml() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "optionParseSitemapXml", map);
	}

	public ApiResponse optionPostForm() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "optionPostForm", map);
	}

	public ApiResponse optionProcessForm() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "optionProcessForm", map);
	}

	/**
	 * Sets whether or not the 'Referer' header should be sent while spidering
	 */
	public ApiResponse optionSendRefererHeader() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "optionSendRefererHeader", map);
	}

	public ApiResponse optionShowAdvancedDialog() throws ClientApiException {
		Map map = null;
		return api.callApi("spider", "view", "optionShowAdvancedDialog", map);
	}

	/**
	 * Runs the spider against the given URL. Optionally, the 'maxChildren' parameter can be set to limit the number of children scanned, the 'recurse' parameter can be used to prevent the spider from seeding recursively and the parameter 'contextName' can be used to constrain the scan to a Context.
	 */
	public ApiResponse scan(String apikey, String url, String maxchildren, String recurse, String contextname) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("url", url);
		map.put("maxChildren", maxchildren);
		map.put("recurse", recurse);
		map.put("contextName", contextname);
		return api.callApi("spider", "action", "scan", map);
	}

	/**
	 * Runs the spider from the perspective of a User, obtained using the given Context ID and User ID. See 'scan' action for more details.
	 */
	public ApiResponse scanAsUser(String apikey, String url, String contextid, String userid, String maxchildren, String recurse) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("url", url);
		map.put("contextId", contextid);
		map.put("userId", userid);
		map.put("maxChildren", maxchildren);
		map.put("recurse", recurse);
		return api.callApi("spider", "action", "scanAsUser", map);
	}

	public ApiResponse pause(String apikey, String scanid) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("scanId", scanid);
		return api.callApi("spider", "action", "pause", map);
	}

	public ApiResponse resume(String apikey, String scanid) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("scanId", scanid);
		return api.callApi("spider", "action", "resume", map);
	}

	public ApiResponse stop(String apikey, String scanid) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("scanId", scanid);
		return api.callApi("spider", "action", "stop", map);
	}

	public ApiResponse removeScan(String apikey, String scanid) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("scanId", scanid);
		return api.callApi("spider", "action", "removeScan", map);
	}

	public ApiResponse pauseAllScans(String apikey) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		return api.callApi("spider", "action", "pauseAllScans", map);
	}

	public ApiResponse resumeAllScans(String apikey) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		return api.callApi("spider", "action", "resumeAllScans", map);
	}

	public ApiResponse stopAllScans(String apikey) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		return api.callApi("spider", "action", "stopAllScans", map);
	}

	public ApiResponse removeAllScans(String apikey) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		return api.callApi("spider", "action", "removeAllScans", map);
	}

	public ApiResponse clearExcludedFromScan(String apikey) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		return api.callApi("spider", "action", "clearExcludedFromScan", map);
	}

	public ApiResponse excludeFromScan(String apikey, String regex) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("regex", regex);
		return api.callApi("spider", "action", "excludeFromScan", map);
	}

	public ApiResponse setOptionHandleParameters(String apikey, String string) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("String", string);
		return api.callApi("spider", "action", "setOptionHandleParameters", map);
	}

	public ApiResponse setOptionScopeString(String apikey, String string) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("String", string);
		return api.callApi("spider", "action", "setOptionScopeString", map);
	}

	public ApiResponse setOptionSkipURLString(String apikey, String string) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("String", string);
		return api.callApi("spider", "action", "setOptionSkipURLString", map);
	}

	public ApiResponse setOptionUserAgent(String apikey, String string) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("String", string);
		return api.callApi("spider", "action", "setOptionUserAgent", map);
	}

	public ApiResponse setOptionHandleODataParametersVisited(String apikey, boolean bool) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("Boolean", Boolean.toString(bool));
		return api.callApi("spider", "action", "setOptionHandleODataParametersVisited", map);
	}

	public ApiResponse setOptionMaxDepth(String apikey, int i) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("Integer", Integer.toString(i));
		return api.callApi("spider", "action", "setOptionMaxDepth", map);
	}

	public ApiResponse setOptionMaxScansInUI(String apikey, int i) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("Integer", Integer.toString(i));
		return api.callApi("spider", "action", "setOptionMaxScansInUI", map);
	}

	public ApiResponse setOptionParseComments(String apikey, boolean bool) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("Boolean", Boolean.toString(bool));
		return api.callApi("spider", "action", "setOptionParseComments", map);
	}

	public ApiResponse setOptionParseGit(String apikey, boolean bool) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("Boolean", Boolean.toString(bool));
		return api.callApi("spider", "action", "setOptionParseGit", map);
	}

	public ApiResponse setOptionParseRobotsTxt(String apikey, boolean bool) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("Boolean", Boolean.toString(bool));
		return api.callApi("spider", "action", "setOptionParseRobotsTxt", map);
	}

	public ApiResponse setOptionParseSVNEntries(String apikey, boolean bool) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("Boolean", Boolean.toString(bool));
		return api.callApi("spider", "action", "setOptionParseSVNEntries", map);
	}

	public ApiResponse setOptionParseSitemapXml(String apikey, boolean bool) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("Boolean", Boolean.toString(bool));
		return api.callApi("spider", "action", "setOptionParseSitemapXml", map);
	}

	public ApiResponse setOptionPostForm(String apikey, boolean bool) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("Boolean", Boolean.toString(bool));
		return api.callApi("spider", "action", "setOptionPostForm", map);
	}

	public ApiResponse setOptionProcessForm(String apikey, boolean bool) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("Boolean", Boolean.toString(bool));
		return api.callApi("spider", "action", "setOptionProcessForm", map);
	}

	public ApiResponse setOptionRequestWaitTime(String apikey, int i) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("Integer", Integer.toString(i));
		return api.callApi("spider", "action", "setOptionRequestWaitTime", map);
	}

	public ApiResponse setOptionSendRefererHeader(String apikey, boolean bool) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("Boolean", Boolean.toString(bool));
		return api.callApi("spider", "action", "setOptionSendRefererHeader", map);
	}

	public ApiResponse setOptionShowAdvancedDialog(String apikey, boolean bool) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("Boolean", Boolean.toString(bool));
		return api.callApi("spider", "action", "setOptionShowAdvancedDialog", map);
	}

	public ApiResponse setOptionThreadCount(String apikey, int i) throws ClientApiException {
		Map map = null;
		map = new HashMap();
		if (apikey != null) {
			map.put("apikey", apikey);
		}
		map.put("Integer", Integer.toString(i));
		return api.callApi("spider", "action", "setOptionThreadCount", map);
	}

}