org.zaproxy.zap.extension.params

Class ExtensionParams

java.lang.Object

org.parosproxy.paros.extension.ExtensionAdaptor

org.zaproxy.zap.extension.params.ExtensionParams

All Implemented Interfaces:

Extension, SessionChangedListener, SiteMapListener

public class ExtensionParams
extends ExtensionAdaptor
implements SessionChangedListener, SiteMapListener

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
ExtensionParams()

Method Summary

Modifier and Type	Method and Description
void	addAntiCsrfToken()
void	addSessionToken() Adds a new session token from the selected parameter.
Collection<SiteParameters>	getAllSiteParameters()
String	getAuthor() Gets the author of the extension.
String	getDescription() Returns the description of the extension, to be shown in UI components.
protected ExtensionHttpSessions	getExtensionHttpSessions() Gets the ExtensionHttpSessions, if it's enabled
protected ParamsPanel	getParamsPanel()
HtmlParameterStats	getSelectedParam()
SiteParameters	getSiteParameters(String site)
String	getUIName() By default returns the name returned by getName().
boolean	hasParameters(String site) Tells whether or not the given site has parameters.
boolean	hasSite(String site) Tells whether or not the given site was already seen.
void	hook(ExtensionHook extensionHook) Called during extension's initialisation to allow to add new functionality to core components.
void	nodeSelected(SiteNode node)
boolean	onHttpRequestSend(HttpMessage msg)
boolean	onHttpResponseReceive(HttpMessage msg)
void	onReturnNodeRendererComponent(SiteMapTreeCellRenderer component, boolean leaf, SiteNode value)
void	removeAntiCsrfToken()
void	removeSessionToken() Removes the currently selected parameter as a session token.
protected void	searchForSelectedParam()
void	sessionAboutToChange(Session session) Called just prior to the session changing.
void	sessionChanged(Session session) Called just after the session has changed.
void	sessionModeChanged(Control.Mode mode) Called when the user changes the mode.
void	sessionScopeChanged(Session session) Called when the user has changes the session scope.
boolean	supportsDb(String type) Return true if the specified db type is supported by the extension (or if it doesn't use any db) If this method returns false (meaning the db in use is not supported) then the extension will not be loaded.
void	unload() Unloads any component manually added to ZAP or other extensions (that is, a component that was not added through the ExtensionHook).

Methods inherited from class org.parosproxy.paros.extension.ExtensionAdaptor

canUnload, databaseOpen, destroy, getActiveActions, getAddOn, getDependencies, getExtensionMenu, getExtensionView, getI18nPrefix, getMessages, getModel, getName, getOrder, getUnsavedResources, getView, hasView, init, initModel, initView, initXML, isCore, isDepreciated, isEnabled, optionsLoaded, postInit, postInstall, setAddOn, setDescription, setEnabled, setI18nPrefix, setMessages, setName, setOrder, start, stop, supportsLowMemory

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.parosproxy.paros.extension.SessionChangedListener

sessionPropertiesChanged

Methods inherited from interface org.parosproxy.paros.extension.Extension

getURL, getVersion

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

ExtensionParams

public ExtensionParams()

Method Detail

supportsDb

public boolean supportsDb(String type)

Description copied from interface: Extension

Return true if the specified db type is supported by the extension (or if it doesn't use any db) If this method returns false (meaning the db in use is not supported) then the extension will not be loaded.

Specified by:

supportsDb in interface Extension

Overrides:

supportsDb in class ExtensionAdaptor

Parameters:

type - the db type

Returns:

true if the specified db type is supported by the extension (or if it doesn't use any db)

See Also:

Database.getType()

getUIName

public String getUIName()

Description copied from class: ExtensionAdaptor

By default returns the name returned by getName().

Specified by:

getUIName in interface Extension

Overrides:

getUIName in class ExtensionAdaptor

Returns:

the UI name of the extension, never null

See Also:

ExtensionAdaptor.getName()

hook

public void hook(ExtensionHook extensionHook)

Description copied from interface: Extension

Called during extension's initialisation to allow to add new functionality to core components.

Specified by:

hook in interface Extension

Overrides:

hook in class ExtensionAdaptor

Parameters:

extensionHook - the hook to add the components.

unload

public void unload()

Description copied from class: ExtensionAdaptor

Unloads any component manually added to ZAP or other extensions (that is, a component that was not added through the ExtensionHook).

Should be called only by core functionality (e.g. during uninstallation of the extension).

Does nothing by default.

Specified by:

unload in interface Extension

Overrides:

unload in class ExtensionAdaptor

See Also:

Extension.hook(ExtensionHook)

getParamsPanel

protected ParamsPanel getParamsPanel()

sessionChanged

public void sessionChanged(Session session)

Description copied from interface: SessionChangedListener

Called just after the session has changed. sessionChanged may be called by non-event thread. Should handle with care in all the listener. Use EventThread for each GUI event.

Specified by:

sessionChanged in interface SessionChangedListener

Parameters:

session - the new session

getExtensionHttpSessions

protected ExtensionHttpSessions getExtensionHttpSessions()

Gets the ExtensionHttpSessions, if it's enabled

Returns:

the Http Sessions extension or null, if it's not available

onHttpRequestSend

public boolean onHttpRequestSend(HttpMessage msg)

onHttpResponseReceive

public boolean onHttpResponseReceive(HttpMessage msg)

nodeSelected

public void nodeSelected(SiteNode node)

Specified by:

nodeSelected in interface SiteMapListener

onReturnNodeRendererComponent

public void onReturnNodeRendererComponent(SiteMapTreeCellRenderer component,
                                          boolean leaf,
                                          SiteNode value)

Specified by:

onReturnNodeRendererComponent in interface SiteMapListener

searchForSelectedParam

protected void searchForSelectedParam()

addAntiCsrfToken

public void addAntiCsrfToken()

removeAntiCsrfToken

public void removeAntiCsrfToken()

hasSite

public boolean hasSite(String site)

Tells whether or not the given site was already seen.

Parameters:

site - the site that will be checked

Returns:

true if the given site was already seen, false otherwise.

Since:

2.5.0

See Also:

hasParameters(String)

hasParameters

public boolean hasParameters(String site)

Tells whether or not the given site has parameters.

Parameters:

site - the site that will be checked

Returns:

true if the given site has parameters, false if not, or was not yet seen.

Since:

2.5.0

See Also:

hasSite(String)

getSiteParameters

public SiteParameters getSiteParameters(String site)

getAllSiteParameters

public Collection<SiteParameters> getAllSiteParameters()

addSessionToken

public void addSessionToken()

Adds a new session token from the selected parameter. Also notifies the ExtensionHttpSessions if it's active.

removeSessionToken

public void removeSessionToken()

Removes the currently selected parameter as a session token. Also notifies the ExtensionHttpSessions if it's active.

getSelectedParam

public HtmlParameterStats getSelectedParam()

sessionAboutToChange

public void sessionAboutToChange(Session session)

Description copied from interface: SessionChangedListener

Called just prior to the session changing. Listeners should close down any resources associated with this session. sessionAboutToChange may be called by non-event thread. Should handle with care in all the listener. Use EventThread for each GUI event.

Specified by:

sessionAboutToChange in interface SessionChangedListener

Parameters:

session - the session about to be closed

sessionScopeChanged

public void sessionScopeChanged(Session session)

Description copied from interface: SessionChangedListener

Called when the user has changes the session scope. sessionScopeChanged may be called by non-event thread. Should handle with care in all the listener. Use EventThread for each GUI event.

Specified by:

sessionScopeChanged in interface SessionChangedListener

Parameters:

session - the current session

getAuthor

public String getAuthor()

Description copied from interface: Extension

Gets the author of the extension.

Since 2.9.0 defaults to the author of the add-on, if set, otherwise an empty string.

Specified by:

getAuthor in interface Extension

Returns:

the author of the extension, might be null.

getDescription

public String getDescription()

Description copied from interface: Extension

Returns the description of the extension, to be shown in UI components. The description must be internationalised.

Specified by:

getDescription in interface Extension

Overrides:

getDescription in class ExtensionAdaptor

Returns:

the description of the extension, never null

sessionModeChanged

public void sessionModeChanged(Control.Mode mode)

Description copied from interface: SessionChangedListener

Called when the user changes the mode. sessionModeChanged may be called by non-event thread. Should handle with care in all the listener. Use EventThread for each GUI event.

Specified by:

sessionModeChanged in interface SessionChangedListener

Parameters:

mode - the new mode