org.glassfish.tyrus.server

Class TyrusEndpoint

java.lang.Object

org.glassfish.tyrus.websockets.WebSocketApplication

org.glassfish.tyrus.server.TyrusEndpoint

All Implemented Interfaces:

SPIRegisteredEndpoint, WebSocketListener

public class TyrusEndpoint
extends WebSocketApplication
implements SPIRegisteredEndpoint

Implementation of SPIRegisteredEndpoint.

Please note that for one connection to WebSocketApplication it is guaranteed that the methods: isApplicationRequest, createSocket, getSupportedProtocols, getSupportedExtensions are called in this order. Handshakes

Author:

Danny Coward (danny.coward at oracle.com), Stepan Kopriva (stepan.kopriva at oracle.com), Pavel Bucek (pavel.bucek at oracle.com)

Constructor Summary

Constructors

Constructor and Description
TyrusEndpoint(SPIEndpoint endpoint) Create TyrusEndpoint which represents given SPIEndpoint.

Method Summary

Methods

Modifier and Type	Method and Description
WebSocket	createSocket(ProtocolHandler handler, WebSocketRequest requestPacket, WebSocketListener... listeners)
static javax.websocket.CloseReason.CloseCode	getCloseCode(int code) Creates CloseReason.CloseCode from given integer value.
Set<javax.websocket.Session>	getOpenSessions()
List<Extension>	getSupportedExtensions()
List<String>	getSupportedProtocols(List<String> subProtocol)
boolean	isApplicationRequest(WebSocketRequest o)
void	onClose(WebSocket socket, ClosingFrame frame)
void	onConnect(WebSocket socket)
boolean	onError(WebSocket webSocket, Throwable t)
void	onExtensionNegotiation(List<Extension> extensions)
void	onFragment(WebSocket socket, byte[] fragment, boolean last)
void	onFragment(WebSocket socket, String fragment, boolean last)
void	onHandShakeResponse(WebSocketRequest request, WebSocketResponse response)
void	onMessage(WebSocket socket, byte[] bytes)
void	onMessage(WebSocket socket, String messageString)
void	onPing(WebSocket socket, byte[] bytes)
void	onPong(WebSocket socket, byte[] bytes)
void	remove()

Methods inherited from class org.glassfish.tyrus.websockets.WebSocketApplication

getWebSockets, handshake, upgrade

Methods inherited from class java.lang.Object

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

Constructor Detail

TyrusEndpoint

public TyrusEndpoint(SPIEndpoint endpoint)

Create TyrusEndpoint which represents given SPIEndpoint.

Parameters:

endpoint - endpoint to be wrapped.

Method Detail

isApplicationRequest

public boolean isApplicationRequest(WebSocketRequest o)

Specified by:

isApplicationRequest in class WebSocketApplication

createSocket

public WebSocket createSocket(ProtocolHandler handler,
                     WebSocketRequest requestPacket,
                     WebSocketListener... listeners)

Overrides:

createSocket in class WebSocketApplication

onConnect

public void onConnect(WebSocket socket)

Specified by:

onConnect in interface WebSocketListener

Overrides:

onConnect in class WebSocketApplication

onFragment

public void onFragment(WebSocket socket,
              String fragment,
              boolean last)

Specified by:

onFragment in interface WebSocketListener

onFragment

public void onFragment(WebSocket socket,
              byte[] fragment,
              boolean last)

Specified by:

onFragment in interface WebSocketListener

onMessage

public void onMessage(WebSocket socket,
             String messageString)

Specified by:

onMessage in interface WebSocketListener

onMessage

public void onMessage(WebSocket socket,
             byte[] bytes)

Specified by:

onMessage in interface WebSocketListener

onClose

public void onClose(WebSocket socket,
           ClosingFrame frame)

Specified by:

onClose in interface WebSocketListener

Overrides:

onClose in class WebSocketApplication

onPong

public void onPong(WebSocket socket,
          byte[] bytes)

Specified by:

onPong in interface WebSocketListener

remove

public void remove()

Specified by:

remove in interface SPIRegisteredEndpoint

getOpenSessions

public Set<javax.websocket.Session> getOpenSessions()

Specified by:

getOpenSessions in interface SPIRegisteredEndpoint

onExtensionNegotiation

public void onExtensionNegotiation(List<Extension> extensions)

Overrides:

onExtensionNegotiation in class WebSocketApplication

getSupportedExtensions

public List<Extension> getSupportedExtensions()

Overrides:

getSupportedExtensions in class WebSocketApplication

onError

public boolean onError(WebSocket webSocket,
              Throwable t)

Overrides:

onError in class WebSocketApplication

getSupportedProtocols

public List<String> getSupportedProtocols(List<String> subProtocol)

Overrides:

getSupportedProtocols in class WebSocketApplication

onPing

public void onPing(WebSocket socket,
          byte[] bytes)

Specified by:

onPing in interface WebSocketListener

onHandShakeResponse

public void onHandShakeResponse(WebSocketRequest request,
                       WebSocketResponse response)

Specified by:

onHandShakeResponse in class WebSocketApplication

getCloseCode

public static javax.websocket.CloseReason.CloseCode getCloseCode(int code)

Creates CloseReason.CloseCode from given integer value.

Present only for our convenience, should be removed once http://java.net/jira/browse/WEBSOCKET_SPEC-102 is resolved.

Parameters:

code - close code.

Returns:

CloseReason.CloseCode instance corresponding to given value or newly created anonymous class if code is not present in CloseReason.CloseCodes enumeration.

Throws:

IllegalArgumentException - when code is smaller than 1000 (not used) or bigger than 4999. See RFC-6455, section 7.4 for more details.