Package com.iizix.comm

Interface IPortController

public interface IPortController
Interface implemented by a Jetty ServerConnector for a port in order to control it from the server administration.
Author:
Christopher Mindus

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    IPortController.State
    The state enumeration of the connector.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    close(boolean doPerform)
    Closes the connector.
    void
    dispose()
    Disposes of the port when it has been removed from the server configuration.
    PortConfig
    getConfiguration()
    The port configuration.
    IPortController.State
    getState()
    Returns the state of the connector.
    String
    open(boolean doPerform)
    Opens the connector.
    void
    restart()
    Restarts the port after server certificate KeyStore update.
    String
    start(boolean doPerform)
    Starts the port.
    String
    stop(boolean doPerform)
    Stops the port.

  • Method Details

    • getConfiguration

      PortConfig getConfiguration()
      The port configuration.
      Returns:
      The port config instance.

    • getState

      IPortController.State getState()
      Returns the state of the connector.

    • start

      String start(boolean doPerform)
      Starts the port.
      Parameters:
      doPerform - Flag indicating action should be performed (true) or just testing (false).
      Returns:
      null for success, otherwise an error the admin-human readable error.

    • open

      String open(boolean doPerform)
      Opens the connector.
      Parameters:
      doPerform - Flag indicating action should be performed (true) or just testing (false).
      Returns:
      null for success, otherwise an error the admin-human readable error.

    • close

      String close(boolean doPerform)
      Closes the connector.
      Parameters:
      doPerform - Flag indicating action should be performed (true) or just testing (false).
      Returns:
      null for success, otherwise an error the admin-human readable error.

    • restart

      void restart()
      Restarts the port after server certificate KeyStore update.

    • stop

      String stop(boolean doPerform)
      Stops the port.
      Parameters:
      doPerform - Flag indicating action should be performed (true) or just testing (false).
      Returns:
      null for success, otherwise an error the admin-human readable error.

    • dispose

      void dispose()
      Disposes of the port when it has been removed from the server configuration.