WebSocketHandlerMapping (Spring Framework API)

java.lang.ObjectSE
- org.springframework.context.support.ApplicationObjectSupport
- - org.springframework.web.context.support.WebApplicationObjectSupport
  - - org.springframework.web.servlet.handler.AbstractHandlerMapping
    - - org.springframework.web.servlet.handler.AbstractUrlHandlerMapping
      - org.springframework.web.servlet.handler.SimpleUrlHandlerMapping
        
        org.springframework.web.socket.server.support.WebSocketHandlerMapping

実装されたすべてのインターフェース:
Aware, BeanNameAware, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, Ordered, ServletContextAware, MatchableHandlerMapping, HandlerMapping
```
public class WebSocketHandlerMapping
extends SimpleUrlHandlerMapping
implements SmartLifecycle
```
型 WebSocketHttpRequestHandler のハンドラーへの WebSocket ハンドシェイクリクエストのより正確なマッピングをサポートする SimpleUrlHandlerMapping の拡張。また、Lifecycle メソッドをそれを実装する SimpleUrlHandlerMapping.getUrlMap() のハンドラーに委譲します。
導入:
4.2
作成者:
Rossen Stoyanchev

フィールドサマリー
- クラス org.springframework.web.servlet.handler.AbstractHandlerMapping から継承されたフィールド
  mappingsLogger
- クラス org.springframework.context.support.ApplicationObjectSupport から継承されたフィールド
  logger
- インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
  DEFAULT_PHASE
- インターフェース org.springframework.web.servlet.HandlerMapping から継承されたフィールド
  BEST_MATCHING_HANDLER_ATTRIBUTE, BEST_MATCHING_PATTERN_ATTRIBUTE, INTROSPECT_TYPE_LEVEL_MAPPING, LOOKUP_PATH, MATRIX_VARIABLES_ATTRIBUTE, PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE, PRODUCIBLE_MEDIA_TYPES_ATTRIBUTE, URI_TEMPLATE_VARIABLES_ATTRIBUTE
- インターフェース org.springframework.core.Ordered から継承されたフィールド
  HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

コンストラクターのサマリー
コンストラクター
コンストラクターと説明
WebSocketHandlerMapping()

コンストラクター
コンストラクターと説明
`WebSocketHandlerMapping()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected ObjectSE`	`getHandlerInternal(HttpServletRequestEE request)` 指定されたリクエストの URL パスのハンドラーを検索します。
`protected void`	`initServletContext(ServletContextEE servletContext)` サブクラスは、このアプリケーションオブジェクトが実行される ServletContext に基づいて、カスタム初期化のためにこれをオーバーライドできます。
`boolean`	`isRunning()` このコンポーネントが現在実行されているかどうかを確認します。
`void`	`setWebSocketUpgradeMatch(boolean match)` これが設定されている場合、一致するハンドラーが `WebSocketHttpRequestHandler` の場合は、リクエストが WebSocket ハンドシェイクであることを確認してください。
`void`	`start()` このコンポーネントを起動します。
`void`	`stop()` このメソッドを返すとコンポーネントが完全に停止するように、通常は同期的にこのコンポーネントを停止します。

クラス org.springframework.web.servlet.handler.SimpleUrlHandlerMapping から継承されたメソッド
getUrlMap, initApplicationContext, registerHandlers, setMappings, setUrlMap

クラス org.springframework.web.servlet.handler.AbstractUrlHandlerMapping から継承されたメソッド
buildPathExposingHandler, exposePathWithinMapping, exposeUriTemplateVariables, getHandlerMap, getPathPatternHandlerMap, getRootHandler, lookupHandler, lookupHandler, match, registerHandler, registerHandler, setLazyInitHandlers, setPatternParser, setRootHandler, setUseTrailingSlashMatch, supportsTypeLevelMappings, useTrailingSlashMatch, validateHandler

クラス org.springframework.web.context.support.WebApplicationObjectSupport から継承されたメソッド
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, isContextRequired, setServletContext

クラス org.springframework.context.support.ApplicationObjectSupport から継承されたメソッド
getApplicationContext, getMessageSourceAccessor, obtainApplicationContext, requiredContextClass, setApplicationContext

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

インターフェース org.springframework.context.SmartLifecycle から継承されたメソッド
getPhase, isAutoStartup, stop

インターフェース org.springframework.web.servlet.handler.MatchableHandlerMapping から継承されたメソッド
getPatternParser

インターフェース org.springframework.web.servlet.HandlerMapping から継承されたメソッド
getHandler, usesPathPatterns

- コンストラクターの詳細
  - WebSocketHandlerMapping
```
public WebSocketHandlerMapping()
```
- メソッドの詳細
  - setWebSocketUpgradeMatch
```
public void setWebSocketUpgradeMatch(boolean match)
```
    これが設定されている場合、一致するハンドラーが WebSocketHttpRequestHandler の場合、リクエストが WebSocket ハンドシェイクであることを確認します。つまり、ヘッダー "Upgrade:websocket" を使用した HTTP GET を使用するか、一致を抑制して null を返し、別の HandlerMapping が同じ URL パスに一致するようにします。
    パラメーター:
    match - "Upgrade: websocket" でマッチングを有効にするかどうか
    導入:
    5.3.5
  - initServletContext
```
protected void initServletContext(ServletContextEE servletContext)
```
    クラスからコピーされた説明: WebApplicationObjectSupport
    サブクラスは、このアプリケーションオブジェクトが実行される ServletContext に基づいて、カスタム初期化のためにこれをオーバーライドできます。
    デフォルトの実装は空です。WebApplicationObjectSupport.initApplicationContext(org.springframework.context.ApplicationContext) および WebApplicationObjectSupport.setServletContext(javax.servlet.ServletContext) によって呼び出されます。
    オーバーライド:
    クラス WebApplicationObjectSupport の initServletContext
    パラメーター:
    servletContext - このアプリケーションオブジェクトが実行される ServletContext (非 null)
  - start
```
public void start()
```
    インターフェースからコピーされた説明: Lifecycle
    このコンポーネントを起動します。
    コンポーネントがすでに実行されている場合は、例外をスローしないでください。
    コンテナーの場合、これは適用されるすべてのコンポーネントに開始信号を伝播します。
    次で指定:
    インターフェース Lifecycle の start
    関連事項:
    SmartLifecycle.isAutoStartup()
  - stop
```
public void stop()
```
    インターフェースからコピーされた説明: Lifecycle
    このメソッドを返すとコンポーネントが完全に停止するように、通常は同期的にこのコンポーネントを停止します。非同期停止動作が必要な場合は、SmartLifecycle とその stop(Runnable) バリアントの実装を検討してください。
    この停止通知は破棄前に送信されるとは限らないことに注意してください。通常のシャットダウンでは、一般的な破棄コールバックが伝播される前に、Lifecycle Bean は最初に停止通知を受信します。ただし、コンテキストの存続期間中のホットリフレッシュまたは中断されたリフレッシュ試行では、特定の Bean の destroy メソッドが、停止信号を事前に考慮することなく呼び出されます。
    コンポーネントが実行されていない（まだ開始されていない）場合は、例外をスローしないでください。
    コンテナーの場合、これは停止信号を適用するすべてのコンポーネントに伝播します。
    次で指定:
    インターフェース Lifecycle の stop
    関連事項:
    SmartLifecycle.stop(Runnable), DisposableBean.destroy()
  - isRunning
```
public boolean isRunning()
```
    インターフェースからコピーされた説明: Lifecycle
    このコンポーネントが現在実行されているかどうかを確認します。
    コンテナーの場合、これは、適用されるすべてのコンポーネントが現在実行されている場合にのみ、true を返します。
    次で指定:
    インターフェース Lifecycle の isRunning
    戻り値:
    コンポーネントが現在実行中かどうか
  - getHandlerInternal
```
@Nullable
protected ObjectSE getHandlerInternal(HttpServletRequestEE request)
                                       throws ExceptionSE
```
    クラスからコピーされた説明: AbstractUrlHandlerMapping
    指定されたリクエストの URL パスのハンドラーを検索します。
    オーバーライド:
    クラス AbstractUrlHandlerMapping の getHandlerInternal
    パラメーター:
    request - 現在の HTTP リクエスト
    戻り値:
    ハンドラーインスタンス。見つからない場合は null
    例外:
    ExceptionSE - 内部エラーがある場合

クラス WebSocketHandlerMapping

フィールドサマリー

クラス org.springframework.web.servlet.handler.AbstractHandlerMapping から継承されたフィールド

クラス org.springframework.context.support.ApplicationObjectSupport から継承されたフィールド

インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド

インターフェース org.springframework.web.servlet.HandlerMapping から継承されたフィールド

インターフェース org.springframework.core.Ordered から継承されたフィールド

コンストラクターのサマリー

メソッドのサマリー

クラス org.springframework.web.servlet.handler.SimpleUrlHandlerMapping から継承されたメソッド

クラス org.springframework.web.servlet.handler.AbstractUrlHandlerMapping から継承されたメソッド

クラス org.springframework.web.servlet.handler.AbstractHandlerMapping から継承されたメソッド

クラス org.springframework.web.context.support.WebApplicationObjectSupport から継承されたメソッド

クラス org.springframework.context.support.ApplicationObjectSupport から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

インターフェース org.springframework.context.SmartLifecycle から継承されたメソッド

インターフェース org.springframework.web.servlet.handler.MatchableHandlerMapping から継承されたメソッド

インターフェース org.springframework.web.servlet.HandlerMapping から継承されたメソッド

コンストラクターの詳細

WebSocketHandlerMapping

メソッドの詳細

setWebSocketUpgradeMatch

initServletContext

start

stop

isRunning

getHandlerInternal