Class AbstractNetworkConnector

    • Method Detail

      • setHost

        public void setHost​(java.lang.String host)
      • getHost

        @ManagedAttribute("The network interface this connector binds to as an IP address or a hostname.  If null or 0.0.0.0, then bind to all interfaces.")
        public java.lang.String getHost()
        Specified by:
        getHost in interface NetworkConnector
        Returns:
        The hostname representing the interface to which this connector will bind, or null for all interfaces.
      • setPort

        public void setPort​(int port)
      • getPort

        @ManagedAttribute("Port this connector listens on. If set the 0 a random port is assigned which may be obtained with getLocalPort()")
        public int getPort()
        Specified by:
        getPort in interface NetworkConnector
        Returns:
        The configured port for the connector or 0 if any available port may be used.
      • getLocalPort

        public int getLocalPort()
        Specified by:
        getLocalPort in interface NetworkConnector
        Returns:
        The actual port the connector is listening on, or -1 if it has not been opened, or -2 if it has been closed.
      • doStart

        protected void doStart()
                        throws java.lang.Exception
        Description copied from class: ContainerLifeCycle
        Starts the managed lifecycle beans in the order they were added.
        Overrides:
        doStart in class AbstractConnector
        Throws:
        AbstractLifeCycle.StopException - If thrown, the lifecycle will immediately be stopped.
        java.lang.Exception - If there was a problem starting. Will cause a transition to FAILED state
      • doStop

        protected void doStop()
                       throws java.lang.Exception
        Description copied from class: ContainerLifeCycle
        Stops the managed lifecycle beans in the reverse order they were added.
        Overrides:
        doStop in class AbstractConnector
        Throws:
        java.lang.Exception - If there was a problem stopping. Will cause a transition to FAILED state
      • open

        public void open()
                  throws java.io.IOException
        Description copied from interface: NetworkConnector

        Performs the activities needed to open the network communication (for example, to start accepting incoming network connections).

        Specified by:
        open in interface NetworkConnector
        Throws:
        java.io.IOException - if this connector cannot be opened
        See Also:
        NetworkConnector.close()
      • close

        public void close()
        Description copied from interface: NetworkConnector

        Performs the activities needed to close the network communication (for example, to stop accepting network connections).

        Once a connector has been closed, it cannot be opened again without first calling LifeCycle.stop() and it will not be active again until a subsequent call to LifeCycle.start()
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Specified by:
        close in interface NetworkConnector
      • shutdown

        public java.util.concurrent.CompletableFuture<java.lang.Void> shutdown()
        Description copied from interface: Graceful
        Shutdown the component. When this method returns, the component should not accept any new load.
        Specified by:
        shutdown in interface Graceful
        Overrides:
        shutdown in class AbstractConnector
        Returns:
        A future that is completed once all load on the component is completed