org.zaproxy.zap.model

Class SessionStructure

java.lang.Object

org.zaproxy.zap.model.SessionStructure

public class SessionStructure
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATA_DRIVEN_NODE_POSTFIX
static String	DATA_DRIVEN_NODE_PREFIX
static String	DATA_DRIVEN_NODE_REGEX
static String	ROOT

Constructor Summary

Constructors

Constructor and Description
SessionStructure()

Method Summary

Modifier and Type	Method and Description
static StructuralNode	addPath(Model model, HistoryReference ref, HttpMessage msg) Adds the message to the Sites tree
static StructuralNode	addPath(Model model, HistoryReference ref, HttpMessage msg, boolean newOnly) Adds the message to the Sites tree
static StructuralNode	addPath(Session session, HistoryReference ref, HttpMessage msg) Deprecated.
static StructuralNode	addPath(Session session, HistoryReference ref, HttpMessage msg, boolean newOnly) Deprecated.
static StructuralNode	find(long sessionId, org.apache.commons.httpclient.URI uri, String method, String postData) Deprecated.
static StructuralNode	find(Model model, HttpMessage msg)
static StructuralNode	find(Model model, org.apache.commons.httpclient.URI uri, String method, String postData) Finds the node in the Site tree for the given request data
static String	getCleanRelativeName(StructuralNode sn, boolean incParams) Returns the name of the node ignoring the parent and children, i.e.
static String	getHostName(HttpMessage msg)
static String	getHostName(org.apache.commons.httpclient.URI uri)
static String	getLeafName(Model model, String nodeName, HttpMessage msg)
static String	getLeafName(Model model, String nodeName, org.apache.commons.httpclient.URI uri, String method, String postData) Gets the name of the node to be used for the given parameters in the Site Map.
static String	getLeafName(String nodeName, HttpMessage message, List<NameValuePair> params)
static String	getNodeName(HttpMessage msg) Deprecated.
static String	getNodeName(Model model, HttpMessage msg) Returns the node name for the given message
static String	getRegexName(StructuralNode sn, boolean incParams) Returns a regex pattern that will match the specified StructuralNode, ignoring the parent and children.
static String	getRegexPattern(StructuralNode sn)
static String	getRegexPattern(StructuralNode sn, boolean incChildren)
static StructuralNode	getRootNode() Deprecated.
static StructuralNode	getRootNode(Model model) Returns the root node
static List<String>	getTreePath(Model model, HttpMessage msg)
static List<String>	getTreePath(Model model, org.apache.commons.httpclient.URI uri)
static String	regexEscape(String str)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ROOT

public static final String ROOT

See Also:

Constant Field Values

DATA_DRIVEN_NODE_PREFIX

public static final String DATA_DRIVEN_NODE_PREFIX

See Also:

Constant Field Values

DATA_DRIVEN_NODE_POSTFIX

public static final String DATA_DRIVEN_NODE_POSTFIX

See Also:

Constant Field Values

DATA_DRIVEN_NODE_REGEX

public static final String DATA_DRIVEN_NODE_REGEX

See Also:

Constant Field Values

Constructor Detail

SessionStructure

public SessionStructure()

Method Detail

addPath

@Deprecated
public static StructuralNode addPath(Session session,
                                                 HistoryReference ref,
                                                 HttpMessage msg)

Deprecated.

Adds the message to the Sites tree

Parameters:

session - the session

ref - the history reference

msg - the message

Returns:

the node added to the Sites Tree

addPath

public static StructuralNode addPath(Model model,
                                     HistoryReference ref,
                                     HttpMessage msg)

Adds the message to the Sites tree

Parameters:

model - the model

ref - the history reference

msg - the message

Returns:

the node added to the Sites Tree

Since:

2.10.0

addPath

@Deprecated
public static StructuralNode addPath(Session session,
                                                 HistoryReference ref,
                                                 HttpMessage msg,
                                                 boolean newOnly)

Deprecated.

Adds the message to the Sites tree

Parameters:

session - the session

ref - the history reference

msg - the message

newOnly - Only return a SiteNode if one was newly created

Returns:

the SiteNode that corresponds to the HttpMessage, or null if newOnly and the node already exists

addPath

public static StructuralNode addPath(Model model,
                                     HistoryReference ref,
                                     HttpMessage msg,
                                     boolean newOnly)

Adds the message to the Sites tree

Parameters:

model - the model

ref - the history reference

msg - the message

newOnly - Only return a SiteNode if one was newly created

Returns:

the SiteNode that corresponds to the HttpMessage, or null if newOnly and the node already exists

Since:

2.10.0

getTreePath

public static List<String> getTreePath(Model model,
                                       org.apache.commons.httpclient.URI uri)
                                throws org.apache.commons.httpclient.URIException

Throws:

org.apache.commons.httpclient.URIException

getTreePath

public static List<String> getTreePath(Model model,
                                       HttpMessage msg)
                                throws org.apache.commons.httpclient.URIException

Throws:

org.apache.commons.httpclient.URIException

find

public static StructuralNode find(Model model,
                                  HttpMessage msg)
                           throws DatabaseException,
                                  org.apache.commons.httpclient.URIException

Parameters:

model -

msg -

Returns:

The structural node for the given message

Throws:

DatabaseException

org.apache.commons.httpclient.URIException

Since:

2.10.0

find

@Deprecated
public static StructuralNode find(long sessionId,
                                              org.apache.commons.httpclient.URI uri,
                                              String method,
                                              String postData)
                                       throws DatabaseException,
                                              org.apache.commons.httpclient.URIException

Deprecated.

Finds the node in the Site tree for the given request data

Parameters:

sessionId - the session id

uri - the URI

method - the method

postData - the POST data

Returns:

the site node or null if not found

Throws:

DatabaseException

org.apache.commons.httpclient.URIException

find

public static StructuralNode find(Model model,
                                  org.apache.commons.httpclient.URI uri,
                                  String method,
                                  String postData)
                           throws DatabaseException,
                                  org.apache.commons.httpclient.URIException

Finds the node in the Site tree for the given request data

Parameters:

model - the model

uri - the URI

method - the method

postData - the POST data

Returns:

the site node or null if not found

Throws:

DatabaseException

org.apache.commons.httpclient.URIException

Since:

2.10.0

getNodeName

@Deprecated
public static String getNodeName(HttpMessage msg)
                                      throws org.apache.commons.httpclient.URIException

Deprecated.

Returns the node name for the given message

Parameters:

msg - the message

Returns:

the node name

Throws:

org.apache.commons.httpclient.URIException

getNodeName

public static String getNodeName(Model model,
                                 HttpMessage msg)
                          throws org.apache.commons.httpclient.URIException

Returns the node name for the given message

Parameters:

model - the model

msg - the message

Returns:

the node name

Throws:

org.apache.commons.httpclient.URIException

Since:

2.10.0

getLeafName

public static String getLeafName(Model model,
                                 String nodeName,
                                 HttpMessage msg)

getLeafName

public static String getLeafName(Model model,
                                 String nodeName,
                                 org.apache.commons.httpclient.URI uri,
                                 String method,
                                 String postData)
                          throws HttpMalformedHeaderException

Gets the name of the node to be used for the given parameters in the Site Map.

Parameters:

model - the model

nodeName - the last element of the path

uri - the full uri of the node, must not be null.

method - the method for the node, must not be null.

postData - the data of the request body.

Returns:

the name of the node to be used in the Site Map

Throws:

HttpMalformedHeaderException - if the uri is not correct.

NullPointerException - if the uri or the method are null.

Since:

2.10.0

getLeafName

public static String getLeafName(String nodeName,
                                 HttpMessage message,
                                 List<NameValuePair> params)

regexEscape

public static String regexEscape(String str)

getRegexName

public static String getRegexName(StructuralNode sn,
                                  boolean incParams)

Returns a regex pattern that will match the specified StructuralNode, ignoring the parent and children. For most nodes this will just be the last element in the path, e.g. URL regex name https://www.example.com/aaa/bbb bbb https://www.example.com/aaa aaa https://www.example.com/ https://www.example.com Datadriven nodes are different, they will always return (.+?) to match anything.

Parameters:

sn - a StructuralNode

incParams - if true then include URL params in the regex, otherwise exclude them

Returns:

a regex pattern that will match the specified StructuralNode, ignoring the parent and children.

getCleanRelativeName

public static String getCleanRelativeName(StructuralNode sn,
                                          boolean incParams)

Returns the name of the node ignoring the parent and children, i.e. the last element in the path. Data driven nodes will return the user specified name surrounded by the double angled brackets.

Parameters:

sn - a StructuralNode

incParams - if true then include URL params in the regex, otherwise exclude them

Returns:

the name of the node ignoring the parent and children

getRegexPattern

public static String getRegexPattern(StructuralNode sn)
                              throws DatabaseException

Throws:

DatabaseException

getRegexPattern

public static String getRegexPattern(StructuralNode sn,
                                     boolean incChildren)
                              throws DatabaseException

Throws:

DatabaseException

getHostName

public static String getHostName(HttpMessage msg)
                          throws org.apache.commons.httpclient.URIException

Throws:

org.apache.commons.httpclient.URIException

getHostName

public static String getHostName(org.apache.commons.httpclient.URI uri)
                          throws org.apache.commons.httpclient.URIException

Throws:

org.apache.commons.httpclient.URIException

getRootNode

@Deprecated
public static StructuralNode getRootNode()

Deprecated.

Returns the root node

Returns:

the root node

getRootNode

public static StructuralNode getRootNode(Model model)

Returns the root node

Parameters:

model - the model

Returns:

the root node