Constant (OWASP Zed Attack Proxy)

java.lang.Object
- org.parosproxy.paros.Constant

public final class Constant
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCELERATOR_REDO`
`static String`	`ACCELERATOR_TRIGGER_KEY`
`static String`	`ACCELERATOR_UNDO`
`static String`	`ALPHA_VERSION`
`static String`	`BETA_VERSION`
`static URL`	`BLANK_IMAGE_URL`
`static String`	`DBNAME_TEMPLATE`
`String`	`DBNAME_UNTITLED`
`static String`	`DBNAME_UNTITLED_DEFAULT`
`String`	`DIRBUSTER_CUSTOM_DIR`
`String`	`DIRBUSTER_DIR`
`String`	`FILE_CONFIG`
`static String`	`FILE_CONFIG_DEFAULT` Deprecated. (2.4.2) The path does not take into account the installation directory, use `getPathDefaultConfigFile()` instead.
`static String`	`FILE_CONFIG_NAME`
`static String`	`FILE_PROGRAM_SPLASH`
`static String`	`FILE_SEPARATOR`
`static String`	`FOLDER_FILTER` Deprecated. (2.8.0) Should not be used, the filter functionality is deprecated (replaced by scripts and Replacer add-on).
`static String`	`FOLDER_LOCAL_PLUGIN`
`static String`	`FOLDER_PLUGIN`
`String`	`FOLDER_SESSION`
`static String`	`FOLDER_SESSION_DEFAULT` The name of the directory where the (file) sessions are saved by default.
`String`	`FUZZER_DIR`
`static URL`	`HIGH_FLAG_IMAGE_URL`
`static URL`	`INFO_FLAG_IMAGE_URL`
`static String`	`LANG_DIR` Name of directory that contains the (source and translated) resource files.
`static URL`	`LOW_FLAG_IMAGE_URL`
`static int`	`MAX_HOST_CONNECTION`
`static int`	`MAX_THREADS_PER_SCAN`
`static URL`	`MED_FLAG_IMAGE_URL`
`static I18N`	`messages`
`static String`	`MESSAGES_EXTENSION` Extension (with dot) of Messages.properties files.
`static String`	`MESSAGES_PREFIX` Prefix (file name) of Messages.properties files.
`static URL`	`OK_FLAG_IMAGE_URL`
`static String`	`PAROS_TEAM`
`static String`	`PROGRAM_NAME`
`static String`	`PROGRAM_NAME_SHORT`
`static String`	`PROGRAM_TITLE`
`static String`	`PROGRAM_VERSION`
`static URL`	`SPIDER_IMAGE_URL`
`static String`	`SYSTEM_PAROS_USER_LOG`
`static String`	`USER_AGENT`
`static String`	`VULNERABILITIES_EXTENSION` Extension (with dot) of vulnerabilities.xml files.
`static String`	`VULNERABILITIES_PREFIX` Prefix (file name) of vulnerabilities.xml files.
`static String`	`VULNS_BASE` Deprecated. (2.4.0) Use `VULNERABILITIES_PREFIX` instead. It will be removed in a following release.
`static String`	`ZAP_EXTENSIONS_PAGE` Deprecated. (2.9.0) Do not use, it will be removed.
`static String`	`ZAP_HOMEPAGE` Deprecated. (2.9.0) Do not use, it will be removed.
`static String`	`ZAP_TEAM`

Constructor Summary

Constructors
Constructor and Description

Constant()

Constructors
Constructor and Description
`Constant()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`copyDefaultConfigs(File f, boolean forceReset)`
`static void`	`createInstance(ControlOverrides overrides)`
`static File`	`getContextsDir()`
`static String`	`getDefaultHomeDirectory(boolean incDevOption)`
`static String`	`getEyeCatcher()`
`static Date`	`getInstallDate()`
`static Constant`	`getInstance()`
`static Locale`	`getLocale()`
`static Path`	`getPathDefaultConfigFile()` Returns the path to default configuration file, located in installation directory.
`static File`	`getPoliciesDir()`
`static Date`	`getReleaseCreateDate()`
`static Locale`	`getSystemsLocale()` Returns the system's `Locale` (as determined by the JVM at startup, `Locale.getDefault()`).
`static String`	`getZapHome()`
`static String`	`getZapInstall()`
`void`	`initializeFilesAndDirectories()`
`static boolean`	`isDailyBuild()`
`static boolean`	`isDailyBuild(String version)`
`static boolean`	`isDevBuild()` Tells whether or not ZAP is running from a dev build.
`static boolean`	`isDevBuild(String version)`
`static boolean`	`isDevMode()` Tells whether or not the "dev mode" should be enabled.
`static boolean`	`isKali()` Tells whether or not ZAP is running in Kali (and it's not a daily build).
`static boolean`	`isLinux()`
`static boolean`	`isLowMemoryOptionSet()`
`static boolean`	`isMacOsX()`
`static boolean`	`isSilent()` If true then ZAP should not make any unsolicited requests, e.g.
`static boolean`	`isWindows()`
`static void`	`setDevMode(boolean devMode)` Sets whether or not the "dev mode" should be enabled.
`static void`	`setEyeCatcher(String eyeCatcher)`
`static void`	`setLocale(String loc)`
`static void`	`setLowMemoryOption(boolean lowMem)`
`static void`	`setSilent(boolean silent)` Sets whether or not ZAP should be 'silent' i.e.
`static void`	`setZapHome(String dir)`
`static void`	`setZapInstall(String dir)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROGRAM_NAME
```
public static final String PROGRAM_NAME
```
    See Also:
    
    Constant Field Values
  - PROGRAM_NAME_SHORT
```
public static final String PROGRAM_NAME_SHORT
```
    See Also:
    
    Constant Field Values
  - ZAP_HOMEPAGE
```
@Deprecated
public static final String ZAP_HOMEPAGE
```
    Deprecated. (2.9.0) Do not use, it will be removed.
    
    See Also:
    
    Constant Field Values
  - ZAP_EXTENSIONS_PAGE
```
@Deprecated
public static final String ZAP_EXTENSIONS_PAGE
```
    Deprecated. (2.9.0) Do not use, it will be removed.
    
    See Also:
    
    Constant Field Values
  - ZAP_TEAM
```
public static final String ZAP_TEAM
```
    See Also:
    
    Constant Field Values
  - PAROS_TEAM
```
public static final String PAROS_TEAM
```
    See Also:
    
    Constant Field Values
  - ALPHA_VERSION
```
public static final String ALPHA_VERSION
```
    See Also:
    
    Constant Field Values
  - BETA_VERSION
```
public static final String BETA_VERSION
```
    See Also:
    
    Constant Field Values
  - PROGRAM_VERSION
```
public static String PROGRAM_VERSION
```
  - PROGRAM_TITLE
```
public static String PROGRAM_TITLE
```
  - SYSTEM_PAROS_USER_LOG
```
public static final String SYSTEM_PAROS_USER_LOG
```
    See Also:
    
    Constant Field Values
  - FILE_SEPARATOR
```
public static final String FILE_SEPARATOR
```
  - FILE_CONFIG_DEFAULT
```
@Deprecated
public static final String FILE_CONFIG_DEFAULT
```
    Deprecated. (2.4.2) The path does not take into account the installation directory, use getPathDefaultConfigFile() instead.
    
    See Also:
    
    Constant Field Values
  - FILE_CONFIG_NAME
```
public static final String FILE_CONFIG_NAME
```
    See Also:
    
    Constant Field Values
  - FOLDER_PLUGIN
```
public static final String FOLDER_PLUGIN
```
    See Also:
    
    Constant Field Values
  - FOLDER_FILTER
```
@Deprecated
public static final String FOLDER_FILTER
```
    Deprecated. (2.8.0) Should not be used, the filter functionality is deprecated (replaced by scripts and Replacer add-on).
    
    The name of the directory for filter related files (the path should be built using getZapHome() as the parent directory).
    
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - FOLDER_SESSION_DEFAULT
```
public static final String FOLDER_SESSION_DEFAULT
```
    The name of the directory where the (file) sessions are saved by default.
    
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - DBNAME_TEMPLATE
```
public static final String DBNAME_TEMPLATE
```
  - MESSAGES_PREFIX
```
public static final String MESSAGES_PREFIX
```
    Prefix (file name) of Messages.properties files.
    
    See Also:
    
    MESSAGES_EXTENSION, Constant Field Values
  - MESSAGES_EXTENSION
```
public static final String MESSAGES_EXTENSION
```
    Extension (with dot) of Messages.properties files.
    
    Since:
    
    2.4.0
    
    See Also:
    
    MESSAGES_PREFIX, Constant Field Values
  - DBNAME_UNTITLED_DEFAULT
```
public static final String DBNAME_UNTITLED_DEFAULT
```
  - FILE_CONFIG
```
public String FILE_CONFIG
```
  - FOLDER_SESSION
```
public String FOLDER_SESSION
```
  - DBNAME_UNTITLED
```
public String DBNAME_UNTITLED
```
  - FILE_PROGRAM_SPLASH
```
public static final String FILE_PROGRAM_SPLASH
```
    See Also:
    
    Constant Field Values
  - ACCELERATOR_UNDO
```
public static String ACCELERATOR_UNDO
```
  - ACCELERATOR_REDO
```
public static String ACCELERATOR_REDO
```
  - ACCELERATOR_TRIGGER_KEY
```
public static String ACCELERATOR_TRIGGER_KEY
```
  - MAX_HOST_CONNECTION
```
public static final int MAX_HOST_CONNECTION
```
    See Also:
    
    Constant Field Values
  - MAX_THREADS_PER_SCAN
```
public static final int MAX_THREADS_PER_SCAN
```
    See Also:
    
    Constant Field Values
  - USER_AGENT
```
public static final String USER_AGENT
```
    See Also:
    
    Constant Field Values
  - messages
```
public static I18N messages
```
  - LANG_DIR
```
public static final String LANG_DIR
```
    Name of directory that contains the (source and translated) resource files.
    
    See Also:
    
    MESSAGES_PREFIX, VULNERABILITIES_PREFIX, Constant Field Values
  - VULNERABILITIES_PREFIX
```
public static final String VULNERABILITIES_PREFIX
```
    Prefix (file name) of vulnerabilities.xml files.
    
    Since:
    
    2.4.0
    
    See Also:
    
    VULNERABILITIES_EXTENSION, Constant Field Values
  - VULNS_BASE
```
@Deprecated
public static String VULNS_BASE
```
    Deprecated. (2.4.0) Use VULNERABILITIES_PREFIX instead. It will be removed in a following release.
  - VULNERABILITIES_EXTENSION
```
public static final String VULNERABILITIES_EXTENSION
```
    Extension (with dot) of vulnerabilities.xml files.
    
    Since:
    
    2.4.0
    
    See Also:
    
    VULNERABILITIES_PREFIX, Constant Field Values
  - DIRBUSTER_DIR
```
public String DIRBUSTER_DIR
```
  - DIRBUSTER_CUSTOM_DIR
```
public String DIRBUSTER_CUSTOM_DIR
```
  - FUZZER_DIR
```
public String FUZZER_DIR
```
  - FOLDER_LOCAL_PLUGIN
```
public static String FOLDER_LOCAL_PLUGIN
```
  - OK_FLAG_IMAGE_URL
```
public static final URL OK_FLAG_IMAGE_URL
```
  - INFO_FLAG_IMAGE_URL
```
public static final URL INFO_FLAG_IMAGE_URL
```
  - LOW_FLAG_IMAGE_URL
```
public static final URL LOW_FLAG_IMAGE_URL
```
  - MED_FLAG_IMAGE_URL
```
public static final URL MED_FLAG_IMAGE_URL
```
  - HIGH_FLAG_IMAGE_URL
```
public static final URL HIGH_FLAG_IMAGE_URL
```
  - BLANK_IMAGE_URL
```
public static final URL BLANK_IMAGE_URL
```
  - SPIDER_IMAGE_URL
```
public static final URL SPIDER_IMAGE_URL
```
- Constructor Detail
  - Constant
```
public Constant()
```
- Method Detail
  - getEyeCatcher
```
public static String getEyeCatcher()
```
  - setEyeCatcher
```
public static void setEyeCatcher(String eyeCatcher)
```
  - getDefaultHomeDirectory
```
public static String getDefaultHomeDirectory(boolean incDevOption)
```
  - copyDefaultConfigs
```
public void copyDefaultConfigs(File f,
                               boolean forceReset)
                        throws IOException,
                               org.apache.commons.configuration.ConfigurationException
```
    Throws:
    
    IOException
    
    org.apache.commons.configuration.ConfigurationException
  - initializeFilesAndDirectories
```
public void initializeFilesAndDirectories()
```
  - setLocale
```
public static void setLocale(String loc)
```
  - getLocale
```
public static Locale getLocale()
```
  - getSystemsLocale
```
public static Locale getSystemsLocale()
```
    Returns the system's Locale (as determined by the JVM at startup, Locale.getDefault()). Should be used to show locale dependent information in the system's locale.
    Note: The default locale is overridden with the ZAP's user defined locale/language.
    
    Returns:
    
    the system's Locale
    
    See Also:
    
    Locale.setDefault(Locale)
  - getInstance
```
public static Constant getInstance()
```
  - createInstance
```
public static void createInstance(ControlOverrides overrides)
```
  - isWindows
```
public static boolean isWindows()
```
  - isLinux
```
public static boolean isLinux()
```
  - isMacOsX
```
public static boolean isMacOsX()
```
  - setZapHome
```
public static void setZapHome(String dir)
```
  - getZapHome
```
public static String getZapHome()
```
  - getPathDefaultConfigFile
```
public static Path getPathDefaultConfigFile()
```
    Returns the path to default configuration file, located in installation directory.
    Note: The default configuration file is not guaranteed to exist, for example, when running just with ZAP JAR.
    
    Returns:
    
    the Path to default configuration file.
    
    Since:
    
    2.4.2
  - getContextsDir
```
public static File getContextsDir()
```
  - getPoliciesDir
```
public static File getPoliciesDir()
```
  - setZapInstall
```
public static void setZapInstall(String dir)
```
  - getZapInstall
```
public static String getZapInstall()
```
  - getReleaseCreateDate
```
public static Date getReleaseCreateDate()
```
  - getInstallDate
```
public static Date getInstallDate()
```
  - isDevMode
```
public static boolean isDevMode()
```
    Tells whether or not the "dev mode" should be enabled.
    Should be used to enable development related utilities/functionalities.
    
    Returns:
    
    true if the "dev mode" should be enabled, false otherwise.
    
    Since:
    
    2.8.0
  - setDevMode
```
public static void setDevMode(boolean devMode)
```
    Sets whether or not the "dev mode" should be enabled.
    Note: This method should be called only by bootstrap classes.
    
    Parameters:
    
    devMode - true if the "dev mode" should be enabled, false otherwise.
  - setSilent
```
public static void setSilent(boolean silent)
```
    Sets whether or not ZAP should be 'silent' i.e. not make any unsolicited requests.
    Note: This method should be called only by bootstrap classes.
    
    Parameters:
    
    silent - true if ZAP should be silent, false otherwise.
    
    Since:
    
    2.8.0
  - isDevBuild
```
public static boolean isDevBuild()
```
    Tells whether or not ZAP is running from a dev build.
    
    Returns:
    
    true if it's a dev build, false otherwise.
    
    See Also:
    
    isDevMode()
  - isDevBuild
```
public static boolean isDevBuild(String version)
```
  - isDailyBuild
```
public static boolean isDailyBuild(String version)
```
  - isDailyBuild
```
public static boolean isDailyBuild()
```
  - isSilent
```
public static boolean isSilent()
```
    If true then ZAP should not make any unsolicited requests, e.g. check-for-updates
    
    Returns:
    
    true if ZAP should not make any unsolicited requests, e.g. check-for-updates
    
    Since:
    
    2.8.0
  - setLowMemoryOption
```
public static void setLowMemoryOption(boolean lowMem)
```
  - isLowMemoryOptionSet
```
public static boolean isLowMemoryOptionSet()
```
  - isKali
```
public static boolean isKali()
```
    Tells whether or not ZAP is running in Kali (and it's not a daily build).
    
    Returns:
    
    true if running in Kali (and it's not daily build), false otherwise

Class Constant

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROGRAM_NAME

PROGRAM_NAME_SHORT

ZAP_HOMEPAGE

ZAP_EXTENSIONS_PAGE

ZAP_TEAM

PAROS_TEAM

ALPHA_VERSION

BETA_VERSION

PROGRAM_VERSION

PROGRAM_TITLE

SYSTEM_PAROS_USER_LOG

FILE_SEPARATOR

FILE_CONFIG_DEFAULT

FILE_CONFIG_NAME

FOLDER_PLUGIN

FOLDER_FILTER

FOLDER_SESSION_DEFAULT

DBNAME_TEMPLATE

MESSAGES_PREFIX

MESSAGES_EXTENSION

DBNAME_UNTITLED_DEFAULT

FILE_CONFIG

FOLDER_SESSION

DBNAME_UNTITLED

FILE_PROGRAM_SPLASH

ACCELERATOR_UNDO

ACCELERATOR_REDO

ACCELERATOR_TRIGGER_KEY

MAX_HOST_CONNECTION

MAX_THREADS_PER_SCAN

USER_AGENT

messages

LANG_DIR

VULNERABILITIES_PREFIX

VULNS_BASE

VULNERABILITIES_EXTENSION

DIRBUSTER_DIR

DIRBUSTER_CUSTOM_DIR

FUZZER_DIR

FOLDER_LOCAL_PLUGIN

OK_FLAG_IMAGE_URL

INFO_FLAG_IMAGE_URL

LOW_FLAG_IMAGE_URL

MED_FLAG_IMAGE_URL

HIGH_FLAG_IMAGE_URL

BLANK_IMAGE_URL

SPIDER_IMAGE_URL

Constructor Detail

Constant

Method Detail

getEyeCatcher

setEyeCatcher

getDefaultHomeDirectory

copyDefaultConfigs

initializeFilesAndDirectories

setLocale

getLocale

getSystemsLocale

getInstance

createInstance

isWindows

isLinux

isMacOsX

setZapHome

getZapHome

getPathDefaultConfigFile

getContextsDir

getPoliciesDir

setZapInstall

getZapInstall

getReleaseCreateDate

getInstallDate

isDevMode

setDevMode