Package org.zaproxy.zap.extension.api

Class ApiDynamicActionImplementor

java.lang.Object

org.zaproxy.zap.extension.api.ApiElement

org.zaproxy.zap.extension.api.ApiDynamicActionImplementor

public abstract class ApiDynamicActionImplementor
extends ApiElement

The ApiDynamicActionImplementor is used for actions that are loaded dynamically.

Constructor Summary

Constructors

Constructor	Description
ApiDynamicActionImplementor(java.lang.String name, java.lang.String[] mandatoryParamNames, java.lang.String[] optionalParamNames)	Instantiates a new api dynamic action implementor.

Method Summary

Modifier and Type	Method	Description
ApiResponse	buildParamsDescription()	Builds an ApiResponse describing the parameters of this action.
abstract void	handleAction(net.sf.json.JSONObject params)	Handle the execution of the action.

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

getDeprecatedDescription, getDescriptionTag, getMandatoryParamNames, getName, getOptionalParamNames, getParameters, isDeprecated, setDeprecated, setDeprecatedDescription, setDescriptionTag, setMandatoryParamNames, setMandatoryParamNames, setName, setOptionalParamNames, setOptionalParamNames

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiDynamicActionImplementor

public ApiDynamicActionImplementor(java.lang.String name,
                                   java.lang.String[] mandatoryParamNames,
                                   java.lang.String[] optionalParamNames)

Instantiates a new api dynamic action implementor.

Parameters:

name - the name

mandatoryParamNames - the mandatory param names, or null if there are no mandatory parameters

optionalParamNames - the optional param names, or null if there are no optional parameters

Method Detail

handleAction

public abstract void handleAction(net.sf.json.JSONObject params)
                           throws ApiException

Handle the execution of the action.

Parameters:

params - the params

Throws:

ApiException - the api exception

buildParamsDescription

public ApiResponse buildParamsDescription()

Builds an ApiResponse describing the parameters of this action.

Returns:

the api response set