Context (OWASP Zed Attack Proxy)

java.lang.Object
- org.zaproxy.zap.model.Context

```
public class Context
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONTEXT_CONFIG`
`static String`	`CONTEXT_CONFIG_DATA_DRIVEN_NODES`
`static String`	`CONTEXT_CONFIG_DESC`
`static String`	`CONTEXT_CONFIG_EXC_REGEXES`
`static String`	`CONTEXT_CONFIG_INC_REGEXES`
`static String`	`CONTEXT_CONFIG_INSCOPE`
`static String`	`CONTEXT_CONFIG_NAME`
`static String`	`CONTEXT_CONFIG_POSTPARSER`
`static String`	`CONTEXT_CONFIG_POSTPARSER_CLASS`
`static String`	`CONTEXT_CONFIG_POSTPARSER_CONFIG`
`static String`	`CONTEXT_CONFIG_TECH`
`static String`	`CONTEXT_CONFIG_TECH_EXCLUDE`
`static String`	`CONTEXT_CONFIG_TECH_INCLUDE`
`static String`	`CONTEXT_CONFIG_URLPARSER`
`static String`	`CONTEXT_CONFIG_URLPARSER_CLASS`
`static String`	`CONTEXT_CONFIG_URLPARSER_CONFIG`

Constructor Summary

Constructors
Constructor and Description

Context(Session session, int id)

Constructors
Constructor and Description
`Context(Session session, int id)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addCustomPage(CustomPage customPage)` Adds a custom page.
`void`	`addDataDrivenNodes(StructuralNodeModifier ddn)`
`void`	`addExcludeFromContextRegex(String excludeRegex)`
`void`	`addIncludeInContextRegex(String includeRegex)`
`Context`	`duplicate()` Creates a copy of the Context.
`boolean`	`equals(Object obj)`
`void`	`excludeFromContext(SiteNode sn, boolean recurse)`
`void`	`excludeFromContext(StructuralNode sn, boolean recurse)`
`AuthenticationMethod`	`getAuthenticationMethod()` Gets the authentication method corresponding to this context.
`AuthorizationDetectionMethod`	`getAuthorizationDetectionMethod()` Gets the authorization detection method corresponding to this context.
`List<CustomPage>`	`getCustomPages()` Gets an unmodifiable view of the list of custom pages.
`List<StructuralNodeModifier>`	`getDataDrivenNodes()`
`String`	`getDefaultDDNName()`
`String`	`getDescription()`
`List<String>`	`getExcludeFromContextRegexs()`
`int`	`getId()` Returns the ID of the `Context`
`List<String>`	`getIncludeInContextRegexs()`
`int`	`getIndex()` Deprecated. (2.9.0) Use `getId()` instead.
`String`	`getName()` Gets the name of the context.
`List<SiteNode>`	`getNodesInContextFromSiteTree()` Gets the nodes from the site tree which are "In Scope".
`ParameterParser`	`getPostParamParser()`
`SessionManagementMethod`	`getSessionManagementMethod()` Gets the session management method corresponding to this context.
`TechSet`	`getTechSet()`
`List<SiteNode>`	`getTopNodesInContextFromSiteTree()` Gets the nodes from the site tree which are "In Scope".
`ParameterParser`	`getUrlParamParser()`
`boolean`	`hasCustomPageOfType(CustomPage.Type cpType)` Returns `true` if the `Context` has Custom Page definitions of a specific `CustomPage.Type`.
`boolean`	`hasCustomPages()` Returns `true` if the `Context` has Custom Pages.
`int`	`hashCode()`
`boolean`	`hasNodesInContextFromSiteTree()` Tells whether or not there's at least one node from the sites tree in context.
`boolean`	`isCustomPage(HttpMessage msg, CustomPage.Type cpType)` Determines if a `HttpMessage` is a Custom Page of a particular `CustomPage.Type`.
`boolean`	`isCustomPageWithFallback(HttpMessage msg, CustomPage.Type cpType)` Determines if a `HttpMessage` is a Custom Page of a particular `CustomPage.Type`.
`boolean`	`isExcluded(SiteNode sn)`
`boolean`	`isExcluded(String url)`
`boolean`	`isExcludedFromScope(SiteNode sn)`
`boolean`	`isIncluded(SiteNode sn)`
`boolean`	`isIncluded(String url)`
`boolean`	`isIncludedInScope(SiteNode sn)`
`boolean`	`isInContext(HistoryReference href)`
`boolean`	`isInContext(SiteNode sn)`
`boolean`	`isInContext(String url)`
`boolean`	`isInScope()`
`void`	`removeAllCustomPages()` Removes all the custom pages.
`boolean`	`removeCustomPage(CustomPage customPage)` Removes a custom page.
`void`	`restructureSiteTree()`
`void`	`save()`
`void`	`setAuthenticationMethod(AuthenticationMethod authenticationMethod)` Sets the authentication method corresponding to this context.
`void`	`setAuthorizationDetectionMethod(AuthorizationDetectionMethod authorizationDetectionMethod)` Sets the authorization detection method corresponding to this context.
`void`	`setCustomPages(List<CustomPage> customPages)` Sets a new list of custom pages for this context.
`void`	`setDataDrivenNodes(List<StructuralNodeModifier> dataDrivenNodes)`
`void`	`setDescription(String description)`
`void`	`setExcludeFromContextRegexs(List<String> excludeRegexs)` Sets the regular expressions used to exclude a URL from the context.
`void`	`setIncludeInContextRegexs(List<String> includeRegexs)` Sets the regular expressions used to include a URL in context.
`void`	`setInScope(boolean inScope)`
`void`	`setName(String name)` Sets the name of the context.
`void`	`setPostParamParser(ParameterParser postParamParser)`
`void`	`setSessionManagementMethod(SessionManagementMethod sessionManagementMethod)` Sets the session management method corresponding to this context.
`void`	`setTechSet(TechSet techSet)`
`void`	`setUrlParamParser(ParameterParser paramParser)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CONTEXT_CONFIG
```
public static final String CONTEXT_CONFIG
```
    See Also:
    
    Constant Field Values
  - CONTEXT_CONFIG_NAME
```
public static final String CONTEXT_CONFIG_NAME
```
    See Also:
    
    Constant Field Values
  - CONTEXT_CONFIG_DESC
```
public static final String CONTEXT_CONFIG_DESC
```
    See Also:
    
    Constant Field Values
  - CONTEXT_CONFIG_INSCOPE
```
public static final String CONTEXT_CONFIG_INSCOPE
```
    See Also:
    
    Constant Field Values
  - CONTEXT_CONFIG_INC_REGEXES
```
public static final String CONTEXT_CONFIG_INC_REGEXES
```
    See Also:
    
    Constant Field Values
  - CONTEXT_CONFIG_EXC_REGEXES
```
public static final String CONTEXT_CONFIG_EXC_REGEXES
```
    See Also:
    
    Constant Field Values
  - CONTEXT_CONFIG_TECH
```
public static final String CONTEXT_CONFIG_TECH
```
    See Also:
    
    Constant Field Values
  - CONTEXT_CONFIG_TECH_INCLUDE
```
public static final String CONTEXT_CONFIG_TECH_INCLUDE
```
    See Also:
    
    Constant Field Values
  - CONTEXT_CONFIG_TECH_EXCLUDE
```
public static final String CONTEXT_CONFIG_TECH_EXCLUDE
```
    See Also:
    
    Constant Field Values
  - CONTEXT_CONFIG_URLPARSER
```
public static final String CONTEXT_CONFIG_URLPARSER
```
    See Also:
    
    Constant Field Values
  - CONTEXT_CONFIG_URLPARSER_CLASS
```
public static final String CONTEXT_CONFIG_URLPARSER_CLASS
```
    See Also:
    
    Constant Field Values
  - CONTEXT_CONFIG_URLPARSER_CONFIG
```
public static final String CONTEXT_CONFIG_URLPARSER_CONFIG
```
    See Also:
    
    Constant Field Values
  - CONTEXT_CONFIG_POSTPARSER
```
public static final String CONTEXT_CONFIG_POSTPARSER
```
    See Also:
    
    Constant Field Values
  - CONTEXT_CONFIG_POSTPARSER_CLASS
```
public static final String CONTEXT_CONFIG_POSTPARSER_CLASS
```
    See Also:
    
    Constant Field Values
  - CONTEXT_CONFIG_POSTPARSER_CONFIG
```
public static final String CONTEXT_CONFIG_POSTPARSER_CONFIG
```
    See Also:
    
    Constant Field Values
  - CONTEXT_CONFIG_DATA_DRIVEN_NODES
```
public static final String CONTEXT_CONFIG_DATA_DRIVEN_NODES
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Context
```
public Context(Session session,
               int id)
```
- Method Detail
  - isIncludedInScope
```
public boolean isIncludedInScope(SiteNode sn)
```
  - isIncluded
```
public boolean isIncluded(SiteNode sn)
```
  - isIncluded
```
public boolean isIncluded(String url)
```
  - isExcludedFromScope
```
public boolean isExcludedFromScope(SiteNode sn)
```
  - isExcluded
```
public boolean isExcluded(SiteNode sn)
```
  - isExcluded
```
public boolean isExcluded(String url)
```
  - isInContext
```
public boolean isInContext(HistoryReference href)
```
  - isInContext
```
public boolean isInContext(SiteNode sn)
```
  - isInContext
```
public boolean isInContext(String url)
```
  - getNodesInContextFromSiteTree
```
public List<SiteNode> getNodesInContextFromSiteTree()
```
    Gets the nodes from the site tree which are "In Scope". Searches recursively starting from the root node. Should be used with care, as it is time-consuming, querying the database for every node in the Site Tree.
    
    Returns:
    
    the nodes in scope from site tree
    
    See Also:
    
    hasNodesInContextFromSiteTree()
  - hasNodesInContextFromSiteTree
```
public boolean hasNodesInContextFromSiteTree()
```
    Tells whether or not there's at least one node from the sites tree in context.
    
    Returns:
    
    true if the context has at least one node from the sites tree in context, false otherwise
    
    Since:
    
    2.5.0
    
    See Also:
    
    getNodesInContextFromSiteTree()
  - getTopNodesInContextFromSiteTree
```
public List<SiteNode> getTopNodesInContextFromSiteTree()
```
    Gets the nodes from the site tree which are "In Scope". Searches recursively starting from the root node. Should be used with care, as it is time-consuming, querying the database for every node in the Site Tree.
    
    Returns:
    
    the nodes in scope from site tree
  - getIncludeInContextRegexs
```
public List<String> getIncludeInContextRegexs()
```
  - setIncludeInContextRegexs
```
public void setIncludeInContextRegexs(List<String> includeRegexs)
```
    Sets the regular expressions used to include a URL in context.
    
    Parameters:
    
    includeRegexs - the regular expressions
    
    Throws:
    
    IllegalArgumentException - if one of the regular expressions is null or empty.
    
    PatternSyntaxException - if one of the regular expressions is invalid.
  - excludeFromContext
```
public void excludeFromContext(SiteNode sn,
                               boolean recurse)
                        throws Exception
```
    Throws:
    
    Exception
  - excludeFromContext
```
public void excludeFromContext(StructuralNode sn,
                               boolean recurse)
                        throws Exception
```
    Throws:
    
    Exception
  - addIncludeInContextRegex
```
public void addIncludeInContextRegex(String includeRegex)
```
  - getExcludeFromContextRegexs
```
public List<String> getExcludeFromContextRegexs()
```
  - setExcludeFromContextRegexs
```
public void setExcludeFromContextRegexs(List<String> excludeRegexs)
```
    Sets the regular expressions used to exclude a URL from the context.
    
    Parameters:
    
    excludeRegexs - the regular expressions
    
    Throws:
    
    IllegalArgumentException - if one of the regular expressions is null.
    
    PatternSyntaxException - if one of the regular expressions is invalid.
  - addExcludeFromContextRegex
```
public void addExcludeFromContextRegex(String excludeRegex)
```
  - save
```
public void save()
```
  - getTechSet
```
public TechSet getTechSet()
```
  - setTechSet
```
public void setTechSet(TechSet techSet)
```
  - getName
```
public String getName()
```
    Gets the name of the context.
    
    Returns:
    
    the name of the context, never null (since 2.6.0).
  - setName
```
public void setName(String name)
```
    Sets the name of the context.
    
    Parameters:
    
    name - the new name of the context
    
    Throws:
    
    IllegalContextNameException - (since 2.6.0) if the given name is null or empty.
  - getDescription
```
public String getDescription()
```
  - setDescription
```
public void setDescription(String description)
```
  - getIndex
```
@Deprecated
public int getIndex()
```
    Deprecated. (2.9.0) Use getId() instead.
    
    Returns the ID of the Context
  - getId
```
public int getId()
```
    Returns the ID of the Context
    
    Since:
    
    2.9.0
  - isInScope
```
public boolean isInScope()
```
  - setInScope
```
public void setInScope(boolean inScope)
```
  - getAuthenticationMethod
```
public AuthenticationMethod getAuthenticationMethod()
```
    Gets the authentication method corresponding to this context.
    
    Returns:
    
    the authentication method
  - setAuthenticationMethod
```
public void setAuthenticationMethod(AuthenticationMethod authenticationMethod)
```
    Sets the authentication method corresponding to this context.
    
    Parameters:
    
    authenticationMethod - the new authentication method
  - getSessionManagementMethod
```
public SessionManagementMethod getSessionManagementMethod()
```
    Gets the session management method corresponding to this context.
    
    Returns:
    
    the session management method
  - setSessionManagementMethod
```
public void setSessionManagementMethod(SessionManagementMethod sessionManagementMethod)
```
    Sets the session management method corresponding to this context.
    
    Parameters:
    
    sessionManagementMethod - the new session management method
  - getAuthorizationDetectionMethod
```
public AuthorizationDetectionMethod getAuthorizationDetectionMethod()
```
    Gets the authorization detection method corresponding to this context.
    
    Returns:
    
    the authorization detection method
  - setAuthorizationDetectionMethod
```
public void setAuthorizationDetectionMethod(AuthorizationDetectionMethod authorizationDetectionMethod)
```
    Sets the authorization detection method corresponding to this context.
    
    Parameters:
    
    authorizationDetectionMethod - the new authorization detectionmethod
  - getUrlParamParser
```
public ParameterParser getUrlParamParser()
```
  - setUrlParamParser
```
public void setUrlParamParser(ParameterParser paramParser)
```
  - getPostParamParser
```
public ParameterParser getPostParamParser()
```
  - setPostParamParser
```
public void setPostParamParser(ParameterParser postParamParser)
```
  - restructureSiteTree
```
public void restructureSiteTree()
```
  - getDataDrivenNodes
```
public List<StructuralNodeModifier> getDataDrivenNodes()
```
  - setDataDrivenNodes
```
public void setDataDrivenNodes(List<StructuralNodeModifier> dataDrivenNodes)
```
  - addDataDrivenNodes
```
public void addDataDrivenNodes(StructuralNodeModifier ddn)
```
  - getDefaultDDNName
```
public String getDefaultDDNName()
```
  - getCustomPages
```
public List<CustomPage> getCustomPages()
```
    Gets an unmodifiable view of the list of custom pages.
    
    Returns:
    
    a List of custom pages
  - hasCustomPages
```
public boolean hasCustomPages()
```
    Returns true if the Context has Custom Pages.
    
    Returns:
    
    true if this context has Custom Pages, false otherwise.
  - hasCustomPageOfType
```
public boolean hasCustomPageOfType(CustomPage.Type cpType)
```
    Returns true if the Context has Custom Page definitions of a specific CustomPage.Type.
    
    Returns:
    
    true if this context has Custom Pages, false otherwise.
  - setCustomPages
```
public void setCustomPages(List<CustomPage> customPages)
```
    Sets a new list of custom pages for this context. An internal copy of the provided list is stored.
    
    Parameters:
    
    customPages - the list of custom pages
  - addCustomPage
```
public void addCustomPage(CustomPage customPage)
```
    Adds a custom page.
    
    Parameters:
    
    customPage - the custom page being added
  - removeCustomPage
```
public boolean removeCustomPage(CustomPage customPage)
```
    Removes a custom page.
    
    Parameters:
    
    customPage - the defaultCustomPage to be removed
  - removeAllCustomPages
```
public void removeAllCustomPages()
```
    Removes all the custom pages.
  - isCustomPage
```
public boolean isCustomPage(HttpMessage msg,
                            CustomPage.Type cpType)
```
    Determines if a HttpMessage is a Custom Page of a particular CustomPage.Type.
    
    Parameters:
    
    msg - the HTTP message to be evaluated
    
    cpType - the CustomPage.Type of the Custom Pages against which the HTTP message should be evaluated
    
    Returns:
    
    true if the HTTP message is a Custom Page of the type in question, false otherwise
    
    Since:
    
    2.10.0
    
    See Also:
    
    isCustomPageWithFallback(HttpMessage, org.zaproxy.zap.extension.custompages.CustomPage.Type)
  - isCustomPageWithFallback
```
public boolean isCustomPageWithFallback(HttpMessage msg,
                                        CustomPage.Type cpType)
```
    Determines if a HttpMessage is a Custom Page of a particular CustomPage.Type. Falling back to check the message's status code.
    
    Parameters:
    
    msg - the HTTP message to be evaluated
    
    cpType - the CustomPage.Type of the Custom Pages against which the HTTP message should be evaluated
    
    Returns:
    
    true if the HTTP message is a Custom Page of the type in question or the response has a relevant status code (500, 404, etc), false otherwise
    
    Since:
    
    2.10.0
    
    See Also:
    
    isCustomPage(HttpMessage, org.zaproxy.zap.extension.custompages.CustomPage.Type)
  - duplicate
```
public Context duplicate()
```
    Creates a copy of the Context. The copy is deep, with the exception of the TechSet.
    
    Returns:
    
    the context
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class Context

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONTEXT_CONFIG

CONTEXT_CONFIG_NAME

CONTEXT_CONFIG_DESC

CONTEXT_CONFIG_INSCOPE

CONTEXT_CONFIG_INC_REGEXES

CONTEXT_CONFIG_EXC_REGEXES

CONTEXT_CONFIG_TECH

CONTEXT_CONFIG_TECH_INCLUDE

CONTEXT_CONFIG_TECH_EXCLUDE

CONTEXT_CONFIG_URLPARSER

CONTEXT_CONFIG_URLPARSER_CLASS

CONTEXT_CONFIG_URLPARSER_CONFIG

CONTEXT_CONFIG_POSTPARSER

CONTEXT_CONFIG_POSTPARSER_CLASS

CONTEXT_CONFIG_POSTPARSER_CONFIG

CONTEXT_CONFIG_DATA_DRIVEN_NODES

Constructor Detail

Context

Method Detail

isIncludedInScope

isIncluded

isIncluded

isExcludedFromScope

isExcluded

isExcluded

isInContext

isInContext

isInContext

getNodesInContextFromSiteTree

hasNodesInContextFromSiteTree

getTopNodesInContextFromSiteTree

getIncludeInContextRegexs

setIncludeInContextRegexs

excludeFromContext

excludeFromContext

addIncludeInContextRegex

getExcludeFromContextRegexs

setExcludeFromContextRegexs

addExcludeFromContextRegex

save

getTechSet

setTechSet

getName

setName

getDescription

setDescription

getIndex

getId

isInScope

setInScope

getAuthenticationMethod

setAuthenticationMethod

getSessionManagementMethod

setSessionManagementMethod

getAuthorizationDetectionMethod

setAuthorizationDetectionMethod

getUrlParamParser

setUrlParamParser

getPostParamParser

setPostParamParser

restructureSiteTree

getDataDrivenNodes

setDataDrivenNodes

addDataDrivenNodes

getDefaultDDNName

getCustomPages

hasCustomPages

hasCustomPageOfType

setCustomPages

addCustomPage

removeCustomPage

removeAllCustomPages

isCustomPage

isCustomPageWithFallback