org.springframework.web.socket.server.standard

Class AbstractTyrusRequestUpgradeStrategy

java.lang.Object

org.springframework.web.socket.server.standard.AbstractStandardUpgradeStrategy

org.springframework.web.socket.server.standard.AbstractTyrusRequestUpgradeStrategy

All Implemented Interfaces:

RequestUpgradeStrategy

Direct Known Subclasses:

GlassFishRequestUpgradeStrategy, WebLogicRequestUpgradeStrategy

public abstract class AbstractTyrusRequestUpgradeStrategy
extends AbstractStandardUpgradeStrategy

A base class for RequestUpgradeStrategy implementations on top of JSR-356 based servers which include Tyrus as their WebSocket engine.

Works with Tyrus 1.3.5 (WebLogic 12.1.3), Tyrus 1.7 (GlassFish 4.1.0), Tyrus 1.11 (WebLogic 12.2.1), and Tyrus 1.12 (GlassFish 4.1.1).

Since:

4.1

Author:

Rossen Stoyanchev, Brian Clozel

See Also:

Project Tyrus

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractTyrusRequestUpgradeStrategy.Tyrus135EndpointHelper
protected static class	AbstractTyrusRequestUpgradeStrategy.Tyrus17EndpointHelper
protected static interface	AbstractTyrusRequestUpgradeStrategy.TyrusEndpointHelper Helps with the creation, registration, and un-registration of endpoints.

Field Summary

Fields inherited from class org.springframework.web.socket.server.standard.AbstractStandardUpgradeStrategy

logger

Constructor Summary

Constructors

Constructor and Description
AbstractTyrusRequestUpgradeStrategy()

Method Summary

Modifier and Type	Method and Description
protected abstract AbstractTyrusRequestUpgradeStrategy.TyrusEndpointHelper	getEndpointHelper()
protected java.util.List<WebSocketExtension>	getInstalledExtensions(javax.websocket.WebSocketContainer container)
java.lang.String[]	getSupportedVersions() Return the supported WebSocket protocol versions.
protected abstract void	handleSuccess(HttpServletRequest request, HttpServletResponse response, org.glassfish.tyrus.spi.WebSocketEngine.UpgradeInfo upgradeInfo, org.glassfish.tyrus.core.TyrusUpgradeResponse upgradeResponse)
void	upgradeInternal(ServerHttpRequest request, ServerHttpResponse response, java.lang.String selectedProtocol, java.util.List<javax.websocket.Extension> extensions, javax.websocket.Endpoint endpoint)

Methods inherited from class org.springframework.web.socket.server.standard.AbstractStandardUpgradeStrategy

getContainer, getHttpServletRequest, getHttpServletResponse, getSupportedExtensions, upgrade

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractTyrusRequestUpgradeStrategy

public AbstractTyrusRequestUpgradeStrategy()

Method Detail

getSupportedVersions

public java.lang.String[] getSupportedVersions()

Description copied from interface: RequestUpgradeStrategy

Return the supported WebSocket protocol versions.

getInstalledExtensions

protected java.util.List<WebSocketExtension> getInstalledExtensions(javax.websocket.WebSocketContainer container)

Overrides:

getInstalledExtensions in class AbstractStandardUpgradeStrategy

upgradeInternal

public void upgradeInternal(ServerHttpRequest request,
                            ServerHttpResponse response,
                            java.lang.String selectedProtocol,
                            java.util.List<javax.websocket.Extension> extensions,
                            javax.websocket.Endpoint endpoint)
                     throws HandshakeFailureException

Specified by:

upgradeInternal in class AbstractStandardUpgradeStrategy

Throws:

HandshakeFailureException

getEndpointHelper

protected abstract AbstractTyrusRequestUpgradeStrategy.TyrusEndpointHelper getEndpointHelper()

handleSuccess

protected abstract void handleSuccess(HttpServletRequest request,
                                      HttpServletResponse response,
                                      org.glassfish.tyrus.spi.WebSocketEngine.UpgradeInfo upgradeInfo,
                                      org.glassfish.tyrus.core.TyrusUpgradeResponse upgradeResponse)
                               throws java.io.IOException,
                                      ServletException

Throws:

java.io.IOException

ServletException