org.zaproxy.zap.extension.httpsessions

Class HttpSessionsSite

java.lang.Object

org.zaproxy.zap.extension.httpsessions.HttpSessionsSite

public class HttpSessionsSite
extends Object

The Class SiteHttpSessions stores all the information regarding the sessions for a particular Site.

Constructor Summary

Constructors

Constructor and Description
HttpSessionsSite(ExtensionHttpSessions extension, String site) Instantiates a new site http sessions object.

Method Summary

Modifier and Type	Method and Description
void	addHttpSession(HttpSession session) Adds a new http session to this site.
protected void	cleanupSessionToken(String token) Cleans up the sessions, eliminating the given session token.
void	createEmptySession() Creates a new empty session.
void	createEmptySession(String name) Creates an empty session with the given name.
HttpSession	getActiveSession() Gets the active session.
HttpSession	getHttpSession(String name) Gets the http session with a particular name, if any, or null otherwise.
Set<HttpSession>	getHttpSessions() Gets an unmodifiable set of the http sessions.
HttpSessionsTableModel	getModel() Gets the model.
static int	getNextSessionId()
String	getSite() Gets the site.
void	processHttpRequestMessage(HttpMessage message) Process the http request message before being sent.
void	processHttpResponseMessage(HttpMessage message) Process the http response message received after a request.
void	removeHttpSession(HttpSession session) Removes an existing session.
boolean	renameHttpSession(String oldName, String newName) Renames a http session, making sure the new name is unique for the site.
void	setActiveSession(HttpSession activeSession) Sets the active session.
void	setSite(String site) Sets the site.
String	toString()
void	unsetActiveSession() Unset any active session for this site.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpSessionsSite

public HttpSessionsSite(ExtensionHttpSessions extension,
                        String site)

Instantiates a new site http sessions object.

Parameters:

extension - the extension

site - the site

Method Detail

addHttpSession

public void addHttpSession(HttpSession session)

Adds a new http session to this site.

Parameters:

session - the session

removeHttpSession

public void removeHttpSession(HttpSession session)

Removes an existing session.

Parameters:

session - the session

getSite

public String getSite()

Gets the site.

Returns:

the site

setSite

public void setSite(String site)

Sets the site.

Parameters:

site - the new site

getActiveSession

public HttpSession getActiveSession()

Gets the active session.

Returns:

the active session or null, if no session is set as active

See Also:

setActiveSession(HttpSession)

setActiveSession

public void setActiveSession(HttpSession activeSession)

Sets the active session.

Parameters:

activeSession - the new active session.

Throws:

IllegalArgumentException - If the session provided as parameter is null.

See Also:

getActiveSession(), unsetActiveSession()

unsetActiveSession

public void unsetActiveSession()

Unset any active session for this site.

See Also:

setActiveSession(HttpSession)

createEmptySession

public void createEmptySession(String name)

Creates an empty session with the given name.

The newly created session is set as the active session.

Note: If a session with the given name already exists no action is taken.

Parameters:

name - the name of the session

Throws:

IllegalArgumentException - if the name is null or an empty string

See Also:

setActiveSession(HttpSession)

createEmptySession

public void createEmptySession()

Creates a new empty session.

The newly created session is set as the active session.

See Also:

setActiveSession(HttpSession)

getModel

public HttpSessionsTableModel getModel()

Gets the model.

Returns:

the model

processHttpRequestMessage

public void processHttpRequestMessage(HttpMessage message)

Process the http request message before being sent.

Parameters:

message - the message

processHttpResponseMessage

public void processHttpResponseMessage(HttpMessage message)

Process the http response message received after a request.

Parameters:

message - the message

toString

public String toString()

Overrides:

toString in class Object

cleanupSessionToken

protected void cleanupSessionToken(String token)

Cleans up the sessions, eliminating the given session token.

Parameters:

token - the session token

getHttpSessions

public Set<HttpSession> getHttpSessions()

Gets an unmodifiable set of the http sessions. Attempts to modify the returned set, whether direct or via its iterator, result in an UnsupportedOperationException.

Returns:

the http sessions

getHttpSession

public HttpSession getHttpSession(String name)

Gets the http session with a particular name, if any, or null otherwise.

Parameters:

name - the name

Returns:

the http session with a given name, or null, if no such session exists

renameHttpSession

public boolean renameHttpSession(String oldName,
                                 String newName)

Renames a http session, making sure the new name is unique for the site.

Parameters:

oldName - the old name

newName - the new name

Returns:

true, if successful

getNextSessionId

public static int getNextSessionId()