Package org.eclipse.jetty.websocket.javax.common

Class JavaxWebSocketSession

java.lang.Object

org.eclipse.jetty.websocket.javax.common.JavaxWebSocketSession

All Implemented Interfaces:

Closeable, AutoCloseable, javax.websocket.Session

public class JavaxWebSocketSession
extends Object
implements javax.websocket.Session

Client Session for the JSR.

Constructor Summary

Constructors

Constructor	Description
JavaxWebSocketSession(JavaxWebSocketContainer container, CoreSession coreSession, JavaxWebSocketFrameHandler frameHandler, javax.websocket.EndpointConfig endpointConfig)

Method Summary

Modifier and Type	Method	Description
void	abort()
<T> void	addMessageHandler(Class<T> clazz, javax.websocket.MessageHandler.Partial<T> handler)
<T> void	addMessageHandler(Class<T> clazz, javax.websocket.MessageHandler.Whole<T> handler)
void	addMessageHandler(javax.websocket.MessageHandler handler)
void	close()
void	close(javax.websocket.CloseReason closeReason)
void	filterReturnType(Object obj)	Access for MethodHandle implementations to filter the return value of user provided TEXT/BINARY based message handling methods.
javax.websocket.RemoteEndpoint.Async	getAsyncRemote()
javax.websocket.RemoteEndpoint.Basic	getBasicRemote()
javax.websocket.WebSocketContainer	getContainer()
JavaxWebSocketContainer	getContainerImpl()
CoreSession	getCoreSession()
AvailableDecoders	getDecoders()
AvailableEncoders	getEncoders()
Object	getEndpoint()
JavaxWebSocketFrameHandler	getFrameHandler()
String	getId()
int	getMaxBinaryMessageBufferSize()
long	getMaxIdleTimeout()
int	getMaxTextMessageBufferSize()
Set<javax.websocket.MessageHandler>	getMessageHandlers()
List<javax.websocket.Extension>	getNegotiatedExtensions()
String	getNegotiatedSubprotocol()
Set<javax.websocket.Session>	getOpenSessions()
Map<String,String>	getPathParameters()
String	getProtocolVersion()
String	getQueryString()
Map<String,List<String>>	getRequestParameterMap()
URI	getRequestURI()
Principal	getUserPrincipal()
Map<String,Object>	getUserProperties()
boolean	isOpen()
boolean	isSecure()
void	removeMessageHandler(javax.websocket.MessageHandler handler)
void	setMaxBinaryMessageBufferSize(int length)	Maximum size of a whole BINARY message that this implementation can buffer.
void	setMaxIdleTimeout(long milliseconds)
void	setMaxTextMessageBufferSize(int length)	Maximum size of a whole TEXT message that this implementation can buffer.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

JavaxWebSocketSession

public JavaxWebSocketSession(JavaxWebSocketContainer container,
 CoreSession coreSession,
 JavaxWebSocketFrameHandler frameHandler,
 javax.websocket.EndpointConfig endpointConfig)

Method Details

getCoreSession

public CoreSession getCoreSession()

addMessageHandler

public <T> void addMessageHandler(Class<T> clazz,
 javax.websocket.MessageHandler.Partial<T> handler)

Specified by:

addMessageHandler in interface javax.websocket.Session

Since:

JSR356 v1.1

See Also:

• Session.addMessageHandler(Class, MessageHandler.Partial)

addMessageHandler

public <T> void addMessageHandler(Class<T> clazz,
 javax.websocket.MessageHandler.Whole<T> handler)

Specified by:

addMessageHandler in interface javax.websocket.Session

Since:

JSR356 v1.1

See Also:

• Session.addMessageHandler(Class, MessageHandler.Whole)

addMessageHandler

public void addMessageHandler(javax.websocket.MessageHandler handler)
                       throws IllegalStateException

Specified by:

addMessageHandler in interface javax.websocket.Session

Throws:

IllegalStateException

Since:

JSR356 v1.0

See Also:

• Session.addMessageHandler(MessageHandler)

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.close()

close

public void close(javax.websocket.CloseReason closeReason)

Specified by:

close in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.close(CloseReason)

filterReturnType

public void filterReturnType(Object obj)

Access for MethodHandle implementations to filter the return value of user provided TEXT/BINARY based message handling methods.

Parameters:

obj - the return object

getAsyncRemote

public javax.websocket.RemoteEndpoint.Async getAsyncRemote()

Specified by:

getAsyncRemote in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.getAsyncRemote()

getBasicRemote

public javax.websocket.RemoteEndpoint.Basic getBasicRemote()

Specified by:

getBasicRemote in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.getBasicRemote()

getContainer

public javax.websocket.WebSocketContainer getContainer()

Specified by:

getContainer in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.getContainer()

getContainerImpl

public JavaxWebSocketContainer getContainerImpl()

getDecoders

public AvailableDecoders getDecoders()

getEncoders

public AvailableEncoders getEncoders()

getEndpoint

public Object getEndpoint()

getFrameHandler

public JavaxWebSocketFrameHandler getFrameHandler()

abort

public void abort()

getId

public String getId()

Specified by:

getId in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.getId()

getMaxBinaryMessageBufferSize

public int getMaxBinaryMessageBufferSize()

Specified by:

getMaxBinaryMessageBufferSize in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.getMaxBinaryMessageBufferSize()

setMaxBinaryMessageBufferSize

public void setMaxBinaryMessageBufferSize(int length)

Maximum size of a whole BINARY message that this implementation can buffer.

Specified by:

setMaxBinaryMessageBufferSize in interface javax.websocket.Session

Parameters:

length - the length in bytes

Since:

JSR356 v1.0

See Also:

• Session.setMaxBinaryMessageBufferSize(int)

getMaxIdleTimeout

public long getMaxIdleTimeout()

Specified by:

getMaxIdleTimeout in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.getMaxIdleTimeout()

setMaxIdleTimeout

public void setMaxIdleTimeout(long milliseconds)

Specified by:

setMaxIdleTimeout in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.setMaxIdleTimeout(long)

getMaxTextMessageBufferSize

public int getMaxTextMessageBufferSize()

Specified by:

getMaxTextMessageBufferSize in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.getMaxTextMessageBufferSize()

setMaxTextMessageBufferSize

public void setMaxTextMessageBufferSize(int length)

Maximum size of a whole TEXT message that this implementation can buffer.

Specified by:

setMaxTextMessageBufferSize in interface javax.websocket.Session

Parameters:

length - the length in bytes

Since:

JSR356 v1.0

See Also:

• Session.setMaxTextMessageBufferSize(int)

getMessageHandlers

public Set<javax.websocket.MessageHandler> getMessageHandlers()

Specified by:

getMessageHandlers in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.getMessageHandlers()

getNegotiatedExtensions

public List<javax.websocket.Extension> getNegotiatedExtensions()

Specified by:

getNegotiatedExtensions in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.getNegotiatedExtensions()

getNegotiatedSubprotocol

public String getNegotiatedSubprotocol()

Specified by:

getNegotiatedSubprotocol in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.getNegotiatedSubprotocol()

getOpenSessions

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

Specified by:

getOpenSessions in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.getOpenSessions()

getPathParameters

public Map<String,String> getPathParameters()

Specified by:

getPathParameters in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.getPathParameters()

getProtocolVersion

public String getProtocolVersion()

Specified by:

getProtocolVersion in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.getProtocolVersion()

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.getQueryString()

getRequestParameterMap

public Map<String,List<String>> getRequestParameterMap()

Specified by:

getRequestParameterMap in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.getRequestParameterMap()

getRequestURI

public URI getRequestURI()

Specified by:

getRequestURI in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• )

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.getUserPrincipal()

getUserProperties

public Map<String,Object> getUserProperties()

Specified by:

getUserProperties in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.getUserProperties()

isOpen

public boolean isOpen()

Specified by:

isOpen in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.isOpen()

isSecure

public boolean isSecure()

Specified by:

isSecure in interface javax.websocket.Session

Since:

JSR356 v1.0

See Also:

• Session.isSecure()

removeMessageHandler

public void removeMessageHandler(javax.websocket.MessageHandler handler)

Specified by:

removeMessageHandler in interface javax.websocket.Session

toString

public String toString()

Overrides:

toString in class Object