com.couchbase.client.core.config.GlobalConfig Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of core-io Show documentation
The official Couchbase JVM Core IO Library
There is a newer version: 2.7.0
/*
 * Copyright (c) 2019 Couchbase, Inc.
 *
 * 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.
 */

package com.couchbase.client.core.config;

import com.couchbase.client.core.deps.com.fasterxml.jackson.annotation.JacksonInject;
import com.couchbase.client.core.deps.com.fasterxml.jackson.annotation.JsonCreator;
import com.couchbase.client.core.deps.com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.couchbase.client.core.deps.com.fasterxml.jackson.annotation.JsonProperty;
import com.couchbase.client.core.service.ServiceType;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * The {@link GlobalConfig} represents a configuration which is not tied to a bucket.
 *
 * This type of config has been introduced in couchbase server 6.5 (and forward) and allows cluster-level
 * operations without having a bucket open (and as a result fetch a bucket config). It only contains a subset
 * of what can be found in a bucket config, since it contains only what necessary to locate cluster-level
 * features and capabilities.
 */
@JsonIgnoreProperties(ignoreUnknown = true)
public class GlobalConfig {

  private final long rev;
  private final long revEpoch;
  private final List portInfos;
  private final Map> clusterCapabilities;

  @JsonCreator
  public GlobalConfig(
    @JsonProperty("rev") long rev,
    @JsonProperty("revEpoch") long revEpoch,
    @JsonProperty("nodesExt") List portInfos,
    @JsonProperty("clusterCapabilities") Map> clusterCapabilities,
    @JacksonInject("origin") String origin
  ) {
    this.rev = rev;
    this.revEpoch = revEpoch;
    this.portInfos = enrichPortInfos(portInfos, origin);
    this.clusterCapabilities = AbstractBucketConfig.convertClusterCapabilities(clusterCapabilities);
  }


  /**
   * Helper method to enrich the port infos with a synthetic origin host if not present.
   *
   * In a single node cluster or if the node does not include the hostname, this method enriches the port config
   * with the hostname it got the config from. This will make sure we can still bootstrap and assemble it as a valid
   * configuration.
   *
   * @param portInfos the original port infos.
   * @param origin the origin hostname.
   * @return the modified port infos to store and use.
   */
  private List enrichPortInfos(final List portInfos, final String origin) {
    List enriched = new ArrayList<>(portInfos.size());
    for (PortInfo portInfo : portInfos) {
      if (portInfo.hostname() == null) {
        enriched.add(new PortInfo(portInfo.ports(), portInfo.sslPorts(), portInfo.alternateAddresses(), origin));
      } else {
        enriched.add(portInfo);
      }
    }
    return enriched;
  }

  /**
   * The revision id of this global config.
   */
  public long rev() {
    return rev;
  }

  /**
   * The epoch of the revision, 0 if not set on the config.
   */
  public long revEpoch() {
    return revEpoch;
  }

  /**
   * All global cluster capabilities.
   */
  public Map> clusterCapabilities() {
    return clusterCapabilities;
  }

  /**
   * The node/port infos for each node in the list.
   */
  public List portInfos() {
    return portInfos;
  }

  @Override
  public String toString() {
    return "GlobalConfig{" +
      "rev=" + rev +
      ", revEpoch=" + revEpoch +
      ", portInfos=" + portInfos +
      ", clusterCapabilities=" + clusterCapabilities +
      '}';
  }
}