com.pushtechnology.diffusion.client.features.control.clients

Class ClientControl.SessionPropertiesStream.Default

java.lang.Object

com.pushtechnology.diffusion.client.callbacks.Callback.Default

com.pushtechnology.diffusion.client.callbacks.Stream.Default

com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionPropertiesStream.Default

All Implemented Interfaces:

Callback, Stream, ClientControl.SessionPropertiesStream

Enclosing interface:

ClientControl.SessionPropertiesStream

public static class ClientControl.SessionPropertiesStream.Default
extends Stream.Default
implements ClientControl.SessionPropertiesStream

This provides a default implementation of ClientControl.SessionPropertiesListener which will simply log session properties callbacks at debug level. This should only be used for diagnostic purposes.

Nested Class Summary

Nested classes/interfaces inherited from interface com.pushtechnology.diffusion.client.features.control.clients.ClientControl.SessionPropertiesStream

ClientControl.SessionPropertiesStream.Default, ClientControl.SessionPropertiesStream.EventType

Constructor Summary

Constructors

Constructor and Description
Default()

Method Summary

Modifier and Type	Method and Description
void	onSessionClose(SessionId sessionId, Map<String,String> properties, ClientControl.CloseReason closeReason) Notification that a client session has closed.
void	onSessionEvent(SessionId sessionId, ClientControl.SessionPropertiesStream.EventType eventType, Map<String,String> properties, Map<String,String> previousValues) Notification of a session event that can result in a change of properties.
void	onSessionOpen(SessionId sessionId, Map<String,String> properties) Notification that a new client session has been opened.

Methods inherited from class com.pushtechnology.diffusion.client.callbacks.Stream.Default

onClose

Methods inherited from class com.pushtechnology.diffusion.client.callbacks.Callback.Default

onError

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pushtechnology.diffusion.client.callbacks.Stream

onClose

Methods inherited from interface com.pushtechnology.diffusion.client.callbacks.Callback

onError

Constructor Detail

Default

public Default()

Method Detail

onSessionOpen

public void onSessionOpen(SessionId sessionId,
                          Map<String,String> properties)

Description copied from interface: ClientControl.SessionPropertiesStream

Notification that a new client session has been opened.

When the listener is registered, this will be called for all existing sessions. It will then be called for every new session that opens whilst the listener is registered.

This will be called for every client session regardless of requested session properties.

Specified by:

onSessionOpen in interface ClientControl.SessionPropertiesStream

Parameters:

sessionId - the session identifier

properties - the map of requested session property values. This can be empty if no properties were requested. If a requested property did not exist, it will not be present in the map.

onSessionEvent

public void onSessionEvent(SessionId sessionId,
                           ClientControl.SessionPropertiesStream.EventType eventType,
                           Map<String,String> properties,
                           Map<String,String> previousValues)

Description copied from interface: ClientControl.SessionPropertiesStream

Notification of a session event that can result in a change of properties.

Specified by:

onSessionEvent in interface ClientControl.SessionPropertiesStream

Parameters:

sessionId - the client session id

eventType - indicates the type of event

properties - the map of current requested property values. This can be empty if no properties were requested. If a requested property did not exist, it will not be present in the map.

previousValues - a map of the previous values of keys that have changed. This will only contain keys that have changed and not the whole required property set. This can be empty if an event is being reported that did not result in the change of any of the required properties. When a new property is added, the value in this map will be null. When a property is removed, it will have a value in this map but not in properties.

onSessionClose

public void onSessionClose(SessionId sessionId,
                           Map<String,String> properties,
                           ClientControl.CloseReason closeReason)

Description copied from interface: ClientControl.SessionPropertiesStream

Notification that a client session has closed.

This will be called for every client that closes whilst the listener is registered regardless of requested session properties.

Specified by:

onSessionClose in interface ClientControl.SessionPropertiesStream

Parameters:

sessionId - the session identifier of the client that has closed

properties - the map of requested property values at the point when the session was closed. This can be empty if no properties were requested. If a requested property did not exist, it will not be present in the map.

closeReason - why the session was closed