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(Session session, HistoryReference ref, HttpMessage msg)
static StructuralNode	addPath(Session session, HistoryReference ref, HttpMessage msg, boolean newOnly)
static StructuralNode	find(long sessionId, org.apache.commons.httpclient.URI uri, String method, String postData)
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	getNodeName(HttpMessage msg)
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()
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

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

addPath

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

find

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

Throws:

DatabaseException

org.apache.commons.httpclient.URIException

getNodeName

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

Throws:

org.apache.commons.httpclient.URIException

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

public static StructuralNode getRootNode()