io.mats3.matssocket

Class MatsSocketServer.MatsSocketSessionDto

java.lang.Object

io.mats3.matssocket.MatsSocketServer.MatsSocketSessionDto

All Implemented Interfaces:

MatsSocketServer.MatsSocketSession

Direct Known Subclasses:

MatsSocketServer.ActiveMatsSocketSessionDto

Enclosing interface:

MatsSocketServer

public static class MatsSocketServer.MatsSocketSessionDto
extends java.lang.Object
implements MatsSocketServer.MatsSocketSession

Implementation of MatsSocketServer.MatsSocketSession, which is serializable both for MatsSocket and Mats, i.e. serialization mechanisms using field-based serialization.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	an
java.lang.String	av
java.lang.String	clv
java.lang.String	id
java.lang.String	nn
long	scts
long	slts
java.lang.String	uid

Constructor Summary

Constructors

Constructor and Description
MatsSocketSessionDto()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAppName() Note: Do realize that it is the Client that specifies this value, there is no restriction and you cannot trust that this String falls within your expected values.
java.lang.String	getAppVersion() Note: Do realize that it is the Client that specifies this value, there is no restriction and you cannot trust that this String falls within your expected values.
java.lang.String	getClientLibAndVersions() Note: Do realize that it is the Client that specifies this value, there is no restriction and you cannot trust that this String falls within your expected values.
java.lang.String	getMatsSocketSessionId()
java.util.Optional<java.lang.String>	getNodeName()
java.time.Instant	getSessionCreatedTimestamp()
java.time.Instant	getSessionLivelinessTimestamp()
java.lang.String	getUserId()

Methods inherited from class java.lang.Object

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

Field Detail

id

public java.lang.String id

uid

public java.lang.String uid

scts

public long scts

slts

public long slts

clv

public java.lang.String clv

an

public java.lang.String an

av

public java.lang.String av

nn

public java.lang.String nn

Constructor Detail

MatsSocketSessionDto

public MatsSocketSessionDto()

Method Detail

getMatsSocketSessionId

public java.lang.String getMatsSocketSessionId()

Specified by:

getMatsSocketSessionId in interface MatsSocketServer.MatsSocketSession

Returns:

the MatsSocketSessionId of this MatsSocketSession.

getUserId

public java.lang.String getUserId()

Specified by:

getUserId in interface MatsSocketServer.MatsSocketSession

Returns:

the userId owning this MatsSocketSession.

getSessionCreatedTimestamp

public java.time.Instant getSessionCreatedTimestamp()

Specified by:

getSessionCreatedTimestamp in interface MatsSocketServer.MatsSocketSession

Returns:

when the MatsSocketSession and its Id was initially created. Will not be reset due to cycles of MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType.DEREGISTER and MatsSocketServer.SessionEstablishedEvent.SessionEstablishedEventType.RECONNECT, as MatsSocketServer.ActiveMatsSocketSession.getSessionEstablishedTimestamp() does.

getSessionLivelinessTimestamp

public java.time.Instant getSessionLivelinessTimestamp()

Specified by:

getSessionLivelinessTimestamp in interface MatsSocketServer.MatsSocketSession

Returns:

if this is an instance of MatsSocketServer.ActiveMatsSocketSessionDto, effectively returns System.currentTimeMillis() of when MatsSocketServer.getActiveMatsSocketSessions() was invoked, as it was live at the time of invocation). If this is an instance of MatsSocketServer.LiveMatsSocketSession, it literally returns System.currentTimeMillis(), as it is live right now. If this is an instance of MatsSocketServer.MatsSocketSessionDto, the reason you have this instance is that its contents was read from the data store using MatsSocketServer.getMatsSocketSessions(boolean, String, String, String), and then this method returns last "liveliness update" from the data store, which is the last time this MatsSocketSession registered (i.e. became SESSION_ESTABLISHED), or from later periodic updates every few minutes while it is/was active.

getClientLibAndVersions

public java.lang.String getClientLibAndVersions()

Description copied from interface: MatsSocketServer.MatsSocketSession

Note: Do realize that it is the Client that specifies this value, there is no restriction and you cannot trust that this String falls within your expected values.

Specified by:

getClientLibAndVersions in interface MatsSocketServer.MatsSocketSession

Returns:

a descriptive String representing which MatsSocket Client lib is in use ("name,version"), with additional runtime "name and version" information tacked on separated by ";". For MatsSocket.js, this may read as follows: "MatsSocket.js,v0.10.0; User-Agent: {userAgentString}", or "MatsSocket.js,v0.10.0; Node.js: {node version}". For MatsSocket.dart, it could read "MatsSocket.dart,v0.10.0; Dart: {dart version}; Flutter: {flutter SDK version}", or "MatsSocket.dart,v0.10.0; Dart: {dart version}; User-Agent: {userAgentString}"

getAppName

public java.lang.String getAppName()

Description copied from interface: MatsSocketServer.MatsSocketSession

Note: Do realize that it is the Client that specifies this value, there is no restriction and you cannot trust that this String falls within your expected values.

Specified by:

getAppName in interface MatsSocketServer.MatsSocketSession

Returns:

the "AppName" that the Client registers as, could be something like "MegaCorpWebBank". This should be rather long-term, not changing between versions of this particular application. It may be used to distinguish between two different apps using the same MatsSocketServer instance, where one of them handles Server-to-Client Requests of type "UserInfo.getCurrentGpsPosition", while the other app does not have this endpoint.

getAppVersion

public java.lang.String getAppVersion()

Description copied from interface: MatsSocketServer.MatsSocketSession

Note: Do realize that it is the Client that specifies this value, there is no restriction and you cannot trust that this String falls within your expected values.

Specified by:

getAppVersion in interface MatsSocketServer.MatsSocketSession

Returns:

the "AppVersion" that the Client registers as, could be something like "1.2.3-2020-04-07_beta". This should be something sane, preferably which can be alphanum-compared, so that the server could know that at-or-above "1.2.1xxxx", the app "MegaCorpWebBank" handles Server-to-Client Requests of type "UserInfo.getCurrentGpsPosition", but before this version, that particular endpoint was not available.

getNodeName

public java.util.Optional<java.lang.String> getNodeName()

Specified by:

getNodeName in interface MatsSocketServer.MatsSocketSession

Returns:

the name of the node that holds the LiveMatsSocketSession if it is active (i.e. state=SESSION_ESTABLISHED), Optional.empty() if not active. Will always return non-empty on an MatsSocketServer.ActiveMatsSocketSession and MatsSocketServer.LiveMatsSocketSession instance.