パッケージ org.springframework.boot.web.server

インターフェース WebServer

すべての既知の実装クラス:
JettyWebServer、NettyWebServer、TomcatWebServer、UndertowServletWebServer、UndertowWebServer
public interface WebServer
完全に構成された Web サーバー（Tomcat、Jetty、Netty など）を表すシンプルなインターフェース。サーバーを started および stopped にすることができます。
導入:
2.0.0
作成者:
Phillip Webb, Dave Syer

  • 方法の概要

    修飾子と型
    メソッド
    説明
    default void
    destroy()
    Web サーバーを破棄し、再起動できないようにします。
    int
    getPort()
    このサーバーがリッスンしているポートを返します。
    default void
    shutDownGracefully(GracefulShutdownCallback callback)
    Web サーバーの正常なシャットダウンを開始します。
    void
    start()
    Web サーバーを起動します。
    void
    stop()
    Web サーバーを停止します。

  • メソッドの詳細

    • start

      void start() throws WebServerException
      Web サーバーを起動します。すでに起動しているサーバーでこのメソッドを呼び出しても効果はありません。
      例外:
      WebServerException - サーバーを起動できない場合

    • stop

      void stop() throws WebServerException
      Web サーバーを停止します。すでに停止しているサーバーでこのメソッドを呼び出しても効果はありません。
      例外:
      WebServerException - サーバーを停止できない場合

    • getPort

      int getPort()
      このサーバーがリッスンしているポートを返します。
      戻り値:
      港 (ない場合は -1)

    • shutDownGracefully

      default void shutDownGracefully(GracefulShutdownCallback callback)
      Web サーバーの正常なシャットダウンを開始します。新しいリクエストの処理は防止され、試行の最後に指定された callback が呼び出されます。stop() を呼び出すことにより、試行を明示的に終了できます。デフォルトの実装では、GracefulShutdownResult.IMMEDIATE を使用してコールバックをすぐに呼び出します。つまり、正常なシャットダウンでは何も行われません。
      パラメーター:
      callback - 正常なシャットダウンが完了したときに呼び出すコールバック
      導入:
      2.3.0

    • destroy

      default void destroy()
      Web サーバーを破棄し、再起動できないようにします。
      導入:
      3.2.0