Package io.mats3.matssocket

Class MatsSocketServer.ActiveMatsSocketSessionDto

java.lang.Object

io.mats3.matssocket.MatsSocketServer.MatsSocketSessionDto

io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto

All Implemented Interfaces:

MatsSocketServer.ActiveMatsSocketSession, MatsSocketServer.MatsSocketSession

Enclosing interface:

MatsSocketServer

public static class MatsSocketServer.ActiveMatsSocketSessionDto
extends MatsSocketServer.MatsSocketSessionDto
implements MatsSocketServer.ActiveMatsSocketSession

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

Nested Class Summary

Nested classes/interfaces inherited from interface io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSession

MatsSocketServer.ActiveMatsSocketSession.MatsSocketSessionState

Field Summary

Fields

Modifier and Type	Field	Description
String	auth
long	lactts
long	lauthts
long	lcpts
List<MatsSocketServer.MatsSocketEnvelopeWithMetaDto>	msgs
String	ocrip
String	pn
String	rip
long	sets
SortedSet<String>	subs

Fields inherited from class io.mats3.matssocket.MatsSocketServer.MatsSocketSessionDto

an, av, clv, id, nn, scts, slts, uid

Constructor Summary

Constructors

Constructor	Description
ActiveMatsSocketSessionDto()

Method Summary

Modifier and Type	Method	Description
Optional<String>	getAuthorization()
Instant	getLastActivityTimestamp()
Instant	getLastAuthenticatedTimestamp()
Instant	getLastClientPingTimestamp()
List<MatsSocketServer.MatsSocketEnvelopeWithMetaDto>	getLastEnvelopes()
Optional<String>	getOriginatingRemoteAddr()	The AuthenticationPlugin can set the originating remote IP address - which must be derived by headers like X-Forwarded-For (Wikipedia).
Optional<String>	getPrincipalName()
Optional<String>	getRemoteAddr()	If we have a way to find the connected (remote) address, it will be exposed here.
Instant	getSessionEstablishedTimestamp()
SortedSet<String>	getTopicSubscriptions()

Methods inherited from class io.mats3.matssocket.MatsSocketServer.MatsSocketSessionDto

getAppName, getAppVersion, getClientLibAndVersions, getMatsSocketSessionId, getNodeName, getSessionCreatedTimestamp, getSessionLivelinessTimestamp, getUserId

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.mats3.matssocket.MatsSocketServer.MatsSocketSession

getAppName, getAppVersion, getClientLibAndVersions, getMatsSocketSessionId, getNodeName, getSessionCreatedTimestamp, getSessionLivelinessTimestamp, getUserId

Field Details

auth

public String auth

pn

public String pn

rip

public String rip

ocrip

public String ocrip

subs

public SortedSet<String> subs

sets

public long sets

lauthts

public long lauthts

lcpts

public long lcpts

lactts

public long lactts

msgs

public List<MatsSocketServer.MatsSocketEnvelopeWithMetaDto> msgs

Constructor Details

ActiveMatsSocketSessionDto

public ActiveMatsSocketSessionDto()

Method Details

getAuthorization

public Optional<String> getAuthorization()

Specified by:

getAuthorization in interface MatsSocketServer.ActiveMatsSocketSession

Returns:

the active Authorization value, only available when MatsSocketServer.ActiveMatsSocketSession.MatsSocketSessionState.SESSION_ESTABLISHED.

getPrincipalName

public Optional<String> getPrincipalName()

Specified by:

getPrincipalName in interface MatsSocketServer.ActiveMatsSocketSession

Returns:

The name of the Principal, as returned by Principal.getName(), only available when MatsSocketServer.ActiveMatsSocketSession.MatsSocketSessionState.SESSION_ESTABLISHED.

getRemoteAddr

public Optional<String> getRemoteAddr()

Description copied from interface: MatsSocketServer.ActiveMatsSocketSession

If we have a way to find the connected (remote) address, it will be exposed here. It can be set/overridden in the AuthenticationPlugin. Be advised that when the WebSocket Server (i.e. Servlet Container) is behind a proxy, you will get the proxy's address, not the end client's address, aka originating IP address. This can, if you add the functionality to the AuthenticationPlugin, be gotten by MatsSocketServer.ActiveMatsSocketSession.getOriginatingRemoteAddr().

Note: The remote address is not exposed by the JSR 356 Java API for WebSockets - but there are hacks for different Servlet Containers to get it anyway. Check out class RemoteAddressContainerHacks.

Specified by:

getRemoteAddr in interface MatsSocketServer.ActiveMatsSocketSession

Returns:

the remote address if available (should be an IP address).

getOriginatingRemoteAddr

public Optional<String> getOriginatingRemoteAddr()

Description copied from interface: MatsSocketServer.ActiveMatsSocketSession

The AuthenticationPlugin can set the originating remote IP address - which must be derived by headers like X-Forwarded-For (Wikipedia). Note the problems with this header: Since the originating client can set whatever he wants as initial value, you cannot rely on the "first IP address in the list", as this might well be bogus. You must go from the last and work your way up, and only trust the information given by proxies you are in control of: The first IP address in the list that you do not know, is what you should set as originating remote address. Each proxy adds the remote address that he sees (i.e. who is the remote address for him). This means that the last proxy's ip address is not in the list - this must be gotten by MatsSocketServer.ActiveMatsSocketSession.getRemoteAddr().

Specified by:

getOriginatingRemoteAddr in interface MatsSocketServer.ActiveMatsSocketSession

Returns:

the originating remote address if AuthenticationPlugin has set it (should be an IP address).

getTopicSubscriptions

public SortedSet<String> getTopicSubscriptions()

Specified by:

getTopicSubscriptions in interface MatsSocketServer.ActiveMatsSocketSession

Returns:

which Topics this session has subscribed to.

getSessionEstablishedTimestamp

public Instant getSessionEstablishedTimestamp()

Specified by:

getSessionEstablishedTimestamp in interface MatsSocketServer.ActiveMatsSocketSession

Returns:

when this MatsSocketSession was established - this timestamp is "reset" on every RECONNECT (and of course set on initial connect, i.e. NEW), as opposed to MatsSocketServer.MatsSocketSession.getSessionCreatedTimestamp() which is set a single time when the session if first created.

getLastAuthenticatedTimestamp

public Instant getLastAuthenticatedTimestamp()

Specified by:

getLastAuthenticatedTimestamp in interface MatsSocketServer.ActiveMatsSocketSession

Returns:

timestamp (millis-since-epoch) of when we the client was last authenticated: When AuthenticationPlugin.SessionAuthenticator.initialAuthentication(AuthenticationContext, String) returned AuthenticationPlugin.AuthenticationContext.authenticated(Principal, String), or when AuthenticationPlugin.SessionAuthenticator.reevaluateAuthentication(AuthenticationContext, String, Principal) returned AuthenticationPlugin.AuthenticationContext.authenticated(Principal, String) or AuthenticationPlugin.AuthenticationContext.stillValid().

getLastClientPingTimestamp

public Instant getLastClientPingTimestamp()

Specified by:

getLastClientPingTimestamp in interface MatsSocketServer.ActiveMatsSocketSession

Returns:

timestamp (millis-since-epoch) of when we last received a PING message from the Client.

getLastActivityTimestamp

public Instant getLastActivityTimestamp()

Specified by:

getLastActivityTimestamp in interface MatsSocketServer.ActiveMatsSocketSession

Returns:

timestamp (millis-since-epoch) of when the Server last received an information bearing message (SEND, REQUEST, RESOLVE or REJECT) from the Client, or when the Server last sent an information bearing message (SEND, REQUEST, RESOLVE, REJECT or PUB) to the Client

getLastEnvelopes

public List<MatsSocketServer.MatsSocketEnvelopeWithMetaDto> getLastEnvelopes()

Specified by:

getLastEnvelopes in interface MatsSocketServer.ActiveMatsSocketSession

Returns:

snapshot (i.e. newly created ArrayList) of last 200 (per default) envelopes going between client and server in both directions.