org.zaproxy.clientapi.gen.Script 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
Show all versions of zap-clientapi Show documentation
Java implementation to access OWASP ZAP API.
/*
* Zed Attack Proxy (ZAP) and its related class files.
*
* ZAP is an HTTP/HTTPS proxy for assessing web application security.
*
* Copyright 2017 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.nio.charset.Charset;
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 Script extends org.zaproxy.clientapi.gen.deprecated.ScriptDeprecated {
private final ClientApi api;
public Script(ClientApi api) {
super(api);
this.api = api;
}
/** Lists the script engines available */
public ApiResponse listEngines() throws ClientApiException {
return api.callApi("script", "view", "listEngines", null);
}
/** Lists the script types available. */
public ApiResponse listTypes() throws ClientApiException {
return api.callApi("script", "view", "listTypes", null);
}
/** Lists the scripts available, with its engine, name, description, type and error state. */
public ApiResponse listScripts() throws ClientApiException {
return api.callApi("script", "view", "listScripts", null);
}
/**
* Gets the value of the global variable with the given key. Returns an API error
* (DOES_NOT_EXIST) if no value was previously set.
*/
public ApiResponse globalVar(String varkey) throws ClientApiException {
Map map = new HashMap<>();
map.put("varKey", varkey);
return api.callApi("script", "view", "globalVar", map);
}
/**
* Gets the value (string representation) of a global custom variable. Returns an API error
* (DOES_NOT_EXIST) if no value was previously set.
*/
public ApiResponse globalCustomVar(String varkey) throws ClientApiException {
Map map = new HashMap<>();
map.put("varKey", varkey);
return api.callApi("script", "view", "globalCustomVar", map);
}
/** Gets all the global variables (key/value pairs). */
public ApiResponse globalVars() throws ClientApiException {
return api.callApi("script", "view", "globalVars", null);
}
/**
* Gets all the global custom variables (key/value pairs, the value is the string
* representation).
*/
public ApiResponse globalCustomVars() throws ClientApiException {
return api.callApi("script", "view", "globalCustomVars", null);
}
/**
* Gets the value of the variable with the given key for the given script. Returns an API error
* (DOES_NOT_EXIST) if no script with the given name exists or if no value was previously set.
*/
public ApiResponse scriptVar(String scriptname, String varkey) throws ClientApiException {
Map map = new HashMap<>();
map.put("scriptName", scriptname);
map.put("varKey", varkey);
return api.callApi("script", "view", "scriptVar", map);
}
/**
* Gets the value (string representation) of a custom variable. Returns an API error
* (DOES_NOT_EXIST) if no script with the given name exists or if no value was previously set.
*/
public ApiResponse scriptCustomVar(String scriptname, String varkey) throws ClientApiException {
Map map = new HashMap<>();
map.put("scriptName", scriptname);
map.put("varKey", varkey);
return api.callApi("script", "view", "scriptCustomVar", map);
}
/**
* Gets all the variables (key/value pairs) of the given script. Returns an API error
* (DOES_NOT_EXIST) if no script with the given name exists.
*/
public ApiResponse scriptVars(String scriptname) throws ClientApiException {
Map map = new HashMap<>();
map.put("scriptName", scriptname);
return api.callApi("script", "view", "scriptVars", map);
}
/**
* Gets all the custom variables (key/value pairs, the value is the string representation) of a
* script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists.
*/
public ApiResponse scriptCustomVars(String scriptname) throws ClientApiException {
Map map = new HashMap<>();
map.put("scriptName", scriptname);
return api.callApi("script", "view", "scriptCustomVars", map);
}
/** Enables the script with the given name */
public ApiResponse enable(String scriptname) throws ClientApiException {
Map map = new HashMap<>();
map.put("scriptName", scriptname);
return api.callApi("script", "action", "enable", map);
}
/** Disables the script with the given name */
public ApiResponse disable(String scriptname) throws ClientApiException {
Map map = new HashMap<>();
map.put("scriptName", scriptname);
return api.callApi("script", "action", "disable", map);
}
/**
* Loads a script into ZAP from the given local file, with the given name, type and engine,
* optionally with a description, and a charset name to read the script (the charset name is
* required if the script is not in UTF-8, for example, in ISO-8859-1).
*/
public ApiResponse load(
String scriptname,
String scripttype,
String scriptengine,
String filename,
String scriptdescription,
Charset charset)
throws ClientApiException {
Map map = new HashMap<>();
map.put("scriptName", scriptname);
map.put("scriptType", scripttype);
map.put("scriptEngine", scriptengine);
map.put("fileName", filename);
if (scriptdescription != null) {
map.put("scriptDescription", scriptdescription);
}
if (charset != null) {
map.put("charset", charset.name());
}
return api.callApi("script", "action", "load", map);
}
/** Removes the script with the given name */
public ApiResponse remove(String scriptname) throws ClientApiException {
Map map = new HashMap<>();
map.put("scriptName", scriptname);
return api.callApi("script", "action", "remove", map);
}
/** Runs the stand alone script with the given name */
public ApiResponse runStandAloneScript(String scriptname) throws ClientApiException {
Map map = new HashMap<>();
map.put("scriptName", scriptname);
return api.callApi("script", "action", "runStandAloneScript", map);
}
/** Clears the global variable with the given key. */
public ApiResponse clearGlobalVar(String varkey) throws ClientApiException {
Map map = new HashMap<>();
map.put("varKey", varkey);
return api.callApi("script", "action", "clearGlobalVar", map);
}
/** Clears a global custom variable. */
public ApiResponse clearGlobalCustomVar(String varkey) throws ClientApiException {
Map map = new HashMap<>();
map.put("varKey", varkey);
return api.callApi("script", "action", "clearGlobalCustomVar", map);
}
/** Clears the global variables. */
public ApiResponse clearGlobalVars() throws ClientApiException {
return api.callApi("script", "action", "clearGlobalVars", null);
}
/**
* Clears the variable with the given key of the given script. Returns an API error
* (DOES_NOT_EXIST) if no script with the given name exists.
*/
public ApiResponse clearScriptVar(String scriptname, String varkey) throws ClientApiException {
Map map = new HashMap<>();
map.put("scriptName", scriptname);
map.put("varKey", varkey);
return api.callApi("script", "action", "clearScriptVar", map);
}
/** Clears a script custom variable. */
public ApiResponse clearScriptCustomVar(String scriptname, String varkey)
throws ClientApiException {
Map map = new HashMap<>();
map.put("scriptName", scriptname);
map.put("varKey", varkey);
return api.callApi("script", "action", "clearScriptCustomVar", map);
}
/**
* Clears the variables of the given script. Returns an API error (DOES_NOT_EXIST) if no script
* with the given name exists.
*/
public ApiResponse clearScriptVars(String scriptname) throws ClientApiException {
Map map = new HashMap<>();
map.put("scriptName", scriptname);
return api.callApi("script", "action", "clearScriptVars", map);
}
/**
* Sets the value of the variable with the given key of the given script. Returns an API error
* (DOES_NOT_EXIST) if no script with the given name exists.
*/
public ApiResponse setScriptVar(String scriptname, String varkey, String varvalue)
throws ClientApiException {
Map map = new HashMap<>();
map.put("scriptName", scriptname);
map.put("varKey", varkey);
if (varvalue != null) {
map.put("varValue", varvalue);
}
return api.callApi("script", "action", "setScriptVar", map);
}
/** Sets the value of the global variable with the given key. */
public ApiResponse setGlobalVar(String varkey, String varvalue) throws ClientApiException {
Map map = new HashMap<>();
map.put("varKey", varkey);
if (varvalue != null) {
map.put("varValue", varvalue);
}
return api.callApi("script", "action", "setGlobalVar", map);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy