Interface Server

All Superinterfaces:
AutoCloseable
public interface Server extends AutoCloseable
Contract for HTTP server implementations that are designed to be managed by a Soklet instance.

Most Soklet applications will use the default Server (constructed via the withPort(Integer) builder factory method) and therefore do not need to implement this interface directly.

For example: 

 SokletConfig config = SokletConfig.withServer(
  Server.withPort(8080).build()
).build();

try (Soklet soklet = Soklet.withConfig(config)) {
  soklet.start();
  System.out.println("Soklet started, press [enter] to exit");
  soklet.awaitShutdown(ShutdownTrigger.ENTER_KEY);
}
Author:
Mark Allen

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    Server.Builder
    Builder used to construct a standard implementation of Server.
    static interface 
    Server.RequestHandler
    Request/response processing contract for Server implementations.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    close()
    AutoCloseable-enabled synonym for stop().
    void
    initialize(SokletConfig sokletConfig, Server.RequestHandler requestHandler)
    The Soklet instance which manages this Server will invoke this method exactly once at initialization time - this allows Soklet to "talk" to your Server.
    Boolean
    isStarted()
    Is this server started (that is, able to handle requests from clients)?
    void
    start()
    Starts the server, which makes it able to accept requests from clients.
    void
    stop()
    Stops the server, which makes it unable to accept requests from clients.
    static Server.Builder
    withPort(Integer port)
    Acquires a builder for Server instances.

  • Method Details

    • start

      void start()
      Starts the server, which makes it able to accept requests from clients.

      If the server is already started, no action is taken.

      This method is designed for internal use by Soklet only and should not be invoked elsewhere.

    • stop

      void stop()
      Stops the server, which makes it unable to accept requests from clients.

      If the server is already stopped, no action is taken.

      This method is designed for internal use by Soklet only and should not be invoked elsewhere.

    • isStarted

      @Nonnull Boolean isStarted()
      Is this server started (that is, able to handle requests from clients)?
      Returns:
      true if the server is started, false otherwise

    • initialize

      void initialize(@Nonnull SokletConfig sokletConfig, @Nonnull Server.RequestHandler requestHandler)
      The Soklet instance which manages this Server will invoke this method exactly once at initialization time - this allows Soklet to "talk" to your Server.

      This method is designed for internal use by Soklet only and should not be invoked elsewhere.

      Parameters:
      sokletConfig - configuration for the Soklet instance that controls this server
      requestHandler - a Soklet-internal request handler which takes a Server-provided request as input and supplies a MarshaledResponse as output for the Server to write back to the client

    • close

      default void close() throws Exception
      AutoCloseable-enabled synonym for stop().

      This method is designed for internal use by Soklet only and should not be invoked elsewhere.

      Specified by:
      close in interface AutoCloseable
      Throws:
      Exception - if an exception occurs while stopping the server

    • withPort

      @Nonnull static Server.Builder withPort(@Nonnull Integer port)
      Acquires a builder for Server instances.
      Parameters:
      port - the port number on which the server should listen
      Returns:
      the builder