Package pl.morgwai.base.servlet.guice.scopes

Class WebsocketConnectionProxy

java.lang.Object

pl.morgwai.base.servlet.guice.scopes.WebsocketConnectionProxy

All Implemented Interfaces:

Session, Closeable, AutoCloseable

public class WebsocketConnectionProxy
extends Object
implements Session

Decorates MessageHandlers passed to addMessageHandler(MessageHandler) method family with WebsocketEventContext tracking.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WebsocketConnectionProxy.Factory	SPI-provided factory for proxies, that wrap specific implementation of Session to enable its specific features.

Field Summary

Fields

Modifier and Type	Field	Description
protected ContextTracker<ContainerCallContext>	ctxTracker
protected HttpSession	httpSession
protected Session	wrappedConnection

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WebsocketConnectionProxy(Session connection, ContextTracker<ContainerCallContext> containerCallContextTracker, boolean remote)	Constructs a new proxy for connection.

Method Summary

Modifier and Type	Method	Description
void	addMessageHandler(MessageHandler handler)
<T> void	addMessageHandler(Class<T> messageClass, MessageHandler.Partial<T> handler)
<T> void	addMessageHandler(Class<T> messageClass, MessageHandler.Whole<T> handler)
void	close()
void	close(CloseReason closeReason)
boolean	equals(Object other)
RemoteEndpoint.Async	getAsyncRemote()
RemoteEndpoint.Basic	getBasicRemote()
WebSocketContainer	getContainer()
String	getId()
int	getMaxBinaryMessageBufferSize()
long	getMaxIdleTimeout()
int	getMaxTextMessageBufferSize()
Set<MessageHandler>	getMessageHandlers()
List<Extension>	getNegotiatedExtensions()
String	getNegotiatedSubprotocol()
Set<Session>	getOpenSessions()
Map<String,String>	getPathParameters()
String	getProtocolVersion()
String	getQueryString()
Map<String,List<String>>	getRequestParameterMap()
URI	getRequestURI()
Principal	getUserPrincipal()
Map<String,Object>	getUserProperties()
Session	getWrappedConnection()
int	hashCode()
boolean	isOpen()
boolean	isSecure()
void	removeMessageHandler(MessageHandler handler)
void	setMaxBinaryMessageBufferSize(int length)
void	setMaxIdleTimeout(long milliseconds)
void	setMaxTextMessageBufferSize(int length)

Methods inherited from class java.lang.Object

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

Field Detail

wrappedConnection

protected final Session wrappedConnection

ctxTracker

protected final ContextTracker<ContainerCallContext> ctxTracker

httpSession

protected final HttpSession httpSession

Constructor Detail

WebsocketConnectionProxy

protected WebsocketConnectionProxy(Session connection,
                                   ContextTracker<ContainerCallContext> containerCallContextTracker,
                                   boolean remote)

Constructs a new proxy for connection.

Parameters:

remote - weather connection is a remote Session from another cluster node. In such case, there will be no attempt to retrieve httpSession from userProperties. This is useful when creating proxies for remote Sessions in getOpenSessions() in a clustered environment.

Method Detail

getWrappedConnection

public Session getWrappedConnection()

getOpenSessions

public Set<Session> getOpenSessions()

Specified by:

getOpenSessions in interface Session

getUserProperties

public Map<String,Object> getUserProperties()

Specified by:

getUserProperties in interface Session

addMessageHandler

public void addMessageHandler(MessageHandler handler)

Specified by:

addMessageHandler in interface Session

addMessageHandler

public <T> void addMessageHandler(Class<T> messageClass,
                                  MessageHandler.Whole<T> handler)

Specified by:

addMessageHandler in interface Session

addMessageHandler

public <T> void addMessageHandler(Class<T> messageClass,
                                  MessageHandler.Partial<T> handler)

Specified by:

addMessageHandler in interface Session

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getContainer

public WebSocketContainer getContainer()

Specified by:

getContainer in interface Session

getMessageHandlers

public Set<MessageHandler> getMessageHandlers()

Specified by:

getMessageHandlers in interface Session

removeMessageHandler

public void removeMessageHandler(MessageHandler handler)

Specified by:

removeMessageHandler in interface Session

getProtocolVersion

public String getProtocolVersion()

Specified by:

getProtocolVersion in interface Session

getNegotiatedSubprotocol

public String getNegotiatedSubprotocol()

Specified by:

getNegotiatedSubprotocol in interface Session

getNegotiatedExtensions

public List<Extension> getNegotiatedExtensions()

Specified by:

getNegotiatedExtensions in interface Session

isSecure

public boolean isSecure()

Specified by:

isSecure in interface Session

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Session

getMaxIdleTimeout

public long getMaxIdleTimeout()

Specified by:

getMaxIdleTimeout in interface Session

setMaxIdleTimeout

public void setMaxIdleTimeout(long milliseconds)

Specified by:

setMaxIdleTimeout in interface Session

setMaxBinaryMessageBufferSize

public void setMaxBinaryMessageBufferSize(int length)

Specified by:

setMaxBinaryMessageBufferSize in interface Session

getMaxBinaryMessageBufferSize

public int getMaxBinaryMessageBufferSize()

Specified by:

getMaxBinaryMessageBufferSize in interface Session

setMaxTextMessageBufferSize

public void setMaxTextMessageBufferSize(int length)

Specified by:

setMaxTextMessageBufferSize in interface Session

getMaxTextMessageBufferSize

public int getMaxTextMessageBufferSize()

Specified by:

getMaxTextMessageBufferSize in interface Session

getAsyncRemote

public RemoteEndpoint.Async getAsyncRemote()

Specified by:

getAsyncRemote in interface Session

getBasicRemote

public RemoteEndpoint.Basic getBasicRemote()

Specified by:

getBasicRemote in interface Session

getId

public String getId()

Specified by:

getId in interface Session

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Session

Throws:

IOException

close

public void close(CloseReason closeReason)
           throws IOException

Specified by:

close in interface Session

Throws:

IOException

getRequestURI

public URI getRequestURI()

Specified by:

getRequestURI in interface Session

getRequestParameterMap

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

Specified by:

getRequestParameterMap in interface Session

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface Session

getPathParameters

public Map<String,String> getPathParameters()

Specified by:

getPathParameters in interface Session

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface Session