org.zaproxy.zap.extension.api

Class ApiImplementor

java.lang.Object

org.zaproxy.zap.extension.api.ApiImplementor

Direct Known Subclasses:

ActiveScanAPI, AlertAPI, AntiCsrfAPI, AuthenticationAPI, AuthorizationAPI, AutoUpdateAPI, BreakAPI, ContextAPI, CoreAPI, ForcedUserAPI, HttpSessionsAPI, KeyboardAPI, ParamsAPI, PassiveScanAPI, ProxiesAPI, RuleConfigAPI, ScriptAPI, SearchAPI, SessionManagementAPI, SpiderAPI, StatsAPI, UsersAPI

public abstract class ApiImplementor
extends Object

Constructor Summary

Constructors

Constructor and Description
ApiImplementor()

Method Summary

Modifier and Type	Method and Description
void	addApiAction(ApiAction action)
void	addApiOptions(AbstractParam param) Adds the given options to the API implementor.
void	addApiOthers(ApiOther other)
void	addApiPersistentConnection(ApiPersistentConnection pconn)
void	addApiShortcut(String shortcut)
void	addApiView(ApiView view)
void	addCustomHeaders(String name, API.RequestType type, HttpMessage msg) Override to add custom headers for specific API operations
ApiAction	getApiAction(String name)
List<ApiAction>	getApiActions()
ApiOther	getApiOther(String name)
List<ApiOther>	getApiOthers()
ApiPersistentConnection	getApiPersistentConnection(String name)
List<ApiPersistentConnection>	getApiPersistentConnections()
protected List<String>	getApiShortcuts()
ApiView	getApiView(String name)
List<ApiView>	getApiViews()
String	getDescriptionKey() Gets the resource key of the description.
protected String	getI18nPrefix() Gets the prefix for default resource keys for the description of the API implementor and its elements.
protected boolean	getParam(net.sf.json.JSONObject params, String name, boolean defaultValue)
protected int	getParam(net.sf.json.JSONObject params, String name, int defaultValue)
protected long	getParam(net.sf.json.JSONObject params, String name, long defaultValue)
protected String	getParam(net.sf.json.JSONObject params, String name, String defaultValue)
abstract String	getPrefix()
ApiResponse	handleApiAction(String name, net.sf.json.JSONObject params) Override if implementing one or more actions
ApiResponse	handleApiOptionAction(String name, net.sf.json.JSONObject params)
ApiResponse	handleApiOptionView(String name, net.sf.json.JSONObject params)
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
void	handleApiPersistentConnection(HttpMessage msg, HttpInputStream httpIn, HttpOutputStream httpOut, String name, net.sf.json.JSONObject params) Override if implementing one or more 'persistent connection' operations.
ApiResponse	handleApiView(String name, net.sf.json.JSONObject params) Override if implementing one or more views
String	handleCallBack(HttpMessage msg) Override if handling callbacks
HttpMessage	handleShortcut(HttpMessage msg)
protected void	validateParamExists(net.sf.json.JSONObject parameters, String name) Validates that a parameter with the given name exists (and it has a value) in the given parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiImplementor

public ApiImplementor()

Method Detail

getApiViews

public List<ApiView> getApiViews()

getApiActions

public List<ApiAction> getApiActions()

getApiOthers

public List<ApiOther> getApiOthers()

addApiView

public void addApiView(ApiView view)

addApiOthers

public void addApiOthers(ApiOther other)

addApiAction

public void addApiAction(ApiAction action)

addApiShortcut

public void addApiShortcut(String shortcut)

addApiPersistentConnection

public void addApiPersistentConnection(ApiPersistentConnection pconn)

addApiOptions

public void addApiOptions(AbstractParam param)

Adds the given options to the API implementor.

Parameters:

param - the options for the API

See Also:

ZapApiIgnore

handleApiOptionView

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

Throws:

ApiException

handleApiOptionAction

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

Throws:

ApiException

handleApiView

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

Override if implementing one or more views

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

Override if implementing one or more actions

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

handleApiOther

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

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

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

handleApiPersistentConnection

public void handleApiPersistentConnection(HttpMessage msg,
                                          HttpInputStream httpIn,
                                          HttpOutputStream httpOut,
                                          String name,
                                          net.sf.json.JSONObject params)
                                   throws ApiException

Override if implementing one or more 'persistent connection' operations. These are operations that maintain long running connections, potentially staying alive as long as the client holds them open.

Parameters:

msg - the HTTP message containing the API request

httpIn - the input stream

httpOut - the output stream

name - the name of the requested pconn endpoint

params - the API request parameters

Throws:

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

handleCallBack

public String handleCallBack(HttpMessage msg)
                      throws ApiException

Override if handling callbacks

Parameters:

msg - the HTTP message containing the API request and response

Returns:

the API response (set in the HTTP response body)

Throws:

ApiException - if an error occurred while handling the API callback

handleShortcut

public HttpMessage handleShortcut(HttpMessage msg)
                           throws ApiException

Throws:

ApiException

getPrefix

public abstract String getPrefix()

getI18nPrefix

protected String getI18nPrefix()

Gets the prefix for default resource keys for the description of the API implementor and its elements.

Defaults to getPrefix().

Returns:

the prefix for i18n keys.

Since:

2.10.0

getDescriptionKey

public String getDescriptionKey()

Gets the resource key of the description.

Defaults to getI18nPrefix() + ".api.desc".

Returns:

the key of the description.

Since:

2.9.0

See Also:

I18N.getString(String)

getApiAction

public ApiAction getApiAction(String name)

getApiView

public ApiView getApiView(String name)

getApiOther

public ApiOther getApiOther(String name)

getApiShortcuts

protected List<String> getApiShortcuts()

getApiPersistentConnection

public ApiPersistentConnection getApiPersistentConnection(String name)

getApiPersistentConnections

public List<ApiPersistentConnection> getApiPersistentConnections()

getParam

protected int getParam(net.sf.json.JSONObject params,
                       String name,
                       int defaultValue)

getParam

protected long getParam(net.sf.json.JSONObject params,
                        String name,
                        long defaultValue)

getParam

protected String getParam(net.sf.json.JSONObject params,
                          String name,
                          String defaultValue)

getParam

protected boolean getParam(net.sf.json.JSONObject params,
                           String name,
                           boolean defaultValue)

validateParamExists

protected void validateParamExists(net.sf.json.JSONObject parameters,
                                   String name)
                            throws ApiException

Validates that a parameter with the given name exists (and it has a value) in the given parameters.

Parameters:

parameters - the parameters

name - the name of the parameter that must exist

Throws:

ApiException - if the parameter with the given name does not exist or it has no value.

Since:

2.6.0

addCustomHeaders

public void addCustomHeaders(String name,
                             API.RequestType type,
                             HttpMessage msg)

Override to add custom headers for specific API operations

Parameters:

name - the name of the operation

type - the type of the operation

msg - the HTTP response message to the API request