Package org.zaproxy.clientapi.gen
Class Context
java.lang.Object
org.zaproxy.clientapi.gen.deprecated.ContextDeprecated
org.zaproxy.clientapi.gen.Context
This file was automatically generated.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionList the information about the named contextList context names of current sessionexcludeAllContextTechnologies(String contextname) Excludes all built in technologies from a contextexcludeContextTechnologies(String contextname, String technologynames) Excludes technologies with the given names, separated by a comma, from a contextexcludedTechnologyList(String contextname) Lists the names of all technologies excluded from a contextexcludeFromContext(String contextname, String regex) Add exclude regex to contextexcludeRegexs(String contextname) List excluded regexs for contextexportContext(String contextname, String contextfile) Exports the context with the given name to a file.importContext(String contextfile) Imports a context from a file.includeAllContextTechnologies(String contextname) Includes all built in technologies in to a contextincludeContextTechnologies(String contextname, String technologynames) Includes technologies with the given names, separated by a comma, to a contextincludedTechnologyList(String contextname) Lists the names of all technologies included in a contextincludeInContext(String contextname, String regex) Add include regex to contextincludeRegexs(String contextname) List included regexs for contextnewContext(String contextname) Creates a new context with the given name in the current sessionremoveContext(String contextname) Removes a context in the current sessionsetContextCheckingStrategy(String contextname, String checkingstrategy, String pollurl, String polldata, String pollheaders, String pollfrequency, String pollfrequencyunits) Set the checking strategy for a context - this defines how ZAP checks that a request is authenticatedsetContextInScope(String contextname, String booleaninscope) Sets a context to in scope (contexts are in scope by default)setContextRegexs(String contextname, String incregexs, String excregexs) Set the regexs to include and exclude for a context, both supplied as JSON string arraysLists the names of all built in technologiesLists 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 Details
-
Context
-
-
Method Details
-
contextList
List context names of current session- Throws:
ClientApiException
-
excludeRegexs
List excluded regexs for context- Throws:
ClientApiException
-
includeRegexs
List included regexs for context- Throws:
ClientApiException
-
context
List the information about the named context- Throws:
ClientApiException
-
technologyList
Lists the names of all built in technologies- Throws:
ClientApiException
-
includedTechnologyList
Lists the names of all technologies included in a context- Throws:
ClientApiException
-
excludedTechnologyList
Lists the names of all technologies excluded from a context- Throws:
ClientApiException
-
urls
Lists the URLs accessed through/by ZAP, that belong to the context with the given name.- Throws:
ClientApiException
-
excludeFromContext
Add exclude regex to context- Throws:
ClientApiException
-
includeInContext
Add include regex to context- Throws:
ClientApiException
-
setContextRegexs
public ApiResponse setContextRegexs(String contextname, String incregexs, 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(String contextname, String checkingstrategy, String pollurl, String polldata, String pollheaders, String pollfrequency, String pollfrequencyunits) throws ClientApiException Set the checking strategy for a context - this defines how ZAP checks that a request is authenticated- Throws:
ClientApiException
-
newContext
Creates a new context with the given name in the current session- Throws:
ClientApiException
-
removeContext
Removes a context in the current session- Throws:
ClientApiException
-
exportContext
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
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(String contextname, String technologynames) throws ClientApiException Includes technologies with the given names, separated by a comma, to a context- Throws:
ClientApiException
-
includeAllContextTechnologies
Includes all built in technologies in to a context- Throws:
ClientApiException
-
excludeContextTechnologies
public ApiResponse excludeContextTechnologies(String contextname, String technologynames) throws ClientApiException Excludes technologies with the given names, separated by a comma, from a context- Throws:
ClientApiException
-
excludeAllContextTechnologies
Excludes all built in technologies from a context- Throws:
ClientApiException
-
setContextInScope
public ApiResponse setContextInScope(String contextname, String booleaninscope) throws ClientApiException Sets a context to in scope (contexts are in scope by default)- Throws:
ClientApiException
-