Package org.zaproxy.clientapi.gen
Class Context
- java.lang.Object
-
- org.zaproxy.clientapi.gen.deprecated.ContextDeprecated
-
- org.zaproxy.clientapi.gen.Context
-
public class Context extends ContextDeprecated
This file was automatically generated.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ApiResponse
context(java.lang.String contextname)
List the information about the named contextApiResponse
contextList()
List context names of current sessionApiResponse
excludeAllContextTechnologies(java.lang.String contextname)
Excludes all built in technologies from a contextApiResponse
excludeContextTechnologies(java.lang.String contextname, java.lang.String technologynames)
Excludes technologies with the given names, separated by a comma, from a contextApiResponse
excludedTechnologyList(java.lang.String contextname)
Lists the names of all technologies excluded from a contextApiResponse
excludeFromContext(java.lang.String contextname, java.lang.String regex)
Add exclude regex to contextApiResponse
excludeRegexs(java.lang.String contextname)
List excluded regexs for contextApiResponse
exportContext(java.lang.String contextname, java.lang.String contextfile)
Exports the context with the given name to a file.ApiResponse
importContext(java.lang.String contextfile)
Imports a context from a file.ApiResponse
includeAllContextTechnologies(java.lang.String contextname)
Includes all built in technologies in to a contextApiResponse
includeContextTechnologies(java.lang.String contextname, java.lang.String technologynames)
Includes technologies with the given names, separated by a comma, to a contextApiResponse
includedTechnologyList(java.lang.String contextname)
Lists the names of all technologies included in a contextApiResponse
includeInContext(java.lang.String contextname, java.lang.String regex)
Add include regex to contextApiResponse
includeRegexs(java.lang.String contextname)
List included regexs for contextApiResponse
newContext(java.lang.String contextname)
Creates a new context with the given name in the current sessionApiResponse
removeContext(java.lang.String contextname)
Removes a context in the current sessionApiResponse
setContextCheckingStrategy(java.lang.String contextname, java.lang.String checkingstrategy, java.lang.String pollurl, java.lang.String polldata, java.lang.String pollheaders, java.lang.String pollfrequency, java.lang.String pollfrequencyunits)
Set the checking strategy for a context - this defines how ZAP checks that a request is authenticatedApiResponse
setContextInScope(java.lang.String contextname, java.lang.String booleaninscope)
Sets a context to in scope (contexts are in scope by default)ApiResponse
setContextRegexs(java.lang.String contextname, java.lang.String incregexs, java.lang.String excregexs)
Set the regexs to include and exclude for a context, both supplied as JSON string arraysApiResponse
technologyList()
Lists the names of all built in technologiesApiResponse
urls(java.lang.String contextname)
Lists the URLs accessed through/by ZAP, that belong to the context with the given name.-
Methods inherited from class org.zaproxy.clientapi.gen.deprecated.ContextDeprecated
excludeAllContextTechnologies, excludeContextTechnologies, excludeFromContext, exportContext, importContext, includeAllContextTechnologies, includeContextTechnologies, includeInContext, newContext, removeContext, setContextInScope
-
-
-
-
Constructor Detail
-
Context
public Context(ClientApi api)
-
-
Method Detail
-
contextList
public ApiResponse contextList() throws ClientApiException
List context names of current session- Throws:
ClientApiException
-
excludeRegexs
public ApiResponse excludeRegexs(java.lang.String contextname) throws ClientApiException
List excluded regexs for context- Throws:
ClientApiException
-
includeRegexs
public ApiResponse includeRegexs(java.lang.String contextname) throws ClientApiException
List included regexs for context- Throws:
ClientApiException
-
context
public ApiResponse context(java.lang.String contextname) throws ClientApiException
List the information about the named context- Throws:
ClientApiException
-
technologyList
public ApiResponse technologyList() throws ClientApiException
Lists the names of all built in technologies- Throws:
ClientApiException
-
includedTechnologyList
public ApiResponse includedTechnologyList(java.lang.String contextname) throws ClientApiException
Lists the names of all technologies included in a context- Throws:
ClientApiException
-
excludedTechnologyList
public ApiResponse excludedTechnologyList(java.lang.String contextname) throws ClientApiException
Lists the names of all technologies excluded from a context- Throws:
ClientApiException
-
urls
public ApiResponse urls(java.lang.String contextname) throws ClientApiException
Lists the URLs accessed through/by ZAP, that belong to the context with the given name.- Throws:
ClientApiException
-
excludeFromContext
public ApiResponse excludeFromContext(java.lang.String contextname, java.lang.String regex) throws ClientApiException
Add exclude regex to context- Throws:
ClientApiException
-
includeInContext
public ApiResponse includeInContext(java.lang.String contextname, java.lang.String regex) throws ClientApiException
Add include regex to context- Throws:
ClientApiException
-
setContextRegexs
public ApiResponse setContextRegexs(java.lang.String contextname, java.lang.String incregexs, java.lang.String excregexs) throws ClientApiException
Set the regexs to include and exclude for a context, both supplied as JSON string arrays- Throws:
ClientApiException
-
setContextCheckingStrategy
public ApiResponse setContextCheckingStrategy(java.lang.String contextname, java.lang.String checkingstrategy, java.lang.String pollurl, java.lang.String polldata, java.lang.String pollheaders, java.lang.String pollfrequency, java.lang.String pollfrequencyunits) throws ClientApiException
Set the checking strategy for a context - this defines how ZAP checks that a request is authenticated- Throws:
ClientApiException
-
newContext
public ApiResponse newContext(java.lang.String contextname) throws ClientApiException
Creates a new context with the given name in the current session- Throws:
ClientApiException
-
removeContext
public ApiResponse removeContext(java.lang.String contextname) throws ClientApiException
Removes a context in the current session- Throws:
ClientApiException
-
exportContext
public ApiResponse exportContext(java.lang.String contextname, java.lang.String contextfile) throws ClientApiException
Exports the context with the given name to a file. If a relative file path is specified it will be resolved against the "contexts" directory in ZAP "home" dir.- Throws:
ClientApiException
-
importContext
public ApiResponse importContext(java.lang.String contextfile) throws ClientApiException
Imports a context from a file. If a relative file path is specified it will be resolved against the "contexts" directory in ZAP "home" dir.- Throws:
ClientApiException
-
includeContextTechnologies
public ApiResponse includeContextTechnologies(java.lang.String contextname, java.lang.String technologynames) throws ClientApiException
Includes technologies with the given names, separated by a comma, to a context- Throws:
ClientApiException
-
includeAllContextTechnologies
public ApiResponse includeAllContextTechnologies(java.lang.String contextname) throws ClientApiException
Includes all built in technologies in to a context- Throws:
ClientApiException
-
excludeContextTechnologies
public ApiResponse excludeContextTechnologies(java.lang.String contextname, java.lang.String technologynames) throws ClientApiException
Excludes technologies with the given names, separated by a comma, from a context- Throws:
ClientApiException
-
excludeAllContextTechnologies
public ApiResponse excludeAllContextTechnologies(java.lang.String contextname) throws ClientApiException
Excludes all built in technologies from a context- Throws:
ClientApiException
-
setContextInScope
public ApiResponse setContextInScope(java.lang.String contextname, java.lang.String booleaninscope) throws ClientApiException
Sets a context to in scope (contexts are in scope by default)- Throws:
ClientApiException
-
-