org.zaproxy.zap.extension.script

Class ScriptAPI

java.lang.Object

org.zaproxy.zap.extension.api.ApiImplementor

org.zaproxy.zap.extension.script.ScriptAPI

public class ScriptAPI
extends ApiImplementor

Constructor Summary

Constructors

Constructor and Description
ScriptAPI(ExtensionScript extension)

Method Summary

Modifier and Type	Method and Description
String	getPrefix()
ApiResponse	handleApiAction(String name, net.sf.json.JSONObject params) Override if implementing one or more actions
ApiResponse	handleApiView(String name, net.sf.json.JSONObject params) Override if implementing one or more views

Methods inherited from class org.zaproxy.zap.extension.api.ApiImplementor

addApiAction, addApiOptions, addApiOthers, addApiPersistentConnection, addApiShortcut, addApiView, addCustomHeaders, getApiAction, getApiActions, getApiOther, getApiOthers, getApiPersistentConnection, getApiPersistentConnections, getApiShortcuts, getApiView, getApiViews, getDescriptionKey, getI18nPrefix, getParam, getParam, getParam, getParam, handleApiOptionAction, handleApiOptionView, handleApiOther, handleApiPersistentConnection, handleCallBack, handleShortcut, validateParamExists

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScriptAPI

public ScriptAPI(ExtensionScript extension)

Method Detail

getPrefix

public String getPrefix()

Specified by:

getPrefix in class ApiImplementor

handleApiView

public ApiResponse handleApiView(String name,
                                 net.sf.json.JSONObject params)
                          throws ApiException

Description copied from class: ApiImplementor

Override if implementing one or more views

Overrides:

handleApiView in class ApiImplementor

Parameters:

name - the name of the requested view

params - the API request parameters

Returns:

the API response

Throws:

ApiException - if an error occurred while handling the API view endpoint

handleApiAction

public ApiResponse handleApiAction(String name,
                                   net.sf.json.JSONObject params)
                            throws ApiException

Description copied from class: ApiImplementor

Override if implementing one or more actions

Overrides:

handleApiAction in class ApiImplementor

Parameters:

name - the name of the requested action

params - the API request parameters

Returns:

the API response

Throws:

ApiException - if an error occurred while handling the API action endpoint