com.vmware.ovsdb.protocol.schema.DatabaseSchema Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ovsdb-client Show documentation
The newest version!
/*
 * Copyright (c) 2018 VMware, Inc. All Rights Reserved.
 *
 * This product is licensed to you under the BSD-2 license (the "License").
 * You may not use this product except in compliance with the BSD-2 License.
 *
 * This product may include a number of subcomponents with separate copyright
 * notices and license terms. Your use of these subcomponents is subject to the
 * terms and conditions of the subcomponent's license, as noted in the LICENSE
 * file.
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

package com.vmware.ovsdb.protocol.schema;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;

import java.util.Map;
import java.util.Objects;

/**
 * Representation of {@literal }.
 *
 *  * {@literal
 * 
 *   A JSON object with the following members:
 *
 *       "name":                             required
 *       "version":                     required
 *       "cksum":                        optional
 *       "tables": {: , ...}   required
 *
 *   The "name" identifies the database as a whole.  It must be
 *   provided to most JSON-RPC requests to identify the database being
 *   operated on.
 *
 *   The "version" reports the version of the database schema.  It is
 *   REQUIRED to be present.  Open vSwitch semantics for "version" are
 *   described in [DB-SCHEMA].  Other schemas may use it differently.
 *
 *   The "cksum" optionally reports an implementation-defined checksum
 *   for the database schema.  Its use is primarily as a tool for
 *   schema developers, and clients SHOULD ignore it.
 *
 *   The value of "tables" is a JSON object whose names are table names
 *   and whose values are s.
 * }
 * 
 */
public class DatabaseSchema {

  private final String name;

  private final String version;

  @JsonInclude(JsonInclude.Include.NON_NULL)
  private final String cksum;

  private final Map tables;

  /**
   * Create a {@link DatabaseSchema} object.
   *
   * @param name value of the "name" field
   * @param version value of the "version" field
   * @param cksum value of the "cksum" field
   * @param tables value of the "tables" field
   */
  @JsonCreator
  public DatabaseSchema(
      @JsonProperty(value = "name", required = true) String name,
      @JsonProperty(value = "version", required = true) String version,
      @JsonProperty(value = "cksum") String cksum,
      @JsonProperty(value = "tables", required = true) Map tables
  ) {
    this.name = name;
    this.version = version;
    this.cksum = cksum;
    this.tables = tables;
  }

  public String getName() {
    return name;
  }

  public String getVersion() {
    return version;
  }

  public String getCksum() {
    return cksum;
  }

  public Map getTables() {
    return tables;
  }

  @Override
  public boolean equals(Object other) {
    if (this == other) {
      return true;
    }
    if (!(other instanceof DatabaseSchema)) {
      return false;
    }
    DatabaseSchema that = (DatabaseSchema) other;
    return Objects.equals(name, that.getName())
        && Objects.equals(version, that.getVersion())
        && Objects.equals(cksum, that.getCksum())
        && Objects.equals(tables, that.getTables());
  }

  @Override
  public int hashCode() {
    return Objects.hash(name, version, cksum, tables);
  }

  @Override
  public String toString() {
    return getClass().getSimpleName() + " ["
        + "name=" + name
        + ", version=" + version
        + ", cksum=" + cksum
        + ", tables=" + tables
        + "]";
  }
}