org.jppf.client.JPPFClientConnection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jppf-client Show documentation
JPPF, the open source grid computing solution
The newest version!
/*
 * JPPF.
 * Copyright (C) 2005-2019 JPPF Team.
 * http://www.jppf.org
 *
 * Licensed 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.jppf.client;

import org.jppf.client.event.ClientConnectionStatusHandler;
import org.jppf.management.JPPFSystemInformation;

/**
 * Interface for a client connection to a JPPF driver.
 * @author Laurent Cohen
 */
public interface JPPFClientConnection extends ClientConnectionStatusHandler, AutoCloseable {
  /**
   * Get the priority assigned to this connection.
   * @return a priority as an int value.
   */
  int getPriority();

  /**
   * Shutdown this connection and release all the resources it is using.
   */
  @Override
  void close();

  /**
   * Determine whether this connection was closed.
   * @return true if the connection is closed, false otherwise.
   */
  boolean isClosed();

  /**
   * Get the name assigned to this client connection.
   * @return the name as a string.
   */
  String getName();

  /**
   * Determines if this connection is over SSL.
   * @return true if this is an SSL connection, false otherwise.
   */
  boolean isSSLEnabled();

  /**
   * Get the driver's host name or ip address.
   * @return the host as a stirng.
   */
  String getHost();

  /**
   * Get the port number on which the dirver is listeneing for connections.
   * @return the port number as an int.
   */
  int getPort();

  /**
   * Get the unique identifier of the remote driver.
   * @return the uuid as a string.
   */
  String getDriverUuid();

  /**
   * Get the system information for the remote driver this connection refers to.
   * @return a {@link JPPFSystemInformation} instance.
   */
  JPPFSystemInformation getSystemInfo();

  /**
   * Get the unique ID for this connection and its two channels.
   * @return the id as a string.
   */
  String getConnectionUuid();

  /**
   * Get the pool this connection belongs to.
   * @return a {@link JPPFConnectionPool} instance.
   */
  JPPFConnectionPool getConnectionPool();

  /**
   * Determine whether this connection is local, that is, whether it executes jobs in the local JVM.
   * @return {@code true} if this connection is local, {@code false} otherwise.
   */
  default boolean isLocal() {
    return false;
  }
}