org.zaproxy.zap.extension.anticsrf

Class AntiCsrfAPI

java.lang.Object

org.zaproxy.zap.extension.api.ApiImplementor

org.zaproxy.zap.extension.anticsrf.AntiCsrfAPI

public class AntiCsrfAPI
extends ApiImplementor

Constructor Summary

Constructors

Constructor and Description
AntiCsrfAPI(ExtensionAntiCSRF ext)

Method Summary

Modifier and Type	Method and Description
static String	getAntiCsrfFormUrl(int hrefid)
String	getPrefix()
HttpMessage	handleApiOther(HttpMessage msg, String name, net.sf.json.JSONObject params) Override if implementing one or more 'other' operations - these are operations that _dont_ return structured data
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, handleApiAction, handleApiOptionAction, handleApiOptionView, handleApiPersistentConnection, handleCallBack, handleShortcut, validateParamExists

Methods inherited from class java.lang.Object

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

Constructor Detail

AntiCsrfAPI

public AntiCsrfAPI(ExtensionAntiCSRF ext)

Method Detail

getPrefix

public String getPrefix()

Specified by:

getPrefix in class ApiImplementor

getAntiCsrfFormUrl

public static String getAntiCsrfFormUrl(int hrefid)

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

handleApiOther

public HttpMessage handleApiOther(HttpMessage msg,
                                  String name,
                                  net.sf.json.JSONObject params)
                           throws ApiException

Description copied from class: ApiImplementor

Override if implementing one or more 'other' operations - these are operations that _dont_ return structured data

Overrides:

handleApiOther in class ApiImplementor

Parameters:

msg - the HTTP message containing the API request

name - the name of the requested other endpoint

params - the API request parameters

Returns:

the HTTP message with the API response

Throws:

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