001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.client;
019
020import java.util.Iterator;
021import java.util.List;
022import java.util.Optional;
023import org.apache.hadoop.hbase.HRegionLocation;
024import org.apache.hadoop.hbase.ServerName;
025import org.apache.yetus.audience.InterfaceAudience;
026
027/**
028 * Define the necessary method for carrying {@code ClientMetaService}.
029 */
030@InterfaceAudience.Private
031public interface ConnectionRegistryEndpoint {
032
033  /**
034   * Get cluster id.
035   */
036  String getClusterId();
037
038  /**
039   * Get active master address.
040   */
041  Optional<ServerName> getActiveMaster();
042
043  /**
044   * Get backup masters address.
045   */
046  List<ServerName> getBackupMasters();
047
048  /**
049   * Get a iterator of the available bootstrap nodes.
050   */
051  Iterator<ServerName> getBootstrapNodes();
052
053  /**
054   * Get the location of meta regions.
055   */
056  List<HRegionLocation> getMetaLocations();
057}