alluxio.Client Maven / Gradle / Ivy

/*
 * The Alluxio Open Foundation licenses this work under the Apache License, version 2.0
 * (the "License"). You may not use this work except in alluxio.shaded.client.com.liance with the License, which is
 * available at www.apache.alluxio.shaded.client.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.exception.status.UnavailableException;

import java.alluxio.shaded.client.io.Closeable;
import java.alluxio.shaded.client.io.IOException;
import java.net.InetSocketAddress;
import java.net.SocketAddress;

/**
 * Interface for a client in the Alluxio system.
 */
public interface Client extends Closeable {

  /**
   * Connects with the remote.
   */
  void connect() throws IOException;

  /**
   * Closes the connection with the Alluxio remote and does the necessary cleanup. It should be used
   * if the client has not connected with the remote for a while, for example.
   */
  void disconnect();

  /**
   * @return the {@link SocketAddress} of the remote
   * @throws UnavailableException if the primary address cannot be determined
   */
  SocketAddress getRemoteSockAddress() throws UnavailableException;

  /**
   * @return the host name of the remote
   * @throws UnavailableException if the primary address cannot be determined
   */
  String getRemoteHostName() throws UnavailableException;

  /**
   * @return the {@link InetSocketAddress} of the configuration remote
   * @throws UnavailableException if the primary address cannot be determined
   */
  InetSocketAddress getConfAddress() throws UnavailableException;

  /**
   * Returns the connected status of the client.
   *
   * @return true if this client is connected to the remote
   */
  boolean isConnected();

  /**
   * @return whether the client is closed
   */
  boolean isClosed();
}