Package org.zaproxy.clientapi.gen

Class HttpSessions

java.lang.Object

org.zaproxy.clientapi.gen.deprecated.HttpSessionsDeprecated

org.zaproxy.clientapi.gen.HttpSessions

public class HttpSessions
extends HttpSessionsDeprecated

This file was automatically generated.

Constructor Summary

Constructors

Constructor	Description
HttpSessions(ClientApi api)

Method Summary

Modifier and Type	Method	Description
ApiResponse	activeSession(String site)	Gets the name of the active session for the given site.
ApiResponse	addDefaultSessionToken(String sessiontoken, String tokenenabled)	Adds a default session token with the given name and enabled state.
ApiResponse	addSessionToken(String site, String sessiontoken)	Adds the session token to the given site.
ApiResponse	createEmptySession(String site, String session)	Creates an empty session for the given site.
ApiResponse	defaultSessionTokens()	Gets the default session tokens.
ApiResponse	removeDefaultSessionToken(String sessiontoken)	Removes the default session token with the given name.
ApiResponse	removeSession(String site, String session)	Removes the session from the given site.
ApiResponse	removeSessionToken(String site, String sessiontoken)	Removes the session token from the given site.
ApiResponse	renameSession(String site, String oldsessionname, String newsessionname)	Renames the session of the given site.
ApiResponse	sessions(String site, String session)	Gets the sessions for the given site.
ApiResponse	sessionTokens(String site)	Gets the names of the session tokens for the given site.
ApiResponse	setActiveSession(String site, String session)	Sets the given session as active for the given site.
ApiResponse	setDefaultSessionTokenEnabled(String sessiontoken, String tokenenabled)	Sets whether or not the default session token with the given name is enabled.
ApiResponse	setSessionTokenValue(String site, String session, String sessiontoken, String tokenvalue)	Sets the value of the session token of the given session for the given site.
ApiResponse	sites()	Gets all of the sites that have sessions.
ApiResponse	unsetActiveSession(String site)	Unsets the active session of the given site.

Methods inherited from class org.zaproxy.clientapi.gen.deprecated.HttpSessionsDeprecated

addSessionToken, createEmptySession, removeSession, removeSessionToken, renameSession, setActiveSession, setSessionTokenValue, unsetActiveSession

Methods inherited from class java.lang.Object

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

Constructor Details

HttpSessions

public HttpSessions(ClientApi api)

Method Details

sites

public ApiResponse sites()
                  throws ClientApiException

Gets all of the sites that have sessions.

Throws:

ClientApiException

sessions

public ApiResponse sessions(String site,
 String session)
                     throws ClientApiException

Gets the sessions for the given site. Optionally returning just the session with the given name.

Throws:

ClientApiException

activeSession

public ApiResponse activeSession(String site)
                          throws ClientApiException

Gets the name of the active session for the given site.

Throws:

ClientApiException

sessionTokens

public ApiResponse sessionTokens(String site)
                          throws ClientApiException

Gets the names of the session tokens for the given site.

Throws:

ClientApiException

defaultSessionTokens

public ApiResponse defaultSessionTokens()
                                 throws ClientApiException

Gets the default session tokens.

Throws:

ClientApiException

createEmptySession

public ApiResponse createEmptySession(String site,
 String session)
                               throws ClientApiException

Creates an empty session for the given site. Optionally with the given name.

Throws:

ClientApiException

removeSession

public ApiResponse removeSession(String site,
 String session)
                          throws ClientApiException

Removes the session from the given site.

Throws:

ClientApiException

setActiveSession

public ApiResponse setActiveSession(String site,
 String session)
                             throws ClientApiException

Sets the given session as active for the given site.

Throws:

ClientApiException

unsetActiveSession

public ApiResponse unsetActiveSession(String site)
                               throws ClientApiException

Unsets the active session of the given site.

Throws:

ClientApiException

addSessionToken

public ApiResponse addSessionToken(String site,
 String sessiontoken)
                            throws ClientApiException

Adds the session token to the given site.

Throws:

ClientApiException

removeSessionToken

public ApiResponse removeSessionToken(String site,
 String sessiontoken)
                               throws ClientApiException

Removes the session token from the given site.

Throws:

ClientApiException

setSessionTokenValue

public ApiResponse setSessionTokenValue(String site,
 String session,
 String sessiontoken,
 String tokenvalue)
                                 throws ClientApiException

Sets the value of the session token of the given session for the given site.

Throws:

ClientApiException

renameSession

public ApiResponse renameSession(String site,
 String oldsessionname,
 String newsessionname)
                          throws ClientApiException

Renames the session of the given site.

Throws:

ClientApiException

addDefaultSessionToken

public ApiResponse addDefaultSessionToken(String sessiontoken,
 String tokenenabled)
                                   throws ClientApiException

Adds a default session token with the given name and enabled state.

Throws:

ClientApiException

setDefaultSessionTokenEnabled

public ApiResponse setDefaultSessionTokenEnabled(String sessiontoken,
 String tokenenabled)
                                          throws ClientApiException

Sets whether or not the default session token with the given name is enabled.

Throws:

ClientApiException

removeDefaultSessionToken

public ApiResponse removeDefaultSessionToken(String sessiontoken)
                                      throws ClientApiException

Removes the default session token with the given name.

Throws:

ClientApiException