org.zaproxy.zap.extension.httpsessions

Class HttpSession

java.lang.Object

org.zaproxy.zap.extension.httpsessions.HttpSession

public class HttpSession
extends Object

The Class HttpSession defines the data that is stored regarding an existing HTTP session on a particular site.

The session can be invalidated and should only be used while it is valid.

Constructor Summary

Constructors

Constructor and Description
HttpSession(String name, HttpSessionTokensSet tokenNames) Instantiates a new http session.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getMessagesMatched() Gets the number of http messages that matched this session.
String	getName() Gets the name.
HttpSessionTokensSet	getTokensNames()
String	getTokenValue(String tokenName) Gets the token value.
int	getTokenValuesCount() Gets the token values count.
String	getTokenValuesString() Gets the token values string representation.
Map<String,org.apache.commons.httpclient.Cookie>	getTokenValuesUnmodifiableMap() Gets an unmodifiable view of the token values map.
int	hashCode()
void	invalidate() Invalidates the session.
boolean	isActive() Checks if it is active.
boolean	isValid() Checks if the session is still valid.
boolean	matchesToken(String tokenName, HttpCookie cookie) Checks if a particular cookie has the same value as one of the token values in the HTTP session.
void	removeToken(String tokenName) Removes a given token.
void	setActive(boolean active) Sets whether it is active.
void	setMessagesMatched(int messagesMatched) Sets the number of http messages that matched this session.
void	setName(String name) Sets the name.
void	setTokenValue(String tokenName, org.apache.commons.httpclient.Cookie value) Sets a particular value for a session token.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HttpSession

public HttpSession(String name,
                   HttpSessionTokensSet tokenNames)

Instantiates a new http session.

Parameters:

name - the name

tokenNames - the token names

Method Detail

getTokensNames

public HttpSessionTokensSet getTokensNames()

getName

public String getName()

Gets the name.

Returns:

the name

setName

public void setName(String name)

Sets the name.

Parameters:

name - the new name

isActive

public boolean isActive()

Checks if it is active.

Returns:

true, if is active

setActive

public void setActive(boolean active)

Sets whether it is active.

Parameters:

active - the new active

setTokenValue

public void setTokenValue(String tokenName,
                          org.apache.commons.httpclient.Cookie value)

Sets a particular value for a session token. If the value is null, that token is deleted from the session.

Parameters:

tokenName - the token name

value - the new value of the token, or null, if the token has to be deleted

getTokenValue

public String getTokenValue(String tokenName)

Gets the token value.

Parameters:

tokenName - the token name

Returns:

the token value

matchesToken

public boolean matchesToken(String tokenName,
                            HttpCookie cookie)

Checks if a particular cookie has the same value as one of the token values in the HTTP session. If the cookie parameter is null, the session matches the token if it does not have a value for the corresponding token.

Parameters:

tokenName - the token name

cookie - the cookie

Returns:

true, if true

removeToken

public void removeToken(String tokenName)

Removes a given token.

Parameters:

tokenName - the token name

toString

public String toString()

Overrides:

toString in class Object

getTokenValuesString

public String getTokenValuesString()

Gets the token values string representation.

Returns:

the token values string

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

isValid

public boolean isValid()

Checks if the session is still valid.

Returns:

true, if is valid

invalidate

public void invalidate()

Invalidates the session.

getTokenValuesCount

public int getTokenValuesCount()

Gets the token values count.

Returns:

the token values count

getTokenValuesUnmodifiableMap

public Map<String,org.apache.commons.httpclient.Cookie> getTokenValuesUnmodifiableMap()

Gets an unmodifiable view of the token values map. . Query operations on the returned map "read through" to the specified map, and attempts to modify the returned map, whether direct or via its collection views, result in an UnsupportedOperationException.

Returns:

the token values unmodifiable map

getMessagesMatched

public int getMessagesMatched()

Gets the number of http messages that matched this session.

Returns:

the messages matched

setMessagesMatched

public void setMessagesMatched(int messagesMatched)

Sets the number of http messages that matched this session.

Parameters:

messagesMatched - the new messages matched count