stream/clients/java/base/src/main/java/org/apache/bookkeeper/clients/impl/internal/api/LocationClient.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.bookkeeper.clients.impl.internal.api;

import java.util.List;
import java.util.concurrent.CompletableFuture;
import org.apache.bookkeeper.common.util.Revisioned;
import org.apache.bookkeeper.stream.proto.storage.OneStorageContainerEndpointResponse;

/**
 * A client that talks to location servers to find locations of ranges and storage containers.
 */
public interface LocationClient extends AutoCloseable {

    /**
     * Get the locations for a list of storage container ids.
     *
     * @param storageContainerIds a list of storage container ids.
     * @return list of storage container endpoints.
     */
    CompletableFuture<List<OneStorageContainerEndpointResponse>> locateStorageContainers(
        List<Revisioned<Long>> storageContainerIds);

    void close();

}