org.cyclonedx.model.Licensing Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cyclonedx-core-java Show documentation
The CycloneDX core module provides a model representation of the BOM along with utilities to assist in creating, parsing, and validating BOMs.
There is a newer version: 9.0.5
Show newest version
/*
 * This file is part of CycloneDX Core (Java).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * Copyright (c) OWASP Foundation. All Rights Reserved.
 */
package org.cyclonedx.model;

import java.util.Date;
import java.util.List;
import java.util.Objects;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonRootName;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
import org.cyclonedx.util.deserializer.LicensingTypeDeserializer;
import org.cyclonedx.util.deserializer.OrganizationalChoiceDeserializer;
import org.cyclonedx.util.deserializer.StringListDeserializer;
import org.cyclonedx.util.serializer.CustomDateSerializer;

@JsonIgnoreProperties(ignoreUnknown = true)
@JsonInclude(JsonInclude.Include.NON_EMPTY)
@JsonPropertyOrder({"altIds", "licensor", "licensee", "purchaser", "purchaseOrder", "licenseTypes", "lastRenewal", "expiration"})
@JsonRootName("licensing")
public class Licensing extends ExtensibleElement
{
  public enum LicensingType
  {
    @JsonProperty("academic")
    ACADEMIC("academic"),
    @JsonProperty("appliance")
    APPLIANCE("appliance"),
    @JsonProperty("client-access")
    CLIENT_ACCESS("client-access"),
    @JsonProperty("concurrent-user")
    CONCURRENT_USER("concurrent-user"),
    @JsonProperty("core-points")
    CORE_POINTS("core-points"),
    @JsonProperty("custom-metric")
    CUSTOM_METRIC("custom-metric"),
    @JsonProperty("device")
    DEVICE("device"),
    @JsonProperty("evaluation")
    EVALUATION("evaluation"),
    @JsonProperty("named-user")
    NAMED_USER("named-user"),
    @JsonProperty("node-locked")
    NODE_LOCKED("node-locked"),
    @JsonProperty("oem")
    OEM("oem"),
    @JsonProperty("perpetual")
    PERPETUAL("perpetual"),
    @JsonProperty("processor-points")
    PROCESSOR_POINTS("processor-points"),
    @JsonProperty("subscription")
    SUBSCRIPTION("subscription"),
    @JsonProperty("user")
    USER("user"),
    @JsonProperty("other")
    OTHER("other");

    private final String name;

    public String getLicensingType() {
      return this.name;
    }

    LicensingType(String name) {
      this.name = name;
    }

    @JsonCreator
    public static LicensingType fromString(String value) {
      for (LicensingType type : LicensingType.values()) {
        if (type.name.equalsIgnoreCase(value)) {
          return type;
        }
      }
      throw new IllegalArgumentException("Invalid licensing type: " + value);
    }
  }

  private List altIds;

  @JsonDeserialize(using = OrganizationalChoiceDeserializer.class)
  private OrganizationalChoice licensor;

  @JsonDeserialize(using = OrganizationalChoiceDeserializer.class)
  private OrganizationalChoice licensee;

  @JsonDeserialize(using = OrganizationalChoiceDeserializer.class)
  private OrganizationalChoice purchaser;

  private String purchaseOrder;

  @JacksonXmlElementWrapper(localName = "licenseTypes")
  @JacksonXmlProperty(localName = "licenseType")
  @JsonDeserialize(using = LicensingTypeDeserializer.class)
  private List licenseTypes;

  @JsonSerialize(using = CustomDateSerializer.class)
  private Date lastRenewal;

  @JsonSerialize(using = CustomDateSerializer.class)
  private Date expiration;

  @JacksonXmlElementWrapper(localName = "altIds")
  @JacksonXmlProperty(localName = "altId")
  @JsonDeserialize(using = StringListDeserializer.class)
  public List getAltIds() {
    return altIds;
  }

  public void setAltIds(final List altIds) {
    this.altIds = altIds;
  }

  @JacksonXmlProperty(localName = "licensor")
  @JsonProperty("licensor")
  public OrganizationalChoice getLicensor() {
    return licensor;
  }

  public void setLicensor(final OrganizationalChoice licensor) {
    this.licensor = licensor;
  }

  @JacksonXmlProperty(localName = "licensee")
  @JsonProperty("licensee")
  public OrganizationalChoice getLicensee() {
    return licensee;
  }

  public void setLicensee(final OrganizationalChoice licensee) {
    this.licensee = licensee;
  }

  @JacksonXmlProperty(localName = "purchaser")
  @JsonProperty("purchaser")
  public OrganizationalChoice getPurchaser() {
    return purchaser;
  }

  public void setPurchaser(final OrganizationalChoice purchaser) {
    this.purchaser = purchaser;
  }

  public String getPurchaseOrder() {
    return purchaseOrder;
  }

  public void setPurchaseOrder(final String purchaseOrder) {
    this.purchaseOrder = purchaseOrder;
  }

  public List getLicenseTypes() {
    return licenseTypes;
  }

  public void setLicenseTypes(final List licenseTypes) {
    this.licenseTypes = licenseTypes;
  }

  public Date getLastRenewal() {
    return lastRenewal;
  }

  public void setLastRenewal(final Date lastRenewal) {
    this.lastRenewal = lastRenewal;
  }

  public Date getExpiration() {
    return expiration;
  }

  public void setExpiration(final Date expiration) {
    this.expiration = expiration;
  }

  @Override
  public boolean equals(final Object o) {
    if (this == o) {
      return true;
    }
    if (!(o instanceof Licensing)) {
      return false;
    }
    Licensing licensing = (Licensing) o;
    return Objects.equals(altIds, licensing.altIds) && Objects.equals(licensor, licensing.licensor) &&
        Objects.equals(licensee, licensing.licensee) &&
        Objects.equals(purchaser, licensing.purchaser) &&
        Objects.equals(purchaseOrder, licensing.purchaseOrder) &&
        Objects.equals(licenseTypes, licensing.licenseTypes) &&
        Objects.equals(lastRenewal, licensing.lastRenewal) &&
        Objects.equals(expiration, licensing.expiration);
  }

  @Override
  public int hashCode() {
    return Objects.hash(altIds, licensor, licensee, purchaser, purchaseOrder, licenseTypes, lastRenewal, expiration);
  }
}