类 JettyRequestUpgradeStrategy

构造器详细资料

• JettyRequestUpgradeStrategy

  public JettyRequestUpgradeStrategy()

  Default constructor that creates WebSocketServerFactory through its default constructor thus using a default WebSocketPolicy.

• JettyRequestUpgradeStrategy

  public JettyRequestUpgradeStrategy​(org.eclipse.jetty.websocket.api.WebSocketPolicy policy)

  A constructor accepting a WebSocketPolicy to be used when creating the WebSocketServerFactory instance.

  参数:

  policy - the policy to use

  从以下版本开始:

  4.3.5

• JettyRequestUpgradeStrategy

  public JettyRequestUpgradeStrategy​(org.eclipse.jetty.websocket.server.WebSocketServerFactory factory)

  A constructor accepting a WebSocketServerFactory.

  参数:

  factory - the pre-configured factory to use

方法详细资料

• setServletContext

  public void setServletContext​(ServletContext servletContext)

  从接口复制的说明: ServletContextAware
  Set the ServletContext that this object runs in.

  Invoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method. Invoked after ApplicationContextAware's setApplicationContext.

  指定者:

  setServletContext 在接口中 ServletContextAware

  参数:

  servletContext - ServletContext object to be used by this object

  另请参阅:

  InitializingBean.afterPropertiesSet(), ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)

• start

  public void start()

  从接口复制的说明: Lifecycle
  Start this component.

  Should not throw an exception if the component is already running.

  In the case of a container, this will propagate the start signal to all components that apply.

  指定者:

  start 在接口中 Lifecycle

  另请参阅:

  SmartLifecycle.isAutoStartup()

• stop

  public void stop()

  从接口复制的说明: Lifecycle
  Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method. Consider implementing SmartLifecycle and its stop(Runnable) variant when asynchronous stop behavior is necessary.

  Note that this stop notification is not guaranteed to come before destruction: On regular shutdown, Lifecycle beans will first receive a stop notification before the general destruction callbacks are being propagated; however, on hot refresh during a context's lifetime or on aborted refresh attempts, a given bean's destroy method will be called without any consideration of stop signals upfront.

  Should not throw an exception if the component is not running (not started yet).

  In the case of a container, this will propagate the stop signal to all components that apply.

  指定者:

  stop 在接口中 Lifecycle

  另请参阅:

  SmartLifecycle.stop(Runnable), DisposableBean.destroy()

• isRunning

  public boolean isRunning()

  从接口复制的说明: Lifecycle
  Check whether this component is currently running.

  In the case of a container, this will return true only if all components that apply are currently running.

  指定者:

  isRunning 在接口中 Lifecycle

  返回:

  whether the component is currently running

• getSupportedVersions

  public String[] getSupportedVersions()

  从接口复制的说明: RequestUpgradeStrategy
  Return the supported WebSocket protocol versions.

  指定者:

  getSupportedVersions 在接口中 RequestUpgradeStrategy

• getSupportedExtensions

  public List<WebSocketExtension> getSupportedExtensions​(ServerHttpRequest request)

  从接口复制的说明: RequestUpgradeStrategy
  Return the WebSocket protocol extensions supported by the underlying WebSocket server.

  指定者:

  getSupportedExtensions 在接口中 RequestUpgradeStrategy

• upgrade

  public void upgrade​(ServerHttpRequest request,
                      ServerHttpResponse response,
                      String selectedProtocol,
                      List<WebSocketExtension> selectedExtensions,
                      Principal user,
                      WebSocketHandler wsHandler,
                      Map<String,​Object> attributes)
               throws HandshakeFailureException

  从接口复制的说明: RequestUpgradeStrategy
  Perform runtime specific steps to complete the upgrade. Invoked after successful negotiation of the handshake request.

  指定者:

  upgrade 在接口中 RequestUpgradeStrategy

  参数:

  request - the current request

  response - the current response

  selectedProtocol - the selected sub-protocol, if any

  selectedExtensions - the selected WebSocket protocol extensions

  user - the user to associate with the WebSocket session

  wsHandler - the handler for WebSocket messages

  attributes - handshake request specific attributes to be set on the WebSocket session via HandshakeInterceptor and thus made available to the WebSocketHandler

  抛出:

  HandshakeFailureException - thrown when handshake processing failed to complete due to an internal, unrecoverable error, i.e. a server error as opposed to a failure to successfully negotiate the requirements of the handshake request.