hadoop-hdfs-project/hadoop-hdfs-rbf/src/main/java/org/apache/hadoop/hdfs/server/federation/store/protocol/GetNamespaceInfoResponse.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.hadoop.hdfs.server.federation.store.protocol;

import java.io.IOException;
import java.util.Set;

import org.apache.hadoop.classification.InterfaceAudience.Public;
import org.apache.hadoop.classification.InterfaceStability.Unstable;
import org.apache.hadoop.hdfs.server.federation.resolver.FederationNamespaceInfo;
import org.apache.hadoop.hdfs.server.federation.store.driver.StateStoreSerializer;

/**
 * API response for listing HDFS namespaces present in the state store.
 */
public abstract class GetNamespaceInfoResponse {

  public static GetNamespaceInfoResponse newInstance() {
    return StateStoreSerializer.newRecord(GetNamespaceInfoResponse.class);
  }

  public static GetNamespaceInfoResponse newInstance(
      Set<FederationNamespaceInfo> namespaces) throws IOException {
    GetNamespaceInfoResponse response = newInstance();
    response.setNamespaceInfo(namespaces);
    return response;
  }

  @Public
  @Unstable
  public abstract Set<FederationNamespaceInfo> getNamespaceInfo();

  @Public
  @Unstable
  public abstract void setNamespaceInfo(
      Set<FederationNamespaceInfo> namespaceInfo);
}