org.zaproxy.zap.extension.keyboard

Class KeyboardAPI

java.lang.Object

org.zaproxy.zap.extension.api.ApiImplementor

org.zaproxy.zap.extension.keyboard.KeyboardAPI

public class KeyboardAPI
extends ApiImplementor

Constructor Summary

Constructors

Constructor and Description
KeyboardAPI(ExtensionKeyboard extension)

Method Summary

Modifier and Type	Method and Description
org.apache.commons.httpclient.URI	getCheatSheetActionURI()
org.apache.commons.httpclient.URI	getCheatSheetKeyURI()
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

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, handleApiAction, handleApiOptionAction, handleApiOptionView, handleApiView, handleCallBack, handleShortcut, validateParamExists

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyboardAPI

public KeyboardAPI(ExtensionKeyboard extension)

Method Detail

getPrefix

public String getPrefix()

Specified by:

getPrefix in class ApiImplementor

getCheatSheetActionURI

public org.apache.commons.httpclient.URI getCheatSheetActionURI()
                                                         throws org.apache.commons.httpclient.URIException,
                                                                NullPointerException

Throws:

org.apache.commons.httpclient.URIException

NullPointerException

getCheatSheetKeyURI

public org.apache.commons.httpclient.URI getCheatSheetKeyURI()
                                                      throws org.apache.commons.httpclient.URIException,
                                                             NullPointerException

Throws:

org.apache.commons.httpclient.URIException

NullPointerException

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