org.zaproxy.zap.extension.ruleconfig

Class ExtensionRuleConfig

java.lang.Object

org.parosproxy.paros.extension.ExtensionAdaptor

org.zaproxy.zap.extension.ruleconfig.ExtensionRuleConfig

All Implemented Interfaces:

Extension

public class ExtensionRuleConfig
extends ExtensionAdaptor

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
ExtensionRuleConfig()

Method Summary

Modifier and Type	Method and Description
void	addRuleconfig(RuleConfig rc)
List<RuleConfig>	getAllRuleConfigs()
String	getAuthor()
String	getDescription() Returns the description of the extension, to be shown in UI components.
RuleConfig	getRuleConfig(String key)
RuleConfigParam	getRuleConfigParam()
String	getUIName() By default returns the name returned by getName().
URL	getURL()
void	hook(ExtensionHook extensionHook) Called during extension's initialisation to allow to add new functionality to core components.
void	resetAllRuleConfigValues()
void	resetRuleConfigValue(String key)
void	setRuleConfigValue(String key, String value)
boolean	supportsDb(String type) No database tables used, so all supported

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

canUnload, databaseOpen, destroy, getActiveActions, getAddOn, getDependencies, getExtensionMenu, getExtensionView, getI18nPrefix, getMessages, getModel, getName, getOrder, getUnsavedResources, getView, init, initModel, initView, initXML, isCore, isDepreciated, isEnabled, optionsLoaded, 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.Extension

getVersion

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

ExtensionRuleConfig

public ExtensionRuleConfig()

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

addRuleconfig

public void addRuleconfig(RuleConfig rc)

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.

getRuleConfigParam

public RuleConfigParam getRuleConfigParam()

getAllRuleConfigs

public List<RuleConfig> getAllRuleConfigs()

getRuleConfig

public RuleConfig getRuleConfig(String key)

setRuleConfigValue

public void setRuleConfigValue(String key,
                               String value)

resetRuleConfigValue

public void resetRuleConfigValue(String key)

resetAllRuleConfigValues

public void resetAllRuleConfigValues()

getAuthor

public String getAuthor()

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

supportsDb

public boolean supportsDb(String type)

No database tables used, so all supported

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