public class SockJsServiceRegistration extends ObjectSE
EnableWebSocket
および WebSocketConfigurer
セットアップで使用する SockJS フォールバックオプションを構成するためのヘルパークラス。コンストラクターと説明 |
---|
SockJsServiceRegistration() |
修飾子と型 | メソッドと説明 |
---|---|
protected SockJsService | getSockJsService() |
protected TaskScheduler | getTaskScheduler() 構成されている場合は、TaskScheduler を返します。 |
protected SockJsServiceRegistration | setAllowedOrigins(StringSE... allowedOrigins) 許可された Origin ヘッダー値を構成します。 |
SockJsServiceRegistration | setClientLibraryUrl(StringSE clientLibraryUrl) ネイティブのクロスドメイン通信のないトランスポート(例: |
SockJsServiceRegistration | setDisconnectDelay(long disconnectDelay) 受信接続がない後、クライアントが切断されたと見なされるまでの時間(ミリ秒単位)。 |
SockJsServiceRegistration | setHeartbeatTime(long heartbeatTime) サーバーがメッセージを送信せず、接続が切断されないようにするためにサーバーがクライアントにハートビートフレームを送信するまでのミリ秒単位の時間。 |
SockJsServiceRegistration | setHttpMessageCacheSize(int httpMessageCacheSize) クライアントからの次の HTTP ポーリングリクエストを待つ間にセッションがキャッシュできるサーバーからクライアントへのメッセージの数。 |
SockJsServiceRegistration | setInterceptors(HandshakeInterceptor... interceptors) |
SockJsServiceRegistration | setMessageCodec(SockJsMessageCodec codec) SockJS メッセージのエンコードとデコードに使用するコーデック。 |
SockJsServiceRegistration | setSessionCookieNeeded(boolean sessionCookieNeeded) SockJS プロトコルでは、サーバーがクライアントからの最初の "/info" リクエストに、アプリケーションが正しく機能するために JSESSIONIDCookie の使用が必要かどうかを示す "cookie_needed" ブールプロパティで応答する必要があります。 |
SockJsServiceRegistration | setStreamBytesLimit(int streamBytesLimit) ストリーミングトランスポートはクライアント側のレスポンスを保存し、配信されたメッセージが使用していたメモリを解放しません。 |
SockJsServiceRegistration | setSupressCors(boolean suppressCors) このオプションを使用して、SockJS リクエストの CORS ヘッダーの自動追加を無効にすることができます。 |
SockJsServiceRegistration | setTaskScheduler(TaskScheduler scheduler) SockJS ハートビートのスケジュールに使用するスケジューラインスタンス。 |
SockJsServiceRegistration | setTransportHandlerOverrides(TransportHandler... handlers) |
SockJsServiceRegistration | setTransportHandlers(TransportHandler... handlers) |
SockJsServiceRegistration | setWebSocketEnabled(boolean webSocketEnabled) 一部のロードバランサーは WebSocket をサポートしていません。 |
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE
public SockJsServiceRegistration setTaskScheduler(TaskScheduler scheduler)
public SockJsServiceRegistration setClientLibraryUrl(StringSE clientLibraryUrl)
デフォルトでは、これは "https://cdn.jsdelivr.net/sockjs/0.3.4/sockjs.min.js" を指すように設定されています。ただし、アプリケーションが提供する URL を指すように設定することもできます。
相対 URL を指定することが可能であることに注意してください。その場合、URL は iframeURL に対して相対でなければなりません。たとえば、SockJS エンドポイントが "/sockjs" にマッピングされ、その結果 iframe URL が "/sockjs/iframe.html" であるとすると、SockJS マッピングの上の場所までトラバースするには、相対 URL が "../../" で始まる必要があります。プレフィックスベースのサーブレットマッピングの場合、もう 1 つのトラバーサルが必要になる場合があります。
public SockJsServiceRegistration setStreamBytesLimit(int streamBytesLimit)
デフォルト値は 128K です(128 * 1024 など)。
public SockJsServiceRegistration setSessionCookieNeeded(boolean sessionCookieNeeded)
これは、XDomainRequest(変更された AJAX/XHR)をサポートする IE 8,9 で特に重要です。これは、ドメイン間でリクエストを実行できますが、Cookie を送信しません。これらの場合、SockJS クライアントは、Cookie を送信できるようにするために、"xdr-streaming" よりも "iframe-htmlfile" トランスポートを優先します。
デフォルト値は "true" で、Cookie(および特に JSESSIONID Cookie)をサポートする IE 8,9 でアプリケーションが正しく機能する可能性を最大化します。ただし、Cookie(および HTTP セッション)の使用が不要な場合、アプリケーションはこれを "false" に設定することを選択できます。
public SockJsServiceRegistration setHeartbeatTime(long heartbeatTime)
デフォルト値は 25,000 (25 秒です)。
public SockJsServiceRegistration setDisconnectDelay(long disconnectDelay)
デフォルト値は 5000 です。
public SockJsServiceRegistration setHttpMessageCacheSize(int httpMessageCacheSize)
HTTP リクエスト間の時間は比較的短く、切断の許可遅延(setDisconnectDelay(long)
を参照)を超えないようにする必要があります。デフォルトでは 5 秒です。
デフォルトのサイズは 100 です。
public SockJsServiceRegistration setWebSocketEnabled(boolean webSocketEnabled)
デフォルト値は "true" です。
public SockJsServiceRegistration setTransportHandlers(TransportHandler... handlers)
public SockJsServiceRegistration setTransportHandlerOverrides(TransportHandler... handlers)
public SockJsServiceRegistration setInterceptors(HandshakeInterceptor... interceptors)
protected SockJsServiceRegistration setAllowedOrigins(StringSE... allowedOrigins)
Origin
ヘッダー値を構成します。public SockJsServiceRegistration setSupressCors(boolean suppressCors)
デフォルト値は "false" です。
public SockJsServiceRegistration setMessageCodec(SockJsMessageCodec codec)
デフォルトでは、Jackson2SockJsMessageCodec
が使用され、Jackson ライブラリがクラスパスに存在する必要があります。
codec
- 使用するコーデック。protected SockJsService getSockJsService()
@Nullable protected TaskScheduler getTaskScheduler()