クラス WebSocketHandlerMapping
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
型
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.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
インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
DEFAULT_PHASE
コンストラクターのサマリー
コンストラクターメソッドのサマリー
修飾子と型メソッド説明protected ObjectSE
getHandlerInternal
(HttpServletRequestEE request) 指定されたリクエストの URL パスのハンドラーを検索します。protected void
initServletContext
(ServletContextEE servletContext) サブクラスは、このアプリケーションオブジェクトが実行される ServletContext に基づいて、カスタム初期化のためにこれをオーバーライドできます。boolean
このコンポーネントが現在実行されているかどうかを確認します。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.servlet.handler.AbstractHandlerMapping から継承されたメソッド
adaptInterceptor, detectMappedInterceptors, extendInterceptors, formatMappingName, getAdaptedInterceptors, getCorsConfiguration, getCorsConfigurationSource, getCorsHandlerExecutionChain, getCorsProcessor, getDefaultHandler, getHandler, getHandlerExecutionChain, getMappedInterceptors, getOrder, getPathMatcher, getPatternParser, getUrlPathHelper, hasCorsConfigurationSource, initInterceptors, initLookupPath, setAlwaysUseFullPath, setBeanName, setCorsConfigurations, setCorsConfigurationSource, setCorsProcessor, setDefaultHandler, setInterceptors, setOrder, setPathMatcher, setRemoveSemicolonContent, setUrlDecode, setUrlPathHelper, usesPathPatterns
クラス 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 から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.web.servlet.HandlerMapping から継承されたメソッド
getHandler, usesPathPatterns
インターフェース org.springframework.web.servlet.handler.MatchableHandlerMapping から継承されたメソッド
getPatternParser
インターフェース org.springframework.context.SmartLifecycle から継承されたメソッド
getPhase, isAutoStartup, stop
コンストラクターの詳細
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
クラスからコピーされた説明:WebApplicationObjectSupport
サブクラスは、このアプリケーションオブジェクトが実行される ServletContext に基づいて、カスタム初期化のためにこれをオーバーライドできます。デフォルトの実装は空です。
WebApplicationObjectSupport.initApplicationContext(org.springframework.context.ApplicationContext)
およびWebApplicationObjectSupport.setServletContext(jakarta.servlet.ServletContext)
によって呼び出されます。- オーバーライド:
- クラス
WebApplicationObjectSupport
のinitServletContext
- パラメーター:
servletContext
- このアプリケーションオブジェクトが実行される ServletContext (非null
)
start
public void start()インターフェースからコピーされた説明:Lifecycle
このコンポーネントを起動します。コンポーネントがすでに実行されている場合は、例外をスローしないでください。
コンテナーの場合、これは適用されるすべてのコンポーネントに開始シグナルを伝播します。
stop
public void stop()インターフェースからコピーされた説明:Lifecycle
このメソッドを返すとコンポーネントが完全に停止するように、通常は同期的にこのコンポーネントを停止します。非同期停止動作が必要な場合は、SmartLifecycle
とそのstop(Runnable)
バリアントの実装を検討してください。この停止通知は破棄前に送信されるとは限らないことに注意してください。通常のシャットダウンでは、一般的な破棄コールバックが伝播される前に、
Lifecycle
Bean は最初に停止通知を受信します。ただし、コンテキストの存続期間中のホットリフレッシュまたは中断されたリフレッシュ試行では、特定の Bean の destroy メソッドが、停止シグナルを事前に考慮することなく呼び出されます。コンポーネントが実行されていない(まだ開始されていない)場合は、例外をスローしないでください。
コンテナーの場合、これは停止シグナルを適用するすべてのコンポーネントに伝播します。
isRunning
public boolean isRunning()インターフェースからコピーされた説明:Lifecycle
このコンポーネントが現在実行されているかどうかを確認します。コンテナーの場合、これは、適用されるすべてのコンポーネントが現在実行されている場合にのみ、
true
を返します。getHandlerInternal
クラスからコピーされた説明:AbstractUrlHandlerMapping
指定されたリクエストの URL パスのハンドラーを検索します。- オーバーライド:
- クラス
AbstractUrlHandlerMapping
のgetHandlerInternal
- パラメーター:
request
- 現在の HTTP リクエスト- 戻り値:
- ハンドラーインスタンス。見つからない場合は
null
- 例外:
ExceptionSE
- 内部エラーがある場合