/*
 * 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.stream.storage.api.sc;

import io.grpc.ServerServiceDefinition;
import java.util.Collection;
import java.util.concurrent.CompletableFuture;

/**
 * Represents the service running within a container.
 *
 * <p>The implementation implements their core business logic and the framework provides resources like tables/streams
 * for it.
 */
public interface StorageContainerService {

    /**
     * Return the registered grpc services.
     *
     * <p>The framework registers the grpc services in the container runtime. So the framework will know how to route
     * the grpc requests to the actual grpc services.
     * @return
     */
    Collection<ServerServiceDefinition> getRegisteredServices();

    /**
     * Start the storage container service.
     *
     * @return a future represents the result of starting a storage container service.
     */
    CompletableFuture<Void> start();

    /**
     * Stop the storage container service.
     *
     * @return a future represents the result of stopping a storage container service.
     */
    CompletableFuture<Void> stop();

}
