クラス AbstractWebSocketHandlerRegistration<M>
java.lang.ObjectSE
org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration<M>
- 型パラメーター:
M
- マッピング型
- 実装されたすべてのインターフェース:
WebSocketHandlerRegistration
- 既知の直属サブクラス
ServletWebSocketHandlerRegistration
public abstract class AbstractWebSocketHandlerRegistration<M>
extends ObjectSE
implements WebSocketHandlerRegistration
すべての構成オプションを収集するが、サブクラスが実際の HTTP リクエストマッピングをまとめることができる
WebSocketHandlerRegistrations
の基本クラス。- 導入:
- 4.0
- 作成者:
- Rossen Stoyanchev, Sebastien Deleuze
コンストラクターのサマリー
メソッドのサマリー
修飾子と型メソッド説明addHandler
(WebSocketHandler handler, StringSE... paths) 同じ構成を共有するハンドラーをさらに追加します(インターセプター、SockJS 構成など)。addInterceptors
(HandshakeInterceptor... interceptors) ハンドシェイクリクエストのインターセプターを構成します。protected abstract void
addSockJsServiceMapping
(M mappings, SockJsService sockJsService, WebSocketHandler handler, StringSE pathPattern) protected abstract void
addWebSocketHandlerMapping
(M mappings, WebSocketHandler wsHandler, HandshakeHandler handshakeHandler, HandshakeInterceptor[] interceptors, StringSE path) protected abstract M
protected HandshakeHandler
protected HandshakeInterceptor[]
protected final M
protected SockJsServiceRegistration
SockJS が有効な場合はSockJsServiceRegistration
を公開し、そうでない場合はnull
を公開することで、アプリケーションが TaskScheduler を提供していない場合に、設定できるようにします。setAllowedOriginPatterns
(StringSE... allowedOriginPatterns) ブラウザーからのクロスオリジンリクエストが許可されるオリジンを指定するためのより柔軟なパターンをサポートするWebSocketHandlerRegistration.setAllowedOrigins(String...)
の代替。setAllowedOrigins
(StringSE... allowedOrigins) ブラウザーからのクロスオリジンリクエストを許可するオリジンを設定します。setHandshakeHandler
(HandshakeHandler handshakeHandler) 使用する HandshakeHandler を構成します。SockJS フォールバックオプションを有効にします。
コンストラクターの詳細
AbstractWebSocketHandlerRegistration
public AbstractWebSocketHandlerRegistration()
メソッドの詳細
addHandler
インターフェースからコピーされた説明:WebSocketHandlerRegistration
同じ構成を共有するハンドラーをさらに追加します(インターセプター、SockJS 構成など)。- 次で指定:
- インターフェース
WebSocketHandlerRegistration
のaddHandler
setHandshakeHandler
public WebSocketHandlerRegistration setHandshakeHandler(@Nullable HandshakeHandler handshakeHandler) インターフェースからコピーされた説明:WebSocketHandlerRegistration
使用する HandshakeHandler を構成します。- 次で指定:
- インターフェース
WebSocketHandlerRegistration
のsetHandshakeHandler
getHandshakeHandler
addInterceptors
インターフェースからコピーされた説明:WebSocketHandlerRegistration
ハンドシェイクリクエストのインターセプターを構成します。- 次で指定:
- インターフェース
WebSocketHandlerRegistration
のaddInterceptors
setAllowedOrigins
インターフェースからコピーされた説明:WebSocketHandlerRegistration
ブラウザーからのクロスオリジンリクエストを許可するオリジンを設定します。フォーマットの詳細と考慮事項についてはCorsConfiguration.setAllowedOrigins(List)
を参照してください。また、CORS 仕様では"*"
とallowCredentials=true
の使用が許可されていないことに注意してください。より柔軟な原点パターンの場合は、代わりにWebSocketHandlerRegistration.setAllowedOriginPatterns(java.lang.String...)
を使用してください。デフォルトでは、オリジンは許可されていません。
allowedOriginPatterns
も設定されている場合、このプロパティよりも優先されます。SockJS が有効で、オリジンが制限されている場合、リクエストのオリジンをチェックできないトランスポート型(Iframe ベースのトランスポート)は無効になっていることに注意してください。結果として、オリジンが制限されている場合、IE6 から 9 はサポートされません。
setAllowedOriginPatterns
インターフェースからコピーされた説明:WebSocketHandlerRegistration
ブラウザーからのクロスオリジンリクエストが許可されるオリジンを指定するためのより柔軟なパターンをサポートするWebSocketHandlerRegistration.setAllowedOrigins(String...)
の代替。フォーマットの詳細やその他の考慮事項については、CorsConfiguration.setAllowedOriginPatterns(List)
を参照してください。デフォルトでは、これは設定されていません。
- 次で指定:
- インターフェース
WebSocketHandlerRegistration
のsetAllowedOriginPatterns
withSockJS
インターフェースからコピーされた説明:WebSocketHandlerRegistration
SockJS フォールバックオプションを有効にします。- 次で指定:
- インターフェース
WebSocketHandlerRegistration
のwithSockJS
getInterceptors
getSockJsServiceRegistration
SockJS が有効な場合はSockJsServiceRegistration
を公開し、そうでない場合はnull
を公開することで、アプリケーションが TaskScheduler を提供していない場合に、設定できるようにします。これはgetMappings()
を呼び出す前に行う必要があります。getMappings
createMappings
addSockJsServiceMapping
protected abstract void addSockJsServiceMapping(M mappings, SockJsService sockJsService, WebSocketHandler handler, StringSE pathPattern) addWebSocketHandlerMapping
protected abstract void addWebSocketHandlerMapping(M mappings, WebSocketHandler wsHandler, HandshakeHandler handshakeHandler, HandshakeInterceptor[] interceptors, StringSE path)