org.zaproxy.zap.session

Interface SessionManagementMethod

All Known Implementing Classes:

CookieBasedSessionManagementMethodType.CookieBasedSessionManagementMethod, HttpAuthSessionManagementMethodType.HttpAuthSessionManagementMethod, ScriptBasedSessionManagementMethodType.ScriptBasedSessionManagementMethod

public interface SessionManagementMethod

The SessionManagementMethod represents a session management method that can be used to manage an existing Web Session corresponding to an entity (user) interacting with a particular WebApplication.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SessionManagementMethod.UnsupportedWebSessionException Thrown when an unsupported type of web session is used with a SessionManagementMethod .

Method Summary

Modifier and Type	Method and Description
void	clearWebSessionIdentifiers(HttpMessage msg) Clears any tokens or elements that can link the HttpMessage provided as a parameter to a WebSession.
SessionManagementMethod	clone() Clones the current session management method, creating a deep-copy of it.
WebSession	createEmptyWebSession() Creates an empty web session.
WebSession	extractWebSession(HttpMessage msg) Extracts the web session information from a Http Message, creating a WebSession object corresponding to the Session Management Method.
ApiResponse	getApiResponseRepresentation() Gets an api response that represents the Session Management Method.
SessionManagementMethodType	getType() Gets the SessionManagementMethodType corresponding to this session management method.
boolean	isConfigured() Checks if the session management method is fully configured.
void	processMessageToMatchSession(HttpMessage message, WebSession session) Modifies a message so its Request Header/Body matches the given web session, according to this session management method.

Method Detail

isConfigured

boolean isConfigured()

Checks if the session management method is fully configured.

Returns:

true, if is configured

getType

SessionManagementMethodType getType()

Gets the SessionManagementMethodType corresponding to this session management method.

Implementations may return new instantiations at every call, so performance considerations should be taken by users.

Returns:

the type

clone

SessionManagementMethod clone()

Clones the current session management method, creating a deep-copy of it.

Returns:

a deep copy of the session management method

extractWebSession

WebSession extractWebSession(HttpMessage msg)

Extracts the web session information from a Http Message, creating a WebSession object corresponding to the Session Management Method.

Parameters:

msg - the msg

Returns:

the web session

createEmptyWebSession

WebSession createEmptyWebSession()

Creates an empty web session.

Returns:

the web session

clearWebSessionIdentifiers

void clearWebSessionIdentifiers(HttpMessage msg)

Clears any tokens or elements that can link the HttpMessage provided as a parameter to a WebSession.

Parameters:

msg - the http message

getApiResponseRepresentation

ApiResponse getApiResponseRepresentation()

Gets an api response that represents the Session Management Method.

Returns:

the api response representation

processMessageToMatchSession

void processMessageToMatchSession(HttpMessage message,
                                  WebSession session)
                           throws SessionManagementMethod.UnsupportedWebSessionException

Modifies a message so its Request Header/Body matches the given web session, according to this session management method.

Parameters:

message - the message

session - the session

Throws:

SessionManagementMethod.UnsupportedWebSessionException - if the web session type is unsupported