alluxio.Server Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alluxio-core-common Show documentation

Common utilities shared in Alluxio core modules

There is a newer version: 313

/*
 * The Alluxio Open Foundation licenses this work under the Apache License, version 2.0
 * (the "License"). You may not use this work except in compliance with the License, which is
 * available at www.apache.org/licenses/LICENSE-2.0
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied, as more fully set forth in the License.
 *
 * See the NOTICE file distributed with this work for information regarding copyright ownership.
 */

package alluxio;

import alluxio.grpc.GrpcService;
import alluxio.grpc.ServiceType;

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

/**
 * Interface representing an Alluxio server.
 *
 * @param  type of the start options
 */
public interface Server {

  /**
   * @return the server dependencies
   */
  Set> getDependencies();

  /**
   * @return the server's name
   */
  String getName();

  /**
   * @return a map from service names to gRPC serviced that serve RPCs for this server
   */
  Map getServices();

  /**
   * Starts the Alluxio server.
   *
   * @param options the start options
   */
  void start(T options) throws IOException;

  /**
   * Stops the Alluxio server. Here, anything created or started in {@link #start(T)} should be
   * cleaned up and shutdown.
   */
  void stop() throws IOException;

  /**
   * Closes the server.
   */
  void close() throws IOException;
}