org.zaproxy.zap.extension.api

Class ExtensionAPI

java.lang.Object

org.parosproxy.paros.extension.ExtensionAdaptor

org.zaproxy.zap.extension.api.ExtensionAPI

All Implemented Interfaces:

Extension

public class ExtensionAPI
extends ExtensionAdaptor

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_URL Deprecated. (2.7.0) Use API.getBaseURL(boolean) instead. This URL might not be correct in all cases, for example, if the API is set 'Secure' (thus needing to use HTTPS).
static String	NAME

Constructor Summary

Constructors

Constructor and Description
ExtensionAPI()

Method Summary

Modifier and Type	Method and Description
static String	generateApiKey()
String	getAuthor()
CoreAPI	getCoreAPI()
String	getDescription() Returns the description of the extension, to be shown in UI components.
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.
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.
boolean	supportsLowMemory() Return true it the extension can run with the 'low memory' option.

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, 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

API_URL

@Deprecated
public static final String API_URL

Deprecated. (2.7.0) Use API.getBaseURL(boolean) instead. This URL might not be correct in all cases, for example, if the API is set 'Secure' (thus needing to use HTTPS).

See Also:

Constant Field Values

Constructor Detail

ExtensionAPI

public ExtensionAPI()

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

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.

generateApiKey

public static String generateApiKey()

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

getCoreAPI

public CoreAPI getCoreAPI()

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

supportsLowMemory

public boolean supportsLowMemory()

Description copied from interface: Extension

Return true it the extension can run with the 'low memory' option. If the low memory option is set (and the extension supports it) then code should minimize the data stored in memory, using the db for all significant data. Extensions that do not support the low memory option will not be run if the option is set.

Specified by:

supportsLowMemory in interface Extension

Overrides:

supportsLowMemory in class ExtensionAdaptor

Returns:

true if the extension support the 'low memory' option, false otherwise