Class AlertSet

zap/src/main/java/org/zaproxy/zap/extension/alert/AlertSet.java:36–200

A collection of Alerts with unique alertIds. @since 2.17.0

 * @since 2.17.0
 */
public class AlertSet {

    private Map<Integer, Alert> map = new ConcurrentHashMap<>();
    private Alert highestRisk;

    public AlertSet() {}

    /**
     * Add the specified alert to the set.
     *
     * @param alert the alert
     * @return true if the alert was not already in the set.
     */
    public synchronized boolean add(Alert alert) {
        boolean added = map.put(alert.getAlertId(), alert) == null;
        highestRisk = getHighestRisk(highestRisk, alert);
        return added;
    }

    /**
     * Adds all of the specified alerts to the set.
     *
     * @param alerts the alerts
     * @return true if one or more of the alerts were not already in the set.
     */
    public boolean addAll(List<Alert> alerts) {
        AtomicBoolean changed = new AtomicBoolean(false);
        alerts.forEach(
                a -> {
                    if (add(a)) {
                        changed.set(true);
                    }
                });
        return changed.get();
    }

    /**
     * Removes the specified alert using the alertId.
     *
     * @param alert the alert to remove
     * @return true if the alert was removed
     */
    public synchronized boolean remove(Alert alert) {
        Alert a = map.remove(alert.getAlertId());
        if (a != null) {
            if (highestRisk != null && a.getAlertId() == highestRisk.getAlertId()) {
                calculateHighestRisk();
            }
            return true;
        }
        return false;
    }

    /**
     * Removes all of the specified alerts.
     *
     * @param alerts the alerts to remove
     * @return true if one or more of the alerts were removed.