Session (OWASP Zed Attack Proxy)

java.lang.Object
- org.parosproxy.paros.model.Session

```
public class Session
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Session.OnContextsChangedListener
Listener notified whenever the registered list of contexts changes.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Session.OnContextsChangedListener` Listener notified whenever the registered list of contexts changes.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Session(Model model)
Constructor for the current session.

Constructors
Modifier	Constructor and Description
`protected`	`Session(Model model)` Constructor for the current session.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addContext(Context c)` Adds the given context.
`void`	`addExcludeFromProxyRegex(String ignoredRegex)`
`void`	`addExcludeFromScanRegexs(String ignoredRegex)`
`void`	`addExcludeFromSpiderRegex(String ignoredRegex)` Adds the given regular expression to the list of regular expressions used to exclude URLs from the spiders (e.g.
`void`	`addGlobalExcludeURLRegexs(String regex)` Deprecated. (2.6.0) No longer works, modification of global exclude URLs should not be done through the session.
`void`	`addOnContextsChangedListener(Session.OnContextsChangedListener l)`
`void`	`clearContextData(int contextId)`
`void`	`clearContextDataForType(int contextId, int type)`
`protected void`	`close()`
`void`	`deleteContext(Context c)`
`protected void`	`discard()`
`void`	`exportContext(Context c, File file)` Export the specified context to a file
`void`	`exportContext(int contextIndex, File file)` Export the specified context to a file
`void`	`forceGlobalExcludeURLRefresh()` Resets the global exclude URLs of the Local Proxy.
`Context`	`getContext(int index)`
`Context`	`getContext(String name)`
`List<String>`	`getContextDataStrings(int contextId, int type)`
`List<Context>`	`getContexts()`
`List<Context>`	`getContextsForNode(SiteNode sn)`
`List<Context>`	`getContextsForUrl(String url)`
`List<String>`	`getExcludeFromProxyRegexs()`
`List<String>`	`getExcludeFromScanRegexs()`
`List<String>`	`getExcludeFromSpiderRegexs()` Gets the regular expressions used to exclude URLs from the spiders (e.g.
`String`	`getFileName()`
`ParameterParser`	`getFormParamParser(String url)` Returns the form parameter parser associated with the first context found that includes the URL, or the default parser if it is not in a context
`Map<String,String>`	`getFormParams(org.apache.commons.httpclient.URI uri, String formData)` Returns the FORM parameters for the given URL based on the parser associated with the first context found that includes the URL, or the default parser if it is not in a context
`List<String>`	`getGlobalExcludeURLRegexs()` Gets the global exclude URLs.
`Context`	`getNewContext(String name)` Gets a newly created context with the given name.
`List<SiteNode>`	`getNodesInContextFromSiteTree(Context context)` Gets the nodes from the site tree which are "In Scope" in a given context.
`List<SiteNode>`	`getNodesInScopeFromSiteTree()` Gets the nodes from the site tree which are "In Scope".
`List<NameValuePair>`	`getParameters(HttpMessage msg, HtmlParameter.Type type)` Gets the parameters of the given `type` from the given `message`.
`Map<String,String>`	`getParams(HttpMessage msg, HtmlParameter.Type type)` Returns the specified parameters for the given message based on the parser associated with the first context found that includes the URL for the message, or the default parser if it is not in a context
`String`	`getSessionDesc()`
`String`	`getSessionFolder()`
`long`	`getSessionId()`
`String`	`getSessionName()`
`List<String>`	`getSessionUrls(int type)`
`SiteMap`	`getSiteTree()`
`List<SiteNode>`	`getTopNodesInScopeFromSiteTree()` Gets the top nodes from the site tree which contain nodes that are "In Scope".
`List<String>`	`getTreePath(HttpMessage msg)`
`List<String>`	`getTreePath(org.apache.commons.httpclient.URI uri)`
`ParameterParser`	`getUrlParamParser(String url)` Returns the url parameter parser associated with the first context found that includes the URL, or the default parser if it is not in a context
`Map<String,String>`	`getUrlParams(org.apache.commons.httpclient.URI uri)` Returns the URL parameters for the given URL based on the parser associated with the first context found that includes the URL, or the default parser if it is not in a context
`Context`	`importContext(File file)` Imports a context from the specified (XML) file.
`protected boolean`	`isExcludedFromScope(SiteNode sn)`
`protected boolean`	`isIncludedInScope(SiteNode sn)`
`boolean`	`isInScope(HistoryReference href)`
`boolean`	`isInScope(SiteNode sn)`
`boolean`	`isInScope(String url)`
`boolean`	`isNewState()` Tells whether this session is in a new state or not.
`protected void`	`open(File file, SessionListener callback)`
`protected void`	`open(String fileName)`
`protected void`	`open(String sessionFile, SessionListener callback)`
`protected void`	`persistProperties()` Persists the properties (e.g.
`void`	`removeOnContextsChangedListener(Session.OnContextsChangedListener l)`
`protected void`	`save(String fileName)` Synchronous call to save a session.
`protected void`	`save(String fileName, SessionListener callback)` Asynchronous call to save a session.
`void`	`saveAllContexts()`
`void`	`saveContext(Context c)`
`void`	`setContextData(int contextId, int type, List<String> dataList)`
`void`	`setContextData(int contextId, int type, String data)`
`void`	`setExcludeFromProxyRegexs(List<String> ignoredRegexs)`
`void`	`setExcludeFromScanRegexs(List<String> ignoredRegexs)`
`void`	`setExcludeFromSpiderRegexs(List<String> ignoredRegexs)` Sets the given regular expressions as the list of regular expressions used to exclude URLs from the spiders (e.g.
`void`	`setGlobalExcludeURLRegexs(List<String> ignoredRegexs)` Deprecated. (2.6.0) No longer works, when needed, the global exclude URLs are obtained from the options.
`void`	`setSessionDesc(String sessionDesc)`
`void`	`setSessionId(long sessionId)`
`void`	`setSessionName(String name)`
`void`	`setSessionUrl(int type, String url)`
`void`	`setSessionUrls(int type, List<String> urls)`
`protected void`	`snapshot(String fileName)` Synchronous call to snapshot a session.
`protected void`	`snapshot(String fileName, SessionListener callback)` Asynchronous call to snapshot a session.

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

- Constructor Detail
  - Session
```
protected Session(Model model)
```
    Constructor for the current session. The current system time will be used as the session ID.
    
    Parameters:
    
    model -
- Method Detail
  - discard
```
protected void discard()
```
  - close
```
protected void close()
```
  - getSessionDesc
```
public String getSessionDesc()
```
    Returns:
    
    Returns the sessionDesc.
  - getSessionId
```
public long getSessionId()
```
    Returns:
    
    Returns the sessionId.
  - getSessionName
```
public String getSessionName()
```
    Returns:
    
    Returns the name.
  - getSiteTree
```
public SiteMap getSiteTree()
```
    Returns:
    
    Returns the siteTree.
  - isNewState
```
public boolean isNewState()
```
    Tells whether this session is in a new state or not. A session is in a new state if it was never saved or it was not loaded from an existing session.
    
    Returns:
    
    true if this session is in a new state, false otherwise.
  - open
```
protected void open(File file,
                    SessionListener callback)
```
  - open
```
protected void open(String sessionFile,
                    SessionListener callback)
```
  - open
```
protected void open(String fileName)
             throws DatabaseException,
                    IOException,
                    Exception
```
    Throws:
    
    DatabaseException
    
    IOException
    
    Exception
  - save
```
protected void save(String fileName,
                    SessionListener callback)
```
    Asynchronous call to save a session.
    
    Parameters:
    
    fileName -
    
    callback -
  - save
```
protected void save(String fileName)
             throws Exception
```
    Synchronous call to save a session.
    
    Parameters:
    
    fileName -
    
    Throws:
    
    Exception
  - persistProperties
```
protected void persistProperties()
                          throws Exception
```
    Persists the properties (e.g. name, description) of the session.
    Should be called only by "core" classes.
    
    Throws:
    
    Exception - if an error occurred while persisting the properties.
    
    Since:
    
    2.7.0
    
    See Also:
    
    setSessionName(String), setSessionDesc(String)
  - snapshot
```
protected void snapshot(String fileName,
                        SessionListener callback)
```
    Asynchronous call to snapshot a session.
    
    Parameters:
    
    fileName -
    
    callback -
  - snapshot
```
protected void snapshot(String fileName)
                 throws Exception
```
    Synchronous call to snapshot a session.
    
    Parameters:
    
    fileName -
    
    Throws:
    
    Exception
  - setSessionDesc
```
public void setSessionDesc(String sessionDesc)
```
    Parameters:
    
    sessionDesc - The sessionDesc to set.
  - setSessionId
```
public void setSessionId(long sessionId)
```
    Parameters:
    
    sessionId - The sessionId to set.
  - setSessionName
```
public void setSessionName(String name)
```
    Parameters:
    
    name - The name to set.
  - getFileName
```
public String getFileName()
```
  - getSessionFolder
```
public String getSessionFolder()
```
  - getExcludeFromProxyRegexs
```
public List<String> getExcludeFromProxyRegexs()
```
  - isIncludedInScope
```
protected boolean isIncludedInScope(SiteNode sn)
```
  - isExcludedFromScope
```
protected boolean isExcludedFromScope(SiteNode sn)
```
  - isInScope
```
public boolean isInScope(HistoryReference href)
```
  - isInScope
```
public boolean isInScope(SiteNode sn)
```
  - isInScope
```
public boolean isInScope(String url)
```
  - getNodesInScopeFromSiteTree
```
public List<SiteNode> getNodesInScopeFromSiteTree()
```
    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
  - getTopNodesInScopeFromSiteTree
```
public List<SiteNode> getTopNodesInScopeFromSiteTree()
```
    Gets the top nodes from the site tree which contain nodes that 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
  - getNodesInContextFromSiteTree
```
public List<SiteNode> getNodesInContextFromSiteTree(Context context)
```
    Gets the nodes from the site tree which are "In Scope" in a given context. 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.
    
    Parameters:
    
    context - the context
    
    Returns:
    
    the nodes in scope from site tree
  - setExcludeFromProxyRegexs
```
public void setExcludeFromProxyRegexs(List<String> ignoredRegexs)
                               throws DatabaseException
```
    Throws:
    
    DatabaseException
  - addExcludeFromProxyRegex
```
public void addExcludeFromProxyRegex(String ignoredRegex)
                              throws DatabaseException
```
    Throws:
    
    DatabaseException
  - getExcludeFromScanRegexs
```
public List<String> getExcludeFromScanRegexs()
```
  - addExcludeFromScanRegexs
```
public void addExcludeFromScanRegexs(String ignoredRegex)
                              throws DatabaseException
```
    Throws:
    
    DatabaseException
  - setExcludeFromScanRegexs
```
public void setExcludeFromScanRegexs(List<String> ignoredRegexs)
                              throws DatabaseException
```
    Throws:
    
    DatabaseException
  - getExcludeFromSpiderRegexs
```
public List<String> getExcludeFromSpiderRegexs()
```
    Gets the regular expressions used to exclude URLs from the spiders (e.g. traditional, AJAX).
    
    Returns:
    
    a List containing the regular expressions, never null.
  - addExcludeFromSpiderRegex
```
public void addExcludeFromSpiderRegex(String ignoredRegex)
                               throws DatabaseException
```
    Adds the given regular expression to the list of regular expressions used to exclude URLs from the spiders (e.g. traditional, AJAX).
    
    Parameters:
    
    ignoredRegex - the regular expression to be added
    
    Throws:
    
    IllegalArgumentException - if the regular expression is not valid.
    
    DatabaseException - if an error occurred while persisting the list.
  - setExcludeFromSpiderRegexs
```
public void setExcludeFromSpiderRegexs(List<String> ignoredRegexs)
                                throws DatabaseException
```
    Sets the given regular expressions as the list of regular expressions used to exclude URLs from the spiders (e.g. traditional, AJAX).
    
    Parameters:
    
    ignoredRegexs - the regular expressions to be set
    
    Throws:
    
    IllegalArgumentException - if any of the regular expressions is not valid.
    
    DatabaseException - if an error occurred while persisting the list.
  - forceGlobalExcludeURLRefresh
```
public void forceGlobalExcludeURLRefresh()
```
    Resets the global exclude URLs of the Local Proxy.
    This should be considered an internal method, to be called only by core code.
    
    Since:
    
    2.3.0
  - getGlobalExcludeURLRegexs
```
public List<String> getGlobalExcludeURLRegexs()
```
    Gets the global exclude URLs.
    Note: This method is only provided as a convenience, the global exclude URLs are not saved in the session.
    
    Returns:
    
    an unmodifiable List containing the URLs that should be excluded globally.
    
    Since:
    
    2.3.0
  - addGlobalExcludeURLRegexs
```
@Deprecated
public void addGlobalExcludeURLRegexs(String regex)
```
    Deprecated. (2.6.0) No longer works, modification of global exclude URLs should not be done through the session.
    
    Adds the given regular expression to the list of global exclude URLs.
    Note: The changes are lost after changing the session.
    
    Parameters:
    
    regex - the regular expression to add.
    
    Since:
    
    2.3.0
  - setGlobalExcludeURLRegexs
```
@Deprecated
public void setGlobalExcludeURLRegexs(List<String> ignoredRegexs)
```
    Deprecated. (2.6.0) No longer works, when needed, the global exclude URLs are obtained from the options.
    
    Sets the global exclude URLs.
    Note: The changes are lost after changing the session.
    
    Parameters:
    
    ignoredRegexs - the global exclude URLs
    
    Since:
    
    2.3.0
  - setSessionUrls
```
public void setSessionUrls(int type,
                           List<String> urls)
                    throws DatabaseException
```
    Throws:
    
    DatabaseException
  - setSessionUrl
```
public void setSessionUrl(int type,
                          String url)
                   throws DatabaseException
```
    Throws:
    
    DatabaseException
  - getSessionUrls
```
public List<String> getSessionUrls(int type)
                            throws DatabaseException
```
    Throws:
    
    DatabaseException
  - getContextDataStrings
```
public List<String> getContextDataStrings(int contextId,
                                          int type)
                                   throws DatabaseException
```
    Throws:
    
    DatabaseException
  - setContextData
```
public void setContextData(int contextId,
                           int type,
                           String data)
                    throws DatabaseException
```
    Throws:
    
    DatabaseException
  - setContextData
```
public void setContextData(int contextId,
                           int type,
                           List<String> dataList)
                    throws DatabaseException
```
    Throws:
    
    DatabaseException
  - clearContextDataForType
```
public void clearContextDataForType(int contextId,
                                    int type)
                             throws DatabaseException
```
    Throws:
    
    DatabaseException
  - clearContextData
```
public void clearContextData(int contextId)
                      throws DatabaseException
```
    Throws:
    
    DatabaseException
  - saveContext
```
public void saveContext(Context c)
```
  - saveAllContexts
```
public void saveAllContexts()
```
  - getNewContext
```
public Context getNewContext(String name)
```
    Gets a newly created context with the given name.
    The context is automatically added to the session.
    
    Parameters:
    
    name - the name of the context
    
    Returns:
    
    the new Context.
    
    Throws:
    
    IllegalContextNameException - (since 2.6.0) if the given name is null or empty or if a context with the given name already exists.
  - addContext
```
public void addContext(Context c)
```
    Adds the given context.
    
    Parameters:
    
    c - the context to be added
    
    Throws:
    
    IllegalArgumentException - (since 2.6.0) if the given context is null.
    
    IllegalContextNameException - (since 2.6.0) if context's name is null or empty or if a context with the same name already exists.
  - deleteContext
```
public void deleteContext(Context c)
```
  - getContext
```
public Context getContext(int index)
```
  - getContext
```
public Context getContext(String name)
```
  - getContexts
```
public List<Context> getContexts()
```
  - getContextsForNode
```
public List<Context> getContextsForNode(SiteNode sn)
```
  - getContextsForUrl
```
public List<Context> getContextsForUrl(String url)
```
  - exportContext
```
public void exportContext(int contextIndex,
                          File file)
                   throws org.apache.commons.configuration.ConfigurationException
```
    Export the specified context to a file
    
    Parameters:
    
    contextIndex -
    
    file -
    
    Throws:
    
    org.apache.commons.configuration.ConfigurationException
  - exportContext
```
public void exportContext(Context c,
                          File file)
                   throws org.apache.commons.configuration.ConfigurationException
```
    Export the specified context to a file
    
    Parameters:
    
    c -
    
    file -
    
    Throws:
    
    org.apache.commons.configuration.ConfigurationException
  - importContext
```
public Context importContext(File file)
                      throws org.apache.commons.configuration.ConfigurationException,
                             ClassNotFoundException,
                             InstantiationException,
                             IllegalAccessException,
                             IllegalArgumentException,
                             InvocationTargetException,
                             NoSuchMethodException,
                             SecurityException
```
    Imports a context from the specified (XML) file.
    
    Parameters:
    
    file - the (XML) file that contains the context data
    
    Returns:
    
    the imported Context, already added to the session.
    
    Throws:
    
    org.apache.commons.configuration.ConfigurationException
    
    ClassNotFoundException
    
    InstantiationException
    
    IllegalAccessException
    
    IllegalArgumentException
    
    InvocationTargetException
    
    NoSuchMethodException
    
    SecurityException
    
    IllegalContextNameException - (since 2.6.0) if context's name is not provided or it's empty or if a context with the same name already exists.
  - getUrlParamParser
```
public ParameterParser getUrlParamParser(String url)
```
    Returns the url parameter parser associated with the first context found that includes the URL, or the default parser if it is not in a context
    
    Parameters:
    
    url -
    
    Returns:
  - getFormParamParser
```
public ParameterParser getFormParamParser(String url)
```
    Returns the form parameter parser associated with the first context found that includes the URL, or the default parser if it is not in a context
    
    Parameters:
    
    url -
    
    Returns:
  - getParams
```
public Map<String,String> getParams(HttpMessage msg,
                                    HtmlParameter.Type type)
```
    Returns the specified parameters for the given message based on the parser associated with the first context found that includes the URL for the message, or the default parser if it is not in a context
    
    Parameters:
    
    msg -
    
    type -
    
    Returns:
  - getParameters
```
public List<NameValuePair> getParameters(HttpMessage msg,
                                         HtmlParameter.Type type)
```
    Gets the parameters of the given type from the given message.
    Parameters' names and values are in decoded form.
    
    Parameters:
    
    msg - the message whose parameters will be extracted from
    
    type - the type of parameters to extract
    
    Returns:
    
    a List containing the parameters
    
    Throws:
    
    IllegalArgumentException - if any of the parameters is null or if the given type is not url or form.
    
    Since:
    
    2.5.0
    
    See Also:
    
    StandardParameterParser.getParameters(HttpMessage, org.parosproxy.paros.network.HtmlParameter.Type)
  - getUrlParams
```
public Map<String,String> getUrlParams(org.apache.commons.httpclient.URI uri)
                                throws org.apache.commons.httpclient.URIException
```
    Returns the URL parameters for the given URL based on the parser associated with the first context found that includes the URL, or the default parser if it is not in a context
    
    Parameters:
    
    uri -
    
    Returns:
    
    Throws:
    
    org.apache.commons.httpclient.URIException
  - getFormParams
```
public Map<String,String> getFormParams(org.apache.commons.httpclient.URI uri,
                                        String formData)
                                 throws org.apache.commons.httpclient.URIException
```
    Returns the FORM parameters for the given URL based on the parser associated with the first context found that includes the URL, or the default parser if it is not in a context
    
    Parameters:
    
    uri -
    
    formData -
    
    Returns:
    
    Throws:
    
    org.apache.commons.httpclient.URIException
  - getTreePath
```
public List<String> getTreePath(org.apache.commons.httpclient.URI uri)
                         throws org.apache.commons.httpclient.URIException
```
    Throws:
    
    org.apache.commons.httpclient.URIException
  - getTreePath
```
public List<String> getTreePath(HttpMessage msg)
                         throws org.apache.commons.httpclient.URIException
```
    Throws:
    
    org.apache.commons.httpclient.URIException
  - addOnContextsChangedListener
```
public void addOnContextsChangedListener(Session.OnContextsChangedListener l)
```
  - removeOnContextsChangedListener
```
public void removeOnContextsChangedListener(Session.OnContextsChangedListener l)
```

Class Session

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Session

Method Detail

discard

close

getSessionDesc

getSessionId

getSessionName

getSiteTree

isNewState

open

open

open

save

save

persistProperties

snapshot

snapshot

setSessionDesc

setSessionId

setSessionName

getFileName

getSessionFolder

getExcludeFromProxyRegexs

isIncludedInScope

isExcludedFromScope

isInScope

isInScope

isInScope

getNodesInScopeFromSiteTree

getTopNodesInScopeFromSiteTree

getNodesInContextFromSiteTree

setExcludeFromProxyRegexs

addExcludeFromProxyRegex

getExcludeFromScanRegexs

addExcludeFromScanRegexs

setExcludeFromScanRegexs

getExcludeFromSpiderRegexs

addExcludeFromSpiderRegex

setExcludeFromSpiderRegexs

forceGlobalExcludeURLRefresh

getGlobalExcludeURLRegexs

addGlobalExcludeURLRegexs

setGlobalExcludeURLRegexs

setSessionUrls

setSessionUrl

getSessionUrls

getContextDataStrings

setContextData

setContextData

clearContextDataForType

clearContextData

saveContext

saveAllContexts

getNewContext

addContext

deleteContext

getContext

getContext

getContexts

getContextsForNode

getContextsForUrl

exportContext

exportContext

importContext

getUrlParamParser

getFormParamParser

getParams

getParameters

getUrlParams

getFormParams

getTreePath

getTreePath

addOnContextsChangedListener

removeOnContextsChangedListener