org.zaproxy.zap.extension.brk

Class ExtensionBreak

java.lang.Object

org.parosproxy.paros.extension.ExtensionAdaptor

org.zaproxy.zap.extension.brk.ExtensionBreak

All Implemented Interfaces:

Extension, OptionsChangedListener, SessionChangedListener

public class ExtensionBreak
extends ExtensionAdaptor
implements SessionChangedListener, OptionsChangedListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExtensionBreak.DialogType Deprecated. (2.6.0) Should not be used/relied on, breakpoint dialogues should be modal.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
ExtensionBreak()

Method Summary

Modifier and Type	Method and Description
void	addBreakpoint(BreakpointMessageInterface breakpoint)
void	addBreakpointsUiManager(BreakpointsUiManagerInterface uiManager)
void	addHttpBreakpoint(String string, String location, String match, boolean inverse, boolean ignoreCase)
void	addUiBreakpoint(Message aMessage)
boolean	canAddBreakpoint() Deprecated. (2.6.0) Use modal breakpoint dialogues instead of relying on this behaviour.
boolean	canEditBreakpoint() Deprecated. (2.6.0) Use modal breakpoint dialogues instead of relying on this behaviour.
boolean	canRemoveBreakpoint() Deprecated. (2.6.0) Use modal breakpoint dialogues instead of relying on this behaviour.
void	destroy() Plugin cleanup, finalize etc when program shutdown.
void	dialogClosed() Deprecated. (2.6.0) Use modal breakpoint dialogues instead of relying on this behaviour.
void	dialogShown(ExtensionBreak.DialogType type) Deprecated. (2.6.0) Use modal breakpoint dialogues instead of relying on this behaviour.
void	editBreakpoint(BreakpointMessageInterface oldBreakpoint, BreakpointMessageInterface newBreakpoint)
void	editUiSelectedBreakpoint()
String	getAuthor()
BreakPanel	getBreakPanel() Deprecated. (2.6.0) Classes outside of this package should not access the UI directly
BreakpointManagementInterface	getBreakpointManagementInterface()
List<BreakpointMessageInterface>	getBreakpointsEnabledList() Exposes list of enabled breakpoints.
List<BreakpointMessageInterface>	getBreakpointsList()
String	getDescription() Returns the description of the extension, to be shown in UI components.
String	getUIName() By default returns the name returned by getName().
BreakpointMessageInterface	getUiSelectedBreakpoint()
URL	getURL()
void	hook(ExtensionHook extensionHook) Called during extension's initialisation to allow to add new functionality to core components.
boolean	isInScopeOnly()
boolean	messageReceivedFromClient(Message aMessage)
boolean	messageReceivedFromServer(Message aMessage)
void	optionsChanged(OptionsParam optionsParam)
void	optionsLoaded() Called after the options for this extension have been loaded, so that the extension can make use of them.
void	removeBreakpoint(BreakpointMessageInterface breakpoint)
void	removeBreakpointsUiManager(BreakpointsUiManagerInterface uiManager)
void	removeHttpBreakpoint(String string, String location, String match, boolean inverse, boolean ignoreCase)
void	removeUiSelectedBreakpoint()
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.
void	setBreakAllRequests(boolean brk)
void	setBreakAllResponses(boolean brk)
void	setBreakOnId(String id, boolean enable)
boolean	supportsDb(String type) Return true if the specified db type is supported by the extension (or if it doesnt use any db) If this method returns false (meaning the db in use is not supported) then the extension will not be loaded.

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

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

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

getVersion

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

ExtensionBreak

public ExtensionBreak()

Method Detail

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()

getBreakpointManagementInterface

public BreakpointManagementInterface getBreakpointManagementInterface()

getBreakPanel

@Deprecated
public BreakPanel getBreakPanel()

Deprecated. (2.6.0) Classes outside of this package should not access the UI directly

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.

addBreakpoint

public void addBreakpoint(BreakpointMessageInterface breakpoint)

editBreakpoint

public void editBreakpoint(BreakpointMessageInterface oldBreakpoint,
                           BreakpointMessageInterface newBreakpoint)

removeBreakpoint

public void removeBreakpoint(BreakpointMessageInterface breakpoint)

getBreakpointsList

public List<BreakpointMessageInterface> getBreakpointsList()

getUiSelectedBreakpoint

public BreakpointMessageInterface getUiSelectedBreakpoint()

addBreakpointsUiManager

public void addBreakpointsUiManager(BreakpointsUiManagerInterface uiManager)

removeBreakpointsUiManager

public void removeBreakpointsUiManager(BreakpointsUiManagerInterface uiManager)

setBreakAllRequests

public void setBreakAllRequests(boolean brk)

setBreakAllResponses

public void setBreakAllResponses(boolean brk)

addHttpBreakpoint

public void addHttpBreakpoint(String string,
                              String location,
                              String match,
                              boolean inverse,
                              boolean ignoreCase)

removeHttpBreakpoint

public void removeHttpBreakpoint(String string,
                                 String location,
                                 String match,
                                 boolean inverse,
                                 boolean ignoreCase)

addUiBreakpoint

public void addUiBreakpoint(Message aMessage)

editUiSelectedBreakpoint

public void editUiSelectedBreakpoint()

removeUiSelectedBreakpoint

public void removeUiSelectedBreakpoint()

canAddBreakpoint

@Deprecated
public boolean canAddBreakpoint()

Deprecated. (2.6.0) Use modal breakpoint dialogues instead of relying on this behaviour.

canEditBreakpoint

@Deprecated
public boolean canEditBreakpoint()

Deprecated. (2.6.0) Use modal breakpoint dialogues instead of relying on this behaviour.

canRemoveBreakpoint

@Deprecated
public boolean canRemoveBreakpoint()

Deprecated. (2.6.0) Use modal breakpoint dialogues instead of relying on this behaviour.

dialogShown

@Deprecated
public void dialogShown(ExtensionBreak.DialogType type)

Deprecated. (2.6.0) Use modal breakpoint dialogues instead of relying on this behaviour.

dialogClosed

@Deprecated
public void dialogClosed()

Deprecated. (2.6.0) Use modal breakpoint dialogues instead of relying on this behaviour.

getAuthor

public String getAuthor()

Specified by:

getAuthor in interface Extension

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

getURL

public URL getURL()

Specified by:

getURL in interface Extension

Overrides:

getURL in class ExtensionAdaptor

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

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

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

destroy

public void destroy()

Description copied from interface: Extension

Plugin cleanup, finalize etc when program shutdown. Stop() will be called before shutdown.

Specified by:

destroy in interface Extension

Overrides:

destroy in class ExtensionAdaptor

messageReceivedFromClient

public boolean messageReceivedFromClient(Message aMessage)

messageReceivedFromServer

public boolean messageReceivedFromServer(Message aMessage)

getBreakpointsEnabledList

public List<BreakpointMessageInterface> getBreakpointsEnabledList()

Exposes list of enabled breakpoints.

Returns:

list of enabled breakpoints

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

setBreakOnId

public void setBreakOnId(String id,
                         boolean enable)

optionsChanged

public void optionsChanged(OptionsParam optionsParam)

Specified by:

optionsChanged in interface OptionsChangedListener

optionsLoaded

public void optionsLoaded()

Description copied from interface: Extension

Called after the options for this extension have been loaded, so that the extension can make use of them. Note that other add-ons may not have been loaded at this point - if you need them to be then implement postInit()

Specified by:

optionsLoaded in interface Extension

Overrides:

optionsLoaded in class ExtensionAdaptor

See Also:

Extension.postInit()

isInScopeOnly

public boolean isInScopeOnly()

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 doesnt 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 doesnt use any db)

See Also:

Database.getType()