パッケージ org.springframework.web.reactive.socket

クラス HandshakeInfo

java.lang.ObjectSE
org.springframework.web.reactive.socket.HandshakeInfo
public class HandshakeInfo extends ObjectSE
WebSocketSession セッションを開始したハンドシェイクリクエストに関連する情報の単純なコンテナー。
導入:
5.0
作成者:
Rossen Stoyanchev
関連事項:

  • コンストラクターの詳細

    • HandshakeInfo

      public HandshakeInfo(URISE uri, HttpHeaders headers, reactor.core.publisher.Mono<PrincipalSE> principal, @Nullable StringSE protocol)
      ハンドシェイクに関する基本情報を持つコンストラクター。
      パラメーター:
      uri - エンドポイント URL
      headers - サーバーまたはレスポンスヘッダーまたはクライアントのリクエストヘッダー
      principal - セッションのプリンシパル
      protocol - 交渉されたサブプロトコル (null の場合があります)

    • HandshakeInfo

      @DeprecatedSE public HandshakeInfo(URISE uri, HttpHeaders headers, reactor.core.publisher.Mono<PrincipalSE> principal, @Nullable StringSE protocol, @Nullable InetSocketAddressSE remoteAddress, MapSE<StringSE,ObjectSE> attributes, @Nullable StringSE logPrefix)
      使用すべきではありません。
      5.3.5 現在、HandshakeInfo(URI, HttpHeaders, MultiValueMap, Mono, String, InetSocketAddress, Map, String) を推奨
      リモートアドレス、属性、ログプレフィックスなどの追加情報を使用してサーバー側で使用することを目的としたコンストラクター。
      パラメーター:
      uri - エンドポイント URL
      headers - サーバーリクエストヘッダー
      principal - セッションのプリンシパル
      protocol - 交渉されたサブプロトコル (null の場合があります)
      remoteAddress - クライアントのリモートアドレス
      attributes - WebSocket セッションの初期属性
      logPrefix - ハンドシェイクリクエストのログプレフィックス。
      導入:
      5.1

    • HandshakeInfo

      public HandshakeInfo(URISE uri, HttpHeaders headers, MultiValueMap<StringSE,HttpCookie> cookies, reactor.core.publisher.Mono<PrincipalSE> principal, @Nullable StringSE protocol, @Nullable InetSocketAddressSE remoteAddress, MapSE<StringSE,ObjectSE> attributes, @Nullable StringSE logPrefix)
      Cookie、リモートアドレス、属性、ログプレフィックスなどの追加情報を使用してサーバー側で使用することを目的としたコンストラクター。
      パラメーター:
      uri - エンドポイント URL
      headers - サーバーリクエストヘッダー
      cookies - サーバーリクエスト Cookie
      principal - セッションのプリンシパル
      protocol - 交渉されたサブプロトコル (null の場合があります)
      remoteAddress - クライアントのリモートアドレス
      attributes - WebSocket セッションの初期属性
      logPrefix - ハンドシェイクリクエストのログプレフィックス。
      導入:
      5.3.5

  • メソッドの詳細

    • getUri

      public URISE getUri()
      WebSocket エンドポイントの URL を返します。

    • getHeaders

      public HttpHeaders getHeaders()
      ハンドシェイクリクエストから HTTP ヘッダーを返します。これは、サーバーセッションのサーバーリクエストヘッダーまたはクライアントセッションのクライアントレスポンスヘッダーのいずれかです。

    • getCookies

      public MultiValueMap<StringSE,HttpCookie> getCookies()
      サーバーセッションの場合、これはハンドシェイクリクエストからサーバーリクエスト Cookie を返します。クライアントセッションの場合、これは空のマップです。
      導入:
      5.3.5

    • getPrincipal

      public reactor.core.publisher.Mono<PrincipalSE> getPrincipal()
      ハンドシェイクリクエストに関連付けられているプリンシパルがある場合は、それを返します。

    • getSubProtocol

      @Nullable public StringSE getSubProtocol()
      ハンドシェイク時にネゴシエートされたサブプロトコル。ない場合は null。
      関連事項:

    • getRemoteAddress

      @Nullable public InetSocketAddressSE getRemoteAddress()
      サーバーセッションの場合、これはハンドシェイクリクエストの送信元のリモートアドレスです。クライアントセッションの場合、null です。
      導入:
      5.1

    • getAttributes

      public MapSE<StringSE,ObjectSE> getAttributes()
      セッションに追加するためにハンドシェイクリクエストから抽出された属性。
      導入:
      5.1

    • getLogPrefix

      @Nullable public StringSE getLogPrefix()
      ログメッセージを関連付けるためにハンドシェイクで使用されるログプレフィックス（ある場合）。
      戻り値:
      ログ接頭辞、または指定されていない場合は null 
      導入:
      5.1

    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSE の toString