类 OriginHandshakeInterceptor

字段详细资料

• logger

  protected final Log logger

构造器详细资料

• OriginHandshakeInterceptor

  public OriginHandshakeInterceptor()

  Default constructor with only same origin requests allowed.

• OriginHandshakeInterceptor

  public OriginHandshakeInterceptor​(Collection<String> allowedOrigins)

  Constructor using the specified allowed origin values.

  另请参阅:

  setAllowedOrigins(Collection)

方法详细资料

• setAllowedOrigins

  public void setAllowedOrigins​(Collection<String> allowedOrigins)

  Configure allowed Origin header values. This check is mostly designed for browsers. There is nothing preventing other types of client to modify the Origin header value.

  Each provided allowed origin must have a scheme, and optionally a port (e.g. "https://example.org", "https://example.org:9090"). An allowed origin string may also be "*" in which case all origins are allowed.

  另请参阅:

  RFC 6454: The Web Origin Concept

• getAllowedOrigins

  public Collection<String> getAllowedOrigins()

  Return the allowed Origin header values.

  从以下版本开始:

  4.1.5

  另请参阅:

  setAllowedOrigins(java.util.Collection<java.lang.String>)

• beforeHandshake

  public boolean beforeHandshake​(ServerHttpRequest request,
                                 ServerHttpResponse response,
                                 WebSocketHandler wsHandler,
                                 Map<String,​Object> attributes)
                          throws Exception

  从接口复制的说明: HandshakeInterceptor
  Invoked before the handshake is processed.

  指定者:

  beforeHandshake 在接口中 HandshakeInterceptor

  参数:

  request - the current request

  response - the current response

  wsHandler - the target WebSocket handler

  attributes - attributes from the HTTP handshake to associate with the WebSocket session; the provided attributes are copied, the original map is not used.

  返回:

  whether to proceed with the handshake (true) or abort (false)

  抛出:

  Exception

• afterHandshake

  public void afterHandshake​(ServerHttpRequest request,
                             ServerHttpResponse response,
                             WebSocketHandler wsHandler,
                             Exception exception)

  从接口复制的说明: HandshakeInterceptor
  Invoked after the handshake is done. The response status and headers indicate the results of the handshake, i.e. whether it was successful or not.

  指定者:

  afterHandshake 在接口中 HandshakeInterceptor

  参数:

  request - the current request

  response - the current response

  wsHandler - the target WebSocket handler

  exception - an exception raised during the handshake, or null if none