Class ForcedUserAPI
- java.lang.Object
-
- org.zaproxy.zap.extension.api.ApiImplementor
-
- org.zaproxy.zap.extension.forceduser.ForcedUserAPI
-
public class ForcedUserAPI extends ApiImplementor
The API for managing the Forced User for a Context.
-
-
Constructor Summary
Constructors Constructor Description ForcedUserAPI(ExtensionForcedUser extension)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getPrefix()
ApiResponse
handleApiAction(java.lang.String name, net.sf.json.JSONObject params)
Override if implementing one or more actionsApiResponse
handleApiView(java.lang.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, handleApiOptionAction, handleApiOptionView, handleApiOther, handleApiPersistentConnection, handleCallBack, handleShortcut, validateParamExists
-
-
-
-
Constructor Detail
-
ForcedUserAPI
public ForcedUserAPI(ExtensionForcedUser extension)
-
-
Method Detail
-
handleApiView
public ApiResponse handleApiView(java.lang.String name, net.sf.json.JSONObject params) throws ApiException
Description copied from class:ApiImplementor
Override if implementing one or more views- Overrides:
handleApiView
in classApiImplementor
- Parameters:
name
- the name of the requested viewparams
- the API request parameters- Returns:
- the API response
- Throws:
ApiException
- if an error occurred while handling the API view endpoint
-
handleApiAction
public ApiResponse handleApiAction(java.lang.String name, net.sf.json.JSONObject params) throws ApiException
Description copied from class:ApiImplementor
Override if implementing one or more actions- Overrides:
handleApiAction
in classApiImplementor
- Parameters:
name
- the name of the requested actionparams
- the API request parameters- Returns:
- the API response
- Throws:
ApiException
- if an error occurred while handling the API action endpoint
-
getPrefix
public java.lang.String getPrefix()
- Specified by:
getPrefix
in classApiImplementor
-
-