ComponentReportVulnerability.java

/*
 * Copyright (c) 2018-present Sonatype, Inc. All rights reserved.
 *
 * This program is licensed to you under the Apache License Version 2.0,
 * and you may not use this file except in compliance with the Apache License Version 2.0.
 * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the Apache License Version 2.0 is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
 */
package org.sonatype.ossindex.service.api.componentreport;

import java.io.Serializable;
import java.net.URI;
import java.util.List;
import java.util.Objects;

import javax.annotation.Nullable;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.base.MoreObjects;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

/**
 * {@link ComponentReport} vulnerability details.
 *
 * @since 1.0.0
 */
@ApiModel(description = "Component vulnerability")
@XmlAccessorType(XmlAccessType.FIELD)
public class ComponentReportVulnerability
    implements Serializable
{
  private static final long serialVersionUID = 3L;

  @ApiModelProperty("Public identifier")
  @JsonProperty
  @XmlElement
  private String id;

  /**
   * @since 1.5.0
   */
  @ApiModelProperty("Display name")
  @JsonProperty
  @XmlElement
  private String displayName;

  @ApiModelProperty("Vulnerability title")
  @JsonProperty
  @XmlElement
  private String title;

  @ApiModelProperty("Vulnerability description")
  @JsonProperty
  @XmlElement
  private String description;

  @ApiModelProperty("CVSS score")
  @JsonProperty
  @XmlElement
  private Float cvssScore;

  @ApiModelProperty("CVSS vector")
  @JsonProperty
  @XmlElement
  private String cvssVector;

  @ApiModelProperty("CWE")
  @JsonProperty
  @XmlElement
  private String cwe;

  /**
   * @since 1.0.3
   */
  @ApiModelProperty("CVE")
  @JsonProperty
  @XmlElement
  private String cve;

  @ApiModelProperty("Vulnerability details reference")
  @JsonProperty
  @XmlElement
  private URI reference;

  /**
   * Range of versions which affects the component containing the vulnerability.
   *
   * This is only applicable when using version-less requests.
   *
   * @since 1.1.0
   */
  @ApiModelProperty("Affected version ranges")
  @JsonProperty
  @XmlElement
  @Nullable
  private List<String> versionRanges;

  /**
   * List of external references that provide additional information about the vulnerability
   *
   * @since 1.8.0
   */
  @ApiModelProperty("External references related to the vulnerability")
  @JsonProperty
  @XmlElement
  private List<URI> externalReferences;

  public String getId() {
    return id;
  }

  public void setId(String id) {
    this.id = id;
  }

  public String getDisplayName() {
    return displayName;
  }

  public void setDisplayName(final String displayName) {
    this.displayName = displayName;
  }

  public String getTitle() {
    return title;
  }

  public void setTitle(String title) {
    this.title = title;
  }

  public String getDescription() {
    return description;
  }

  public void setDescription(String description) {
    this.description = description;
  }

  // FIXME: check the actual nullability of this; maybe left over from history and could be simplified to non-nullable

  public Float getCvssScore() {
    return cvssScore;
  }

  public void setCvssScore(Float cvssScore) {
    this.cvssScore = cvssScore;
  }

  public String getCvssVector() {
    return cvssVector;
  }

  public void setCvssVector(String cvssVector) {
    this.cvssVector = cvssVector;
  }

  public String getCwe() {
    return cwe;
  }

  public void setCwe(String cwe) {
    this.cwe = cwe;
  }

  /**
   * @since 1.0.3
   */
  public String getCve() {
    return cve;
  }

  /**
   * @since 1.0.3
   */
  public void setCve(String cve) {
    this.cve = cve;
  }

  public URI getReference() {
    return reference;
  }

  public void setReference(URI reference) {
    this.reference = reference;
  }

  /**
   * @since 1.1.0
   */
  @Nullable
  public List<String> getVersionRanges() {
    return versionRanges;
  }

  /**
   * @since 1.1.0
   */
  public void setVersionRanges(@Nullable final List<String> versionRanges) {
    this.versionRanges = versionRanges;
  }

  /**
   * @since 1.8.0
   */
  public List<URI> getExternalReferences() {
    return externalReferences;
  }

  /**
   * @since 1.8.0
   */
  public void setExternalReferences(final List<URI> externalReferences) {
    this.externalReferences = externalReferences;
  }

  @Override
  public boolean equals(final Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    ComponentReportVulnerability that = (ComponentReportVulnerability) o;
    return Objects.equals(id, that.id) &&
        Objects.equals(displayName, that.displayName) &&
        Objects.equals(title, that.title) &&
        Objects.equals(description, that.description) &&
        Objects.equals(cvssScore, that.cvssScore) &&
        Objects.equals(cvssVector, that.cvssVector) &&
        Objects.equals(cwe, that.cwe) &&
        Objects.equals(cve, that.cve) &&
        Objects.equals(reference, that.reference) &&
        Objects.equals(versionRanges, that.versionRanges) &&
        Objects.equals(externalReferences, that.externalReferences);
  }

  @Override
  public int hashCode() {
    return Objects.hash(id, displayName, title, description, cvssScore, cvssVector, cwe, cve, reference, versionRanges,
        externalReferences);
  }

  @Override
  public String toString() {
    return MoreObjects.toStringHelper(this)
        .add("id", id)
        .add("title", title)
        .add("description", description)
        .toString();
  }
}