org.everrest.websockets

Class WSConnectionImpl

java.lang.Object

javax.websocket.Endpoint

org.everrest.websockets.WSConnectionImpl

All Implemented Interfaces:

WSConnection

public class WSConnectionImpl
extends javax.websocket.Endpoint
implements WSConnection

Constructor Summary

Constructors

Constructor and Description
WSConnectionImpl()

Method Summary

Modifier and Type	Method and Description
void	close() Close this connection with 1000 status which indicates a normal closure.
void	close(int status, String message) Close this connection with specified status and message.
Object	getAttribute(String name) Returns the object bound with the specified name in this connection, or null if no object is bound under the name.
Collection<String>	getChannels() Get optional set of channels assigned for this connection.
int	getCloseStatus() Get connection close status.
javax.servlet.http.HttpSession	getHttpSession() Get HTTP session associated to this connection.
Long	getId() Get unique connection identifier.
javax.websocket.Session	getWsSession()
boolean	isConnected() Check connection state.
void	onClose(javax.websocket.Session session, javax.websocket.CloseReason closeReason)
void	onError(javax.websocket.Session session, Throwable thr)
void	onOpen(javax.websocket.Session session, javax.websocket.EndpointConfig config)
void	registerMessageReceiver(WSMessageReceiver messageReceiver) Register new WSMessageReceiver for this connection.
void	removeAttribute(String name) Removes the object bound with the specified name from this connection.
void	removeMessageReceiver(WSMessageReceiver messageReceiver) Unregister WSMessageReceiver.
void	sendMessage(OutputMessage output) Send message to client.
void	setAttribute(String name, Object value) Binds an object to this connection, using the name specified.
boolean	subscribeToChannel(String channel) Subscribe this connection to specified channel.
String	toString()
boolean	unsubscribeFromChannel(String channel) Unsubscribe this connection from specified channel.

Methods inherited from class java.lang.Object

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

Constructor Detail

WSConnectionImpl

public WSConnectionImpl()

Method Detail

onOpen

public void onOpen(javax.websocket.Session session,
                   javax.websocket.EndpointConfig config)

Specified by:

onOpen in class javax.websocket.Endpoint

onClose

public void onClose(javax.websocket.Session session,
                    javax.websocket.CloseReason closeReason)

Overrides:

onClose in class javax.websocket.Endpoint

onError

public void onError(javax.websocket.Session session,
                    Throwable thr)

Overrides:

onError in class javax.websocket.Endpoint

getId

public Long getId()

Description copied from interface: WSConnection

Get unique connection identifier.

Specified by:

getId in interface WSConnection

Returns:

unique connection identifier

getHttpSession

public javax.servlet.http.HttpSession getHttpSession()

Description copied from interface: WSConnection

Get HTTP session associated to this connection.

Specified by:

getHttpSession in interface WSConnection

Returns:

HTTP session associated to this connection

getWsSession

public javax.websocket.Session getWsSession()

Specified by:

getWsSession in interface WSConnection

subscribeToChannel

public boolean subscribeToChannel(String channel)

Description copied from interface: WSConnection

Subscribe this connection to specified channel.

Specified by:

subscribeToChannel in interface WSConnection

Parameters:

channel - channel name

Returns:

true if this connection is subscribed to channel successfully and false if connection already subscribed to specified channel

See Also:

WSConnectionContext.sendMessage(org.everrest.websockets.message.ChannelBroadcastMessage)

unsubscribeFromChannel

public boolean unsubscribeFromChannel(String channel)

Description copied from interface: WSConnection

Unsubscribe this connection from specified channel.

Specified by:

unsubscribeFromChannel in interface WSConnection

Parameters:

channel - channel name

Returns:

true if this connection is unsubscribed from channel successfully and false if connection is not subscribed to specified channel

See Also:

WSConnectionContext.sendMessage(org.everrest.websockets.message.ChannelBroadcastMessage)

getChannels

public Collection<String> getChannels()

Description copied from interface: WSConnection

Get optional set of channels assigned for this connection. Channel may be used for sending the same message to more than one connection at one time.

Specified by:

getChannels in interface WSConnection

Returns:

unmodifiable set of channel names this connection subscribed

See Also:

WSConnectionContext.sendMessage(org.everrest.websockets.message.ChannelBroadcastMessage)

isConnected

public boolean isConnected()

Description copied from interface: WSConnection

Check connection state.

Specified by:

isConnected in interface WSConnection

Returns:

true if connection is alive and false if connection already closed.

close

public void close()
           throws IOException

Description copied from interface: WSConnection

Close this connection with 1000 status which indicates a normal closure.

Specified by:

close in interface WSConnection

Throws:

IOException - if any i/o error occurs

close

public void close(int status,
                  String message)
           throws IOException

Description copied from interface: WSConnection

Close this connection with specified status and message.

Specified by:

close in interface WSConnection

Parameters:

status - connection close status

message - optional message

Throws:

IOException - if any i/o error occurs

getCloseStatus

public int getCloseStatus()

Description copied from interface: WSConnection

Get connection close status. If connection is alive or not opened yet this method return 0.

Specified by:

getCloseStatus in interface WSConnection

Returns:

connection close status or 0 if connection is alive or not opened yet

sendMessage

public void sendMessage(OutputMessage output)
                 throws javax.websocket.EncodeException,
                        IOException

Description copied from interface: WSConnection

Send message to client.

Specified by:

sendMessage in interface WSConnection

Parameters:

output - output message

Throws:

javax.websocket.EncodeException - if message cannot be serialized

IOException - if any i/o error occurs when try to send message to client

registerMessageReceiver

public void registerMessageReceiver(WSMessageReceiver messageReceiver)

Description copied from interface: WSConnection

Register new WSMessageReceiver for this connection.

Specified by:

registerMessageReceiver in interface WSConnection

Parameters:

messageReceiver - message receiver

removeMessageReceiver

public void removeMessageReceiver(WSMessageReceiver messageReceiver)

Description copied from interface: WSConnection

Unregister WSMessageReceiver.

Specified by:

removeMessageReceiver in interface WSConnection

Parameters:

messageReceiver - message receiver

getAttribute

public Object getAttribute(String name)

Description copied from interface: WSConnection

Returns the object bound with the specified name in this connection, or null if no object is bound under the name.

Specified by:

getAttribute in interface WSConnection

Parameters:

name - a string specifying the name of the object

Returns:

the object with the specified name

setAttribute

public void setAttribute(String name,
                         Object value)

Description copied from interface: WSConnection

Binds an object to this connection, using the name specified. If an object of the same name is already bound to the connection, the object is replaced.

Specified by:

setAttribute in interface WSConnection

Parameters:

name - the name to which the object is bound; cannot be null

value - the object to be bound

removeAttribute

public void removeAttribute(String name)

Description copied from interface: WSConnection

Removes the object bound with the specified name from this connection. If the connection does not have an object bound with the specified name, this method does nothing.

Specified by:

removeAttribute in interface WSConnection

Parameters:

name - the name of the object to remove from this connection

toString

public String toString()

Overrides:

toString in class Object