Alert (OWASP Zed Attack Proxy)

java.lang.Object
- org.parosproxy.paros.core.scanner.Alert

All Implemented Interfaces:: Comparable<Alert>

public class Alert
extends Object
implements Comparable<Alert>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Alert.Builder
A builder of alerts.

static class Alert.Source
The source of the alerts.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Alert.Builder` A builder of alerts.
`static class`	`Alert.Source` The source of the alerts.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CONFIDENCE_FALSE_POSITIVE`
`static int`	`CONFIDENCE_HIGH`
`static int`	`CONFIDENCE_LOW`
`static int`	`CONFIDENCE_MEDIUM`
`static int`	`CONFIDENCE_USER_CONFIRMED`
`static String[]`	`MSG_CONFIDENCE`
`static String[]`	`MSG_RELIABILITY` Deprecated. (2.4.0) Replaced by `MSG_CONFIDENCE`. Use of reliability has been deprecated in favour of using confidence.
`static String[]`	`MSG_RISK`
`static int`	`RISK_HIGH`
`static int`	`RISK_INFO`
`static int`	`RISK_LOW`
`static int`	`RISK_MEDIUM`
`static int`	`SUSPICIOUS` Deprecated. (2.4.0) Replaced by `CONFIDENCE_LOW` confidence. SUSPICIOUS reliability has been deprecated in favour of using CONFIDENCE_LOW confidence.
`static int`	`WARNING` Deprecated. (2.4.0) Replaced by `CONFIDENCE_MEDIUM` confidence. WARNING reliability has been deprecated in favour of using CONFIDENCE_MEDIUM confidence.

Constructor Summary

Constructors
Constructor and Description
`Alert(int pluginId)`
`Alert(int pluginId, int risk, int confidence, String name)`
`Alert(RecordAlert recordAlert)`
`Alert(RecordAlert recordAlert, HistoryReference ref)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Alert.Builder`	`builder()` Returns a new alert builder.
`int`	`compareTo(Alert alert2)`
`boolean`	`equals(Object obj)` Override equals.
`String`	`getAlert()` Deprecated. (2.5.0) Replaced by `getName()`. Use of alert has been deprecated in favour of using name.
`int`	`getAlertId()`
`String`	`getAlertRef()` Gets the alert reference.
`String`	`getAttack()`
`int`	`getConfidence()`
`int`	`getCweId()`
`String`	`getDescription()`
`String`	`getEvidence()`
`HistoryReference`	`getHistoryRef()`
`ImageIcon`	`getIcon()` Gets the correctly scaled icon for this alert.
`URL`	`getIconUrl()` Deprecated.
`HttpMessage`	`getMessage()`
`String`	`getMethod()`
`org.apache.commons.httpclient.URI`	`getMsgUri()`
`String`	`getName()`
`String`	`getOtherInfo()`
`String`	`getParam()`
`int`	`getPluginId()`
`String`	`getPostData()`
`String`	`getReference()`
`int`	`getReliability()` Deprecated. (2.4.0) Replaced by `getConfidence()`.
`int`	`getRisk()`
`String`	`getSolution()`
`Alert.Source`	`getSource()` Gets the source of the alert.
`int`	`getSourceHistoryId()`
`String`	`getUri()`
`String`	`getUrlParamXML()`
`int`	`getWascId()`
`int`	`hashCode()`
`static boolean`	`isValidConfidence(int confidence)` Checks if a value `int` is between 0 (CONFIDENCE_FALSE_POSITIVE) and 4 (CONFIDENCE_USER_CONFIRMED)
`static boolean`	`isValidRisk(int risk)` Checks if a value `int` is between 0 (RISK_INFO) and 3 (RISK_HIGH)
`Alert`	`newInstance()` Creates a new instance of `Alert` with same members.
`String`	`paragraph(String text)`
`String`	`replaceEntity(String text)`
`void`	`setAlert(String alert)` Deprecated. (2.5.0) Replaced by `setName(java.lang.String)`. Use of alert has been deprecated in favour of using name.
`void`	`setAlertId(int alertId)`
`void`	`setAlertRef(String alertRef)` Sets the alert reference.
`void`	`setAttack(String attack)`
`void`	`setConfidence(int confidence)` Sets the confidence of the alert.
`void`	`setCweId(int cweId)`
`void`	`setDescription(String description)`
`void`	`setDetail(String description, String uri, String param, String attack, String otherInfo, String solution, String reference, HttpMessage msg)` Deprecated. (2.2.0) Replaced by `setDetail(String, String, String, String, String, String, String, String, int, int, HttpMessage)`. It will be removed in a future release.
`void`	`setDetail(String description, String uri, String param, String attack, String otherInfo, String solution, String reference, String evidence, int cweId, int wascId, HttpMessage msg)` Sets the details of the alert.
`void`	`setEvidence(String evidence)`
`void`	`setHistoryRef(HistoryReference historyRef)`
`void`	`setMessage(HttpMessage message)`
`void`	`setName(String name)` Sets the name of the alert to name
`void`	`setOtherInfo(String otherInfo)`
`void`	`setParam(String param)`
`void`	`setReference(String reference)`
`void`	`setRisk(int risk)` Sets the risk of the alert.
`void`	`setRiskConfidence(int risk, int confidence)`
`void`	`setRiskReliability(int risk, int confidence)` Deprecated. (2.4.0) Replaced by `setRiskConfidence(int, int)`. Use of reliability has been deprecated in favour of using confidence
`void`	`setSolution(String solution)`
`void`	`setSource(Alert.Source source)` Sets the source of the alert.
`void`	`setSourceHistoryId(int sourceHistoryId)`
`void`	`setUri(String uri)`
`void`	`setWascId(int wascId)`
`String`	`toPluginXML(String urls)`

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

- Field Detail
  - RISK_INFO
```
public static final int RISK_INFO
```
    See Also:
    
    Constant Field Values
  - RISK_LOW
```
public static final int RISK_LOW
```
    See Also:
    
    Constant Field Values
  - RISK_MEDIUM
```
public static final int RISK_MEDIUM
```
    See Also:
    
    Constant Field Values
  - RISK_HIGH
```
public static final int RISK_HIGH
```
    See Also:
    
    Constant Field Values
  - CONFIDENCE_FALSE_POSITIVE
```
public static final int CONFIDENCE_FALSE_POSITIVE
```
    See Also:
    
    Constant Field Values
  - SUSPICIOUS
```
@Deprecated
public static final int SUSPICIOUS
```
    Deprecated. (2.4.0) Replaced by CONFIDENCE_LOW confidence. SUSPICIOUS reliability has been deprecated in favour of using CONFIDENCE_LOW confidence.
    
    See Also:
    
    Constant Field Values
  - CONFIDENCE_LOW
```
public static final int CONFIDENCE_LOW
```
    See Also:
    
    Constant Field Values
  - WARNING
```
@Deprecated
public static final int WARNING
```
    Deprecated. (2.4.0) Replaced by CONFIDENCE_MEDIUM confidence. WARNING reliability has been deprecated in favour of using CONFIDENCE_MEDIUM confidence.
    
    See Also:
    
    Constant Field Values
  - CONFIDENCE_MEDIUM
```
public static final int CONFIDENCE_MEDIUM
```
    See Also:
    
    Constant Field Values
  - CONFIDENCE_HIGH
```
public static final int CONFIDENCE_HIGH
```
    See Also:
    
    Constant Field Values
  - CONFIDENCE_USER_CONFIRMED
```
public static final int CONFIDENCE_USER_CONFIRMED
```
    See Also:
    
    Constant Field Values
  - MSG_RISK
```
public static final String[] MSG_RISK
```
  - MSG_RELIABILITY
```
@Deprecated
public static final String[] MSG_RELIABILITY
```
    Deprecated. (2.4.0) Replaced by MSG_CONFIDENCE. Use of reliability has been deprecated in favour of using confidence.
  - MSG_CONFIDENCE
```
public static final String[] MSG_CONFIDENCE
```
- Constructor Detail
  - Alert
```
public Alert(int pluginId)
```
  - Alert
```
public Alert(int pluginId,
             int risk,
             int confidence,
             String name)
```
  - Alert
```
public Alert(RecordAlert recordAlert)
```
  - Alert
```
public Alert(RecordAlert recordAlert,
             HistoryReference ref)
```
- Method Detail
  - setRiskReliability
```
@Deprecated
public void setRiskReliability(int risk,
                                           int confidence)
```
    Deprecated. (2.4.0) Replaced by setRiskConfidence(int, int). Use of reliability has been deprecated in favour of using confidence
    
    Parameters:
    
    risk - the new risk
    
    confidence - the new confidence
  - setRiskConfidence
```
public void setRiskConfidence(int risk,
                              int confidence)
```
  - setRisk
```
public void setRisk(int risk)
```
    Sets the risk of the alert.
    
    Parameters:
    
    risk - the new risk.
    
    Since:
    
    2.9.0
  - setConfidence
```
public void setConfidence(int confidence)
```
    Sets the confidence of the alert.
    
    Parameters:
    
    confidence - the new confidence.
    
    Since:
    
    2.9.0
  - setAlert
```
@Deprecated
public void setAlert(String alert)
```
    Deprecated. (2.5.0) Replaced by setName(java.lang.String). Use of alert has been deprecated in favour of using name.
    
    Parameters:
    
    alert - the new name
  - setName
```
public void setName(String name)
```
    Sets the name of the alert to name
    
    Parameters:
    
    name - the name to set for the alert
    
    Since:
    
    2.5.0
  - setDetail
```
@Deprecated
public void setDetail(String description,
                                  String uri,
                                  String param,
                                  String attack,
                                  String otherInfo,
                                  String solution,
                                  String reference,
                                  HttpMessage msg)
```
    Deprecated. (2.2.0) Replaced by setDetail(String, String, String, String, String, String, String, String, int, int, HttpMessage). It will be removed in a future release.
    
    Sets the details of the alert.
    
    Parameters:
    
    description - the description of the alert
    
    uri - the URI that has the issue
    
    param - the parameter that has the issue
    
    attack - the attack that triggers the issue
    
    otherInfo - other information about the issue
    
    solution - the solution for the issue
    
    reference - references about the issue
    
    msg - the HTTP message that triggers/triggered the issue
    
    See Also:
    
    Alert.Builder
  - setDetail
```
public void setDetail(String description,
                      String uri,
                      String param,
                      String attack,
                      String otherInfo,
                      String solution,
                      String reference,
                      String evidence,
                      int cweId,
                      int wascId,
                      HttpMessage msg)
```
    Sets the details of the alert.
    
    Parameters:
    
    description - the description of the alert
    
    uri - the URI that has the issue
    
    param - the parameter that has the issue
    
    attack - the attack that triggers the issue
    
    otherInfo - other information about the issue
    
    solution - the solution for the issue
    
    reference - references about the issue
    
    evidence - the evidence (in the HTTP response) that the issue exists
    
    cweId - the CWE ID of the issue
    
    wascId - the WASC ID of the issue
    
    msg - the HTTP message that triggers/triggered the issue
    
    Since:
    
    2.2.0
    
    See Also:
    
    Alert.Builder
  - setUri
```
public void setUri(String uri)
```
  - setDescription
```
public void setDescription(String description)
```
  - setParam
```
public void setParam(String param)
```
  - setOtherInfo
```
public void setOtherInfo(String otherInfo)
```
  - setSolution
```
public void setSolution(String solution)
```
  - setReference
```
public void setReference(String reference)
```
  - setMessage
```
public void setMessage(HttpMessage message)
```
  - compareTo
```
public int compareTo(Alert alert2)
```
    Specified by:
    
    compareTo in interface Comparable<Alert>
  - equals
```
public boolean equals(Object obj)
```
    Override equals. Alerts are equal if the plugin id, alert, other info, uri and param is the same.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - newInstance
```
public Alert newInstance()
```
    Creates a new instance of Alert with same members.
    
    Returns:
    
    a new Alert instance
  - toPluginXML
```
public String toPluginXML(String urls)
```
  - replaceEntity
```
public String replaceEntity(String text)
```
  - paragraph
```
public String paragraph(String text)
```
  - getAlert
```
@Deprecated
public String getAlert()
```
    Deprecated. (2.5.0) Replaced by getName(). Use of alert has been deprecated in favour of using name.
    
    Returns:
    
    Returns the alert.
  - getName
```
public String getName()
```
    Returns:
    
    Returns the name of the alert.
    
    Since:
    
    2.5.0
  - getDescription
```
public String getDescription()
```
    Returns:
    
    Returns the description.
  - getPluginId
```
public int getPluginId()
```
    Returns:
    
    Returns the id.
  - getMessage
```
public HttpMessage getMessage()
```
    Returns:
    
    Returns the message.
  - getOtherInfo
```
public String getOtherInfo()
```
    Returns:
    
    Returns the otherInfo.
  - getParam
```
public String getParam()
```
    Returns:
    
    Returns the param.
  - getReference
```
public String getReference()
```
    Returns:
    
    Returns the reference.
  - getReliability
```
@Deprecated
public int getReliability()
```
    Deprecated. (2.4.0) Replaced by getConfidence().
    
    Returns:
    
    the reliability.
  - getConfidence
```
public int getConfidence()
```
    Returns:
    
    Returns the confidence.
  - getRisk
```
public int getRisk()
```
    Returns:
    
    Returns the risk.
  - getIcon
```
public ImageIcon getIcon()
```
    Gets the correctly scaled icon for this alert.
    
    Returns:
    
    the correctly scaled icon for this alert
    
    Since:
    
    2.6.0
  - getIconUrl
```
@Deprecated
public URL getIconUrl()
```
    Deprecated.
  - getSolution
```
public String getSolution()
```
    Returns:
    
    Returns the solution.
  - getUri
```
public String getUri()
```
    Returns:
    
    Returns the uri.
  - getAlertId
```
public int getAlertId()
```
    Returns:
    
    Returns the alertId.
  - setAlertId
```
public void setAlertId(int alertId)
```
    Parameters:
    
    alertId - The alertId to set.
  - getUrlParamXML
```
public String getUrlParamXML()
```
  - getSourceHistoryId
```
public int getSourceHistoryId()
```
  - setSourceHistoryId
```
public void setSourceHistoryId(int sourceHistoryId)
```
  - getHistoryRef
```
public HistoryReference getHistoryRef()
```
  - setHistoryRef
```
public void setHistoryRef(HistoryReference historyRef)
```
  - getAttack
```
public String getAttack()
```
  - setAttack
```
public void setAttack(String attack)
```
  - getMethod
```
public String getMethod()
```
  - getPostData
```
public String getPostData()
```
  - getMsgUri
```
public org.apache.commons.httpclient.URI getMsgUri()
```
  - getEvidence
```
public String getEvidence()
```
  - setEvidence
```
public void setEvidence(String evidence)
```
  - getCweId
```
public int getCweId()
```
  - setCweId
```
public void setCweId(int cweId)
```
  - getWascId
```
public int getWascId()
```
  - setWascId
```
public void setWascId(int wascId)
```
  - getSource
```
public Alert.Source getSource()
```
    Gets the source of the alert.
    
    Returns:
    
    the source of the alert, never null.
    
    Since:
    
    2.6.0
  - setSource
```
public void setSource(Alert.Source source)
```
    Sets the source of the alert.
    Note: The source should be considered immutable and should be set before the alert is persisted (normally by the tool/functionality raising the alert).
    
    Parameters:
    
    source - the source of the alert.
    
    Throws:
    
    IllegalArgumentException - if the given source is null.
    
    Since:
    
    2.6.0
  - getAlertRef
```
public String getAlertRef()
```
    Gets the alert reference.
    This is a unique identifier for the type of alert raised. A scan rule may raise more that one type of alert and they should all have different alert references.
    
    Returns:
    
    the alert reference
    
    Since:
    
    2.10.0
  - setAlertRef
```
public void setAlertRef(String alertRef)
```
    Sets the alert reference.
    For manually raised alerts this should be an empty string. For alerts raised by scan rules it should start with the rule plugin id and optionally include a 'qualifier' (such as "-1", "-2" etc). Logically different alerts should have different alert references even if they are raised by the same scan rule.
    
    Parameters:
    
    alertRef - the alert reference
    
    Since:
    
    2.10.0
  - builder
```
public static Alert.Builder builder()
```
    Returns a new alert builder.
    
    Returns:
    
    the alert builder.
    
    Since:
    
    2.9.0
  - isValidRisk
```
public static boolean isValidRisk(int risk)
```
    Checks if a value int is between 0 (RISK_INFO) and 3 (RISK_HIGH)
    
    Returns:
    
    true if the checked risk (int) is in the range, false otherwise
    
    Since:
    
    2.9.0
    
    See Also:
    
    RISK_INFO, RISK_HIGH
  - isValidConfidence
```
public static boolean isValidConfidence(int confidence)
```
    Checks if a value int is between 0 (CONFIDENCE_FALSE_POSITIVE) and 4 (CONFIDENCE_USER_CONFIRMED)
    
    Returns:
    
    true if the checked confidence (int) is in the range, false otherwise
    
    Since:
    
    2.9.0
    
    See Also:
    
    CONFIDENCE_FALSE_POSITIVE, CONFIDENCE_USER_CONFIRMED

Class Alert

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RISK_INFO

RISK_LOW

RISK_MEDIUM

RISK_HIGH

CONFIDENCE_FALSE_POSITIVE

SUSPICIOUS

CONFIDENCE_LOW

WARNING

CONFIDENCE_MEDIUM

CONFIDENCE_HIGH

CONFIDENCE_USER_CONFIRMED

MSG_RISK

MSG_RELIABILITY

MSG_CONFIDENCE

Constructor Detail

Alert

Alert

Alert

Alert

Method Detail

setRiskReliability

setRiskConfidence

setRisk

setConfidence

setAlert

setName

setDetail

setDetail

setUri

setDescription

setParam

setOtherInfo

setSolution

setReference

setMessage

compareTo

equals

hashCode

newInstance

toPluginXML

replaceEntity

paragraph

getAlert

getName

getDescription

getPluginId

getMessage

getOtherInfo

getParam

getReference

getReliability

getConfidence

getRisk

getIcon

getIconUrl

getSolution

getUri

getAlertId

setAlertId

getUrlParamXML

getSourceHistoryId

setSourceHistoryId

getHistoryRef

setHistoryRef

getAttack

setAttack

getMethod

getPostData

getMsgUri

getEvidence

setEvidence

getCweId

setCweId