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 TypeInterfaceDescription
      static class IPortController.State
      The state enumeration of the connector.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      java.lang.Stringclose​(boolean doPerform)
      Closes the connector.
      voiddispose()
      Disposes of the port when it has been removed from the server configuration.
      PortConfiggetConfiguration()
      The port configuration.
      IPortController.StategetState()
      Returns the state of the connector.
      java.lang.Stringopen​(boolean doPerform)
      Opens the connector.
      voidrestart()
      Restarts the port after server certificate KeyStore update.
      java.lang.Stringstart​(boolean doPerform)
      Starts the port.
      java.lang.Stringstop​(boolean doPerform)
      Stops the port.

    • Method Detail

      • getConfiguration

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

      • start

        java.lang.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

        java.lang.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

        java.lang.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

        java.lang.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.