package se.entra.phantom.server;

/**
 * This interface defines the server administration exit that allows commands
 * to be performed at the server locally or remotely.
 */
public interface ServerAdminExit
{
  /**
   * Called to set-up the server administration exit.
   */
  public abstract boolean initialize(ServerAdminInterface serverAdminInterface);

  /**
   * Called to inform of a client connection change.
   */
  public abstract void clientConnectionChanged();

  /**
   * Called to perform a clean-up and dispose of the user exit.
   */
  public abstract void dispose();

  /**
   * Checks if the exit is operational.
   */
  public abstract boolean isOperational();
  
  /**
   * Gets the server admin address used (as IP address 123.456.789.012).
   *
   * @return  null  if not operational.
   */
  public abstract String getAddress();
  
  /**
   * Gets the server admin port used.
   * 
   * @return  -1  if not operational.
   */
  public abstract int getPort();
}