org.zaproxy.zap.extension.spider

Class SpiderAPI

java.lang.Object

org.zaproxy.zap.extension.api.ApiImplementor

org.zaproxy.zap.extension.spider.SpiderAPI

public class SpiderAPI
extends ApiImplementor

Constructor Summary

Constructors

Constructor and Description
SpiderAPI(ExtensionSpider extension) Instantiates a new spider API.

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, addApiShortcut, addApiView, addCustomHeaders, getApiAction, getApiActions, getApiOther, getApiOthers, getApiShortcuts, getApiView, getApiViews, getParam, getParam, getParam, handleApiOptionAction, handleApiOptionView, handleApiOther, handleCallBack, handleShortcut, validateParamExists

Methods inherited from class java.lang.Object

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

Constructor Detail

SpiderAPI

public SpiderAPI(ExtensionSpider extension)

Instantiates a new spider API.

Parameters:

extension - the extension

Method Detail

getPrefix

public String getPrefix()

Specified by:

getPrefix in class ApiImplementor

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

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