Index (matssocket-server-api 0.19.0-2022-11-11 API)

A B C D E F G H I L M N O P R S T U V W X
All Classes and Interfaces|All Packages|Serialized Form

A

ACK - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MessageType: The specified message was Received, and acknowledged positively - i.e.
ACK2 - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MessageType: An "Acknowledge ^ 2", i.e.
ActiveMatsSocketSessionDto() - Constructor for class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto
adaptReply(MatsSocketServer.MatsSocketEndpointReplyContext<I, MR, R>, MR) - Method in interface io.mats3.matssocket.MatsSocketServer.ReplyAdapter
addMessageEventListener(MatsSocketServer.MessageEventListener) - Method in interface io.mats3.matssocket.MatsSocketServer: MessageEventListeners will be invoked for every processed incoming and outgoing message for any session.
addSessionEstablishedEventListener(MatsSocketServer.SessionEstablishedEventListener) - Method in interface io.mats3.matssocket.MatsSocketServer: SessionEstablishedEvent listeners will be invoked when an LiveMatsSocketSession is established on this node of the MatsSocketServer instance cluster, i.e.
addSessionRemovedEventListener(MatsSocketServer.SessionRemovedEventListener) - Method in interface io.mats3.matssocket.MatsSocketServer: MatsSocketServer.SessionRemovedEvent listeners will be invoked when an MatsSocketServer.LiveMatsSocketSession is removed from this node of the MatsSocketServer instance cluster - this is both when a MatsSocketSession is DEREGISTERed, in which case the Client can still RECONNECT to the same MatsSocketSessionId, and when a MatsSocketSession is CLOSEd or TIMEOUTed.
an - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto
an - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.LogLineDto
an - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketSessionDto
auth - Variable in class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto
auth - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto
AUTH - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MessageType: From Client: The client can use a separate AUTH message to send over the requested MatsSocketServer.MessageType.REAUTH (it could just as well put the 'auth' in a PING or any other message it had pending).
authenticated(Principal, String) - Method in interface io.mats3.matssocket.AuthenticationPlugin.AuthenticationContext: Good Authentication! Return the result from this method from SessionAuthenticator.initialAuthentication(..) to denote good authentication, supplying a Principal representing the accessing user, and the UserId of this user.
authenticated(Principal, String, EnumSet<AuthenticationPlugin.DebugOption>) - Method in interface io.mats3.matssocket.AuthenticationPlugin.AuthenticationContext: Good Authentication! Variant of AuthenticationPlugin.AuthenticationContext.authenticated(Principal, String) that grants the authenticated user special abilities to ask for debug info of the performed call.
AuthenticationPlugin - Interface in io.mats3.matssocket: Plugin that must evaluate whether a WebSocket connection shall be allowed, and then authenticate the resulting MatsSocketSession.
AuthenticationPlugin.AuthenticationContext - Interface in io.mats3.matssocket
AuthenticationPlugin.AuthenticationResult - Interface in io.mats3.matssocket: You are NOT supposed to implement this interface! Instances of this interface are created by methods on the AuthenticationPlugin.AuthenticationContext, which you are supposed to return from the AuthenticationPlugin.SessionAuthenticator to inform the MatsSocketServer about your verdict of the authentication attempt.
AuthenticationPlugin.DebugOption - Enum Class in io.mats3.matssocket: These bit-field enums (bit-field) is used by the Client to request different types of debug/meta information from Server-side, and used by the AuthenticationPlugin to tell the MatsSocketServer which types of information the specific user is allowed to request - the resulting debug/meta information provided is the intersection of the requested + allowed.
AuthenticationPlugin.SessionAuthenticator - Interface in io.mats3.matssocket: An instance of this interface shall be returned upon invocation of AuthenticationPlugin.newSessionAuthenticator().
authorizeUserForTopic(AuthenticationPlugin.AuthenticationContext, String) - Method in interface io.mats3.matssocket.AuthenticationPlugin.SessionAuthenticator: Decide whether the specified Principal/User should be allowed to subscribe to the specified Topic.
av - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto
av - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.LogLineDto
av - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketSessionDto

B

boot() - Method in interface io.mats3.matssocket.ClusterStoreAndForward: Start the ClusterStoreAndForward, perform DB preparations and migrations.

C

C2S - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto.Direction: Client-to-Server.
checkHandshake(ServerEndpointConfig, HandshakeRequest, HandshakeResponse) - Method in interface io.mats3.matssocket.AuthenticationPlugin.SessionAuthenticator: Implement this if you want to do a check on any other header values, e.g.
checkOrigin(String) - Method in interface io.mats3.matssocket.AuthenticationPlugin.SessionAuthenticator: Implement this if you want to do a check on the Origin header value while the initial WebSocket Upgrade/Handshake request is still being processed.
clone() - Method in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto
CLOSE - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType: The MatsSocketSession was explicitly closed.
CLOSE_SESSION - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketCloseCodes: 4000: Both from Server side and Client/Browser side, client should REJECT all outstanding: From Client/Browser: Used when the client closes WebSocket "on purpose", wanting to close the session - typically when the user explicitly logs out, or navigates away from web page.
CLOSED - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSession.MatsSocketSessionState: This MatsSocketServer.ActiveMatsSocketSession instance is dead - and the MatsSocketSession that this MatsSocketServer.ActiveMatsSocketSession represented was CLOSED - i.e.
closeSession(String) - Method in interface io.mats3.matssocket.ClusterStoreAndForward: Invoked when the client explicitly tells us that he closed this session, CLOSE_SESSION.
closeSession(String, String) - Method in interface io.mats3.matssocket.MatsSocketServer: Closes the specified MatsSocketSession - can be used to forcibly close an active MatsSocketSession (i.e.
ClusterStoreAndForward - Interface in io.mats3.matssocket: MatsSockets forwards requests from WebSocket-connected clients to a Mats Endpoint, and must get the reply back to the client.
ClusterStoreAndForward.CurrentNode - Interface in io.mats3.matssocket
ClusterStoreAndForward.DataAccessException - Exception in io.mats3.matssocket: If having problems accessing the underlying common data store.
ClusterStoreAndForward.MessageIdAlreadyExistsException - Exception in io.mats3.matssocket: Thrown if the operation resulted in a Unique Constraint situation.
ClusterStoreAndForward.RequestCorrelation - Interface in io.mats3.matssocket
ClusterStoreAndForward.SimpleCurrentNode - Class in io.mats3.matssocket
ClusterStoreAndForward.SimpleRequestCorrelation - Class in io.mats3.matssocket
ClusterStoreAndForward.SimpleStoredInMessage - Class in io.mats3.matssocket
ClusterStoreAndForward.SimpleStoredOutMessage - Class in io.mats3.matssocket
ClusterStoreAndForward.StoredInMessage - Interface in io.mats3.matssocket
ClusterStoreAndForward.StoredOutMessage - Interface in io.mats3.matssocket
ClusterStoreAndForward.WrongUserException - Exception in io.mats3.matssocket: Thrown from ClusterStoreAndForward.registerSessionAtThisNode(String, String, String, String, String, String) if the userId does not match the original userId that created this session.
clv - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto
clv - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketSessionDto
cmid - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto
cmrnn - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.DebugDto
cmrts - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.DebugDto
CUSTOM_A - Enum constant in enum class io.mats3.matssocket.AuthenticationPlugin.DebugOption: AuthenticationPlugin-specific "Option A" - this is not used by MatsSocket itself, but can be employed and given a meaning by the AuthenticationPlugin.
CUSTOM_B - Enum constant in enum class io.mats3.matssocket.AuthenticationPlugin.DebugOption: AuthenticationPlugin-specific "Option B" - this is not used by MatsSocket itself, but can be employed and given a meaning by the AuthenticationPlugin.

D

DataAccessException(String) - Constructor for exception io.mats3.matssocket.ClusterStoreAndForward.DataAccessException
DataAccessException(String, Throwable) - Constructor for exception io.mats3.matssocket.ClusterStoreAndForward.DataAccessException
DataStoreException(String) - Constructor for exception io.mats3.matssocket.MatsSocketServer.DataStoreException
DataStoreException(String, Throwable) - Constructor for exception io.mats3.matssocket.MatsSocketServer.DataStoreException
debug - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto
DebugDto() - Constructor for class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.DebugDto
deleteMessageIdsFromInbox(String, Collection<String>) - Method in interface io.mats3.matssocket.ClusterStoreAndForward: Deletes the incoming message Ids, as we've established that the client will never try to send this particular message again.
deny() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointIncomingContext: Invoke if you want to deny this message from being processed, e.g.
DENY - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto.IncomingResolution: The IncomingHandler sent NACK ("Negative Acknowledgement"), signifying that it did not want to process the message, typically because the authenticated user was not allowed to perform the requested action (i.e.
DEREGISTER - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType: The WebSocket connection was severed without an explicit MatsSocketSession closing, e.g.
DEREGISTERED - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSession.MatsSocketSessionState: This MatsSocketServer.ActiveMatsSocketSession instance is dead - but the MatsSocketSession that this MatsSocketServer.ActiveMatsSocketSession represented is still "live" in the data store, i.e.
deregisterSessionFromThisNode(String, String) - Method in interface io.mats3.matssocket.ClusterStoreAndForward: Deregisters a Session home when a WebSocket is closed.
desc - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto
dir - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto
DISCONNECT - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketCloseCodes: 4003: From Server side: Currently used in the specific situation where a MatsSocket client connects with the same MatsSocketSessionId as an existing open WebSocket connection.

E

eid - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto

enumSetOf(int) - Static method in enum class io.mats3.matssocket.AuthenticationPlugin.DebugOption

enumSetOf(Integer) - Static method in enum class io.mats3.matssocket.AuthenticationPlugin.DebugOption

EXCEPTION - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto.IncomingResolution

The IncomingHandler raised an Exception.

F

flags(EnumSet<AuthenticationPlugin.DebugOption>) - Static method in enum class io.mats3.matssocket.AuthenticationPlugin.DebugOption

fmeid - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto

forward(String, Object, MatsInitiator.InitiateLambda) - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointIncomingContext

Generic forward method.

FORWARD - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto.IncomingResolution

The IncomingHandler forwarded the SEND or REQUEST to a Mats Endpoint.

forwardEssential(String, Object) - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointIncomingContext

Employ this for Requests or Sends whose call flow can potentially change state in the system.

forwardNonessential(String, Object) - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointIncomingContext

Employ this for pure, non-state changing "GET-style" Requests, or Sends for e.g.

G

getActiveMatsSocketSessions() - Method in interface io.mats3.matssocket.MatsSocketServer

This returns static, frozen-in-time, "copied-out" DTO-variants of the LiveMatsSocketSessions.

getAllowedDebugOptions() - Method in interface io.mats3.matssocket.MatsSocketServer.LiveMatsSocketSession

getAllowedDebugOptions() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointIncomingContext

getAndDeleteRequestCorrelation(String, String) - Method in interface io.mats3.matssocket.ClusterStoreAndForward

getAppName() - Method in interface io.mats3.matssocket.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.

getAppName() - Method in class io.mats3.matssocket.MatsSocketServer.MatsSocketSessionDto

getAppVersion() - Method in interface io.mats3.matssocket.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.

getAppVersion() - Method in class io.mats3.matssocket.MatsSocketServer.MatsSocketSessionDto

getAttemptTimestamp() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleStoredOutMessage

getAttemptTimestamp() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.StoredOutMessage

getAuthorization() - Method in interface io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSession

getAuthorization() - Method in class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto

getAuthorizationValue() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointIncomingContext

getClientLibAndVersions() - Method in interface io.mats3.matssocket.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.

getClientLibAndVersions() - Method in class io.mats3.matssocket.MatsSocketServer.MatsSocketSessionDto

getClientMessageId() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleStoredInMessage

getClientMessageId() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleStoredOutMessage

getClientMessageId() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.StoredInMessage

getClientMessageId() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.StoredOutMessage

getCloseCode() - Method in interface io.mats3.matssocket.MatsSocketServer.SessionRemovedEvent

getCloseCode(int) - Static method in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketCloseCodes

getCode() - Method in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketCloseCodes

getConnectionId() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.CurrentNode

getConnectionId() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleCurrentNode

getCorrelationBinary() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.RequestCorrelation

getCorrelationBinary() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleRequestCorrelation

getCorrelationBinary() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointIncomingContext

If this is a Client Reply from a Server-to-Client request, this method returns the 'correlationBinary' that was provided in the request.

getCorrelationString() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.RequestCorrelation

getCorrelationString() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleRequestCorrelation

getCorrelationString() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointIncomingContext

If this is a Client Reply from a Server-to-Client request, this method returns the 'correlationString' that was provided in the request.

getCurrentRegisteredNodeForSession(String) - Method in interface io.mats3.matssocket.ClusterStoreAndForward

getDeliveryCount() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleStoredOutMessage

getDeliveryCount() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.StoredOutMessage

getEnvelope() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleStoredOutMessage

getEnvelope() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.StoredOutMessage

getEnvelopes() - Method in interface io.mats3.matssocket.MatsSocketServer.MessageEvent

getFullEnvelope() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleStoredInMessage

getFullEnvelope() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.StoredInMessage

getHandshakeRequest() - Method in interface io.mats3.matssocket.AuthenticationPlugin.AuthenticationContext

getIncomingClass() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpoint

getLastActivityTimestamp() - Method in interface io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSession

getLastActivityTimestamp() - Method in class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto

getLastAuthenticatedTimestamp() - Method in interface io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSession

getLastAuthenticatedTimestamp() - Method in class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto

getLastClientPingTimestamp() - Method in interface io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSession

getLastClientPingTimestamp() - Method in class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto

getLastEnvelopes() - Method in interface io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSession

getLastEnvelopes() - Method in class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto

getLiveMatsSocketSessions() - Method in interface io.mats3.matssocket.MatsSocketServer

Imagine that the MatsSocketServer uses a ConcurrentMap to keep its set of local, live, currently connected MatsSocketSessions.

getMatsContext() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointReplyContext

getMatsInitiate() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointIncomingContext

Using the returned MatsInitiate instance, which is the same as the forwardXX(..) methods utilize, you can initiate one or several Mats flows, in addition to your actual handling of the incoming message - within the same Mats transactional demarcation as the handling of the incoming message ("actual handling" referring to forward, resolve, reject or even deny or ignore - the latter two being a bit hard to understand why you'd want).

getMatsReplyClass() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpoint

getMatsReplyMessage() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointReplyContext

getMatsSocketEndpoint() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointContext

getMatsSocketEndpointId() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpoint

getMatsSocketEndpointId() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointContext

Convenience method, default implementation is this.getMatsSocketEndpoint().getMatsSocketEndpointId().

getMatsSocketEndpoints() - Method in interface io.mats3.matssocket.MatsSocketServer

getMatsSocketIncomingMessage() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointIncomingContext

getMatsSocketSession() - Method in interface io.mats3.matssocket.AuthenticationPlugin.AuthenticationContext

getMatsSocketSession() - Method in interface io.mats3.matssocket.MatsSocketServer.MessageEvent

getMatsSocketSession() - Method in interface io.mats3.matssocket.MatsSocketServer.SessionEstablishedEvent

getMatsSocketSessionId() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.RequestCorrelation

getMatsSocketSessionId() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleRequestCorrelation

getMatsSocketSessionId() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleStoredInMessage

getMatsSocketSessionId() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleStoredOutMessage

getMatsSocketSessionId() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.StoredInMessage

getMatsSocketSessionId() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.StoredOutMessage

getMatsSocketSessionId() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointIncomingContext

getMatsSocketSessionId() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketSession

getMatsSocketSessionId() - Method in class io.mats3.matssocket.MatsSocketServer.MatsSocketSessionDto

getMatsSocketSessionId() - Method in interface io.mats3.matssocket.MatsSocketServer.SessionEstablishedEvent

getMatsSocketSessionId() - Method in interface io.mats3.matssocket.MatsSocketServer.SessionRemovedEvent

getMatsSocketSessions(boolean, String, String, String) - Method in interface io.mats3.matssocket.MatsSocketServer

Unless restricted by the "constraint parameters", this method returns all MatsSocketSessions on this MatsSocketServer instance, regardless of whether the session currently is connected, and if connected, which node it is connected to.

getMatsSocketSessionsCount(boolean, String, String, String) - Method in interface io.mats3.matssocket.MatsSocketServer

Like MatsSocketServer.getMatsSocketSessions(boolean, String, String, String), only returning the count - this might be interesting if there are very many sessions, and you do not need the full DTOs of every Session, just the count for a metric to graph or similar.

getMessageBinary() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleStoredInMessage

getMessageBinary() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleStoredOutMessage

getMessageBinary() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.StoredInMessage

getMessageBinary() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.StoredOutMessage

getMessageFromInbox(String, String) - Method in interface io.mats3.matssocket.ClusterStoreAndForward

getMessagesFromOutbox(String, int) - Method in interface io.mats3.matssocket.ClusterStoreAndForward

Fetch a set of messages, up to 'maxNumberOfMessages' - but do not include messages that have been attempted delivered already (marked with ClusterStoreAndForward.outboxMessagesAttemptedDelivery(String, Collection)).

getMessageText() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleStoredOutMessage

getMessageText() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.StoredOutMessage

getMessageType() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointIncomingContext

getNodename() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.CurrentNode

getNodename() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleCurrentNode

getNodeName() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketSession

getNodeName() - Method in class io.mats3.matssocket.MatsSocketServer.MatsSocketSessionDto

getOriginatingRemoteAddr() - Method in interface io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSession

The AuthenticationPlugin can set the originating remote IP address - which must be derived by headers like X-Forwarded-For (Wikipedia).

getOriginatingRemoteAddr() - Method in class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto

getPrincipal() - Method in interface io.mats3.matssocket.MatsSocketServer.LiveMatsSocketSession

getPrincipal() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointIncomingContext

getPrincipalName() - Method in interface io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSession

getPrincipalName() - Method in class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto

getReason() - Method in interface io.mats3.matssocket.MatsSocketServer.SessionRemovedEvent

getRemoteAddr() - Method in interface io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSession

If we have a way to find the connected (remote) address, it will be exposed here.

getRemoteAddr() - Method in class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto

getReplyClass() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpoint

getReplyTerminatorId() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.RequestCorrelation

getReplyTerminatorId() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleRequestCorrelation

getRequestTimestamp() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.RequestCorrelation

getRequestTimestamp() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleRequestCorrelation

getRequestTimestamp() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleStoredOutMessage

getRequestTimestamp() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.StoredOutMessage

getResolvedDebugOptions() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointIncomingContext

getServerMessageId() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.RequestCorrelation

getServerMessageId() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleRequestCorrelation

getServerMessageId() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleStoredOutMessage

getServerMessageId() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.StoredOutMessage

getSession() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointIncomingContext

getSessionCreatedTimestamp() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketSession

getSessionCreatedTimestamp() - Method in class io.mats3.matssocket.MatsSocketServer.MatsSocketSessionDto

getSessionEstablishedTimestamp() - Method in interface io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSession

getSessionEstablishedTimestamp() - Method in class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto

getSessionLivelinessTimestamp() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketSession

getSessionLivelinessTimestamp() - Method in class io.mats3.matssocket.MatsSocketServer.MatsSocketSessionDto

getSessions(boolean, String, String, String) - Method in interface io.mats3.matssocket.ClusterStoreAndForward

Direct implementation of MatsSocketServer.getMatsSocketSessions(boolean, String, String, String) - go read there for semantics.

getSessionsCount(boolean, String, String, String) - Method in interface io.mats3.matssocket.ClusterStoreAndForward

Direct implementation of MatsSocketServer.getMatsSocketSessionsCount(boolean, String, String, String) - go read there for semantics.

getState() - Method in interface io.mats3.matssocket.MatsSocketServer.LiveMatsSocketSession

getStoredTimestamp() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleStoredInMessage

getStoredTimestamp() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleStoredOutMessage

getStoredTimestamp() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.StoredInMessage

getStoredTimestamp() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.StoredOutMessage

getTopicSubscriptions() - Method in interface io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSession

getTopicSubscriptions() - Method in class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto

getTraceId() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleStoredOutMessage

getTraceId() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.StoredOutMessage

getTraceId() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointIncomingContext

getType() - Method in class io.mats3.matssocket.ClusterStoreAndForward.SimpleStoredOutMessage

getType() - Method in interface io.mats3.matssocket.ClusterStoreAndForward.StoredOutMessage

getType() - Method in interface io.mats3.matssocket.MatsSocketServer.SessionEstablishedEvent

getType() - Method in interface io.mats3.matssocket.MatsSocketServer.SessionRemovedEvent

getUserId() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointIncomingContext

getUserId() - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketSession

getUserId() - Method in class io.mats3.matssocket.MatsSocketServer.MatsSocketSessionDto

getWebSocketSession() - Method in interface io.mats3.matssocket.MatsSocketServer.LiveMatsSocketSession

GOING_AWAY - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketCloseCodes

Standard code 1001 - From Client/Browser side, client should have REJECTed all outstanding: Synonym for MatsSocketServer.MatsSocketCloseCodes.CLOSE_SESSION, as the WebSocket documentation states "indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page.", the latter point being pretty much exactly correct wrt.

H

handleIncoming(MatsSocketServer.MatsSocketEndpointIncomingContext<I, MR, R>, Principal, I) - Method in interface io.mats3.matssocket.MatsSocketServer.IncomingAuthorizationAndAdapter

HELLO - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MessageType

A HELLO message must be part of the first Pipeline of messages, preferably alone.

hos - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.LogLineDto

I

icnanos - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto

icts - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto

id - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketSessionDto

ids - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto

initialAuthentication(AuthenticationPlugin.AuthenticationContext, String) - Method in interface io.mats3.matssocket.AuthenticationPlugin.SessionAuthenticator

Invoked when the MatsSocket initially connects (or reconnects) over WebSocket, and needs to be authenticated by the Authorization string supplied via the initial set ("pipeline") of message from the client, typically in the HELLO message (which needs to present in the initial pipeline).

innn - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto

ints - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto

invalidAuthentication(String) - Method in interface io.mats3.matssocket.AuthenticationPlugin.AuthenticationContext

Bad Authentication! Return the result from this method from SessionAuthenticator.initialAuthentication(..) or AuthenticationPlugin.SessionAuthenticator.reevaluateAuthentication(AuthenticationContext, String, Principal) SessionAuthenticator.reevaluateAuthentication(..)} to denote BAD authentication, supplying a reason string which will be sent all the way to the client (so do not include sensitive information).

io.mats3.matssocket - package io.mats3.matssocket

ir - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto

isHandlesMessages() - Method in enum class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSession.MatsSocketSessionState

isSessionClosed() - Method in enum class io.mats3.matssocket.MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType

isSessionExists(String) - Method in interface io.mats3.matssocket.ClusterStoreAndForward

L

l - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.DebugDto

lactts - Variable in class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto

lauthts - Variable in class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto

lcpts - Variable in class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto

level - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.LogLineDto

LogLineDto() - Constructor for class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.LogLineDto

M

m - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.LogLineDto

MATS_SOCKET_PROTOCOL_ERROR - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketCloseCodes

4004: From Server side: Client should REJECT all outstanding and "crash"/reboot application: Used when the client does not speak the MatsSocket protocol correctly.

matsSocketDirectReplyEndpoint(String, Class<I>, Class<R>, MatsSocketServer.IncomingAuthorizationAndAdapter<I, Void, R>) - Method in interface io.mats3.matssocket.MatsSocketServer

(Convenience-variant of the base method) Registers a MatsSocket Endpoint meant for situations where you intend to reply directly in the MatsSocketServer.IncomingAuthorizationAndAdapter without forwarding to Mats.

matsSocketEndpoint(String, Class<I>, Class<MR>, Class<R>, MatsSocketServer.IncomingAuthorizationAndAdapter<I, MR, R>, MatsSocketServer.ReplyAdapter<I, MR, R>) - Method in interface io.mats3.matssocket.MatsSocketServer

Registers a MatsSocket Endpoint, including a MatsSocketServer.ReplyAdapter which can adapt the reply from the Mats endpoint before being fed back to the MatsSocket - and also decide whether to resolve or reject the waiting Client Promise.

matsSocketEndpoint(String, Class<I>, Class<R>, MatsSocketServer.IncomingAuthorizationAndAdapter<I, R, R>) - Method in interface io.mats3.matssocket.MatsSocketServer

(Convenience-variant of the base method) Registers a MatsSocket Endpoint where there is no replyAdapter - the reply from the Mats endpoint is directly fed back (as "resolved") to the MatsSocket.

MatsSocketEnvelopeDto() - Constructor for class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto

MatsSocketEnvelopeWithMetaDto() - Constructor for class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto

MatsSocketServer - Interface in io.mats3.matssocket

The MatsSocket Java library, along with its several clients libraries, is a WebSocket-"extension" of the Mats library (there are currently clients for JavaScript (web and Node.js) and Dart (Dart and Flutter)).

MatsSocketServer.ActiveMatsSocketSession - Interface in io.mats3.matssocket

Represents an active node-local MatsSocketSession - i.e.

MatsSocketServer.ActiveMatsSocketSession.MatsSocketSessionState - Enum Class in io.mats3.matssocket

The state of ActiveMatsSocketSession.

MatsSocketServer.ActiveMatsSocketSessionDto - Class in io.mats3.matssocket

Implementation of MatsSocketServer.ActiveMatsSocketSession, which is serializable both for MatsSocket and Mats, i.e.

MatsSocketServer.DataStoreException - Exception in io.mats3.matssocket

RuntimeException raised from methods which directly interfaces with the ClusterStoreAndForward and which cannot "hide" the situation if the data store doesn't work.

MatsSocketServer.IncomingAuthorizationAndAdapter<I,MR,R> - Interface in io.mats3.matssocket

Should handle Authorization evaluation on the supplied Principal and decide whether this message should be forwarded to the Mats fabric (or directly resolved, rejected or denied).

MatsSocketServer.LiveMatsSocketSession - Interface in io.mats3.matssocket

A live representation of a MatsSocketSession.

MatsSocketServer.MatsSocketCloseCodes - Enum Class in io.mats3.matssocket

WebSocket CloseCodes used in MatsSocket, and for what.

MatsSocketServer.MatsSocketEndpoint<I,MR,R> - Interface in io.mats3.matssocket

Representation of a MatsSocketEndpoint.

MatsSocketServer.MatsSocketEndpointContext<I,MR,R> - Interface in io.mats3.matssocket

Root for both MatsSocketServer.MatsSocketEndpointIncomingContext and MatsSocketServer.MatsSocketEndpointReplyContext.

MatsSocketServer.MatsSocketEndpointIncomingContext<I,MR,R> - Interface in io.mats3.matssocket

The context which the MatsSocketServer.IncomingAuthorizationAndAdapter gets to work with when handling an incoming MatsSocket message.

MatsSocketServer.MatsSocketEndpointReplyContext<I,MR,R> - Interface in io.mats3.matssocket

MatsSocketServer.MatsSocketEnvelopeDto - Class in io.mats3.matssocket

This is the entire "Wire transport" DTO of MatsSocket.

MatsSocketServer.MatsSocketEnvelopeDto.DebugDto - Class in io.mats3.matssocket

MatsSocketServer.MatsSocketEnvelopeDto.LogLineDto - Class in io.mats3.matssocket

MatsSocketServer.MatsSocketEnvelopeWithMetaDto - Class in io.mats3.matssocket

Extension of MatsSocketServer.MatsSocketEnvelopeDto which carries some metadata about the processing of the Envelope.

MatsSocketServer.MatsSocketEnvelopeWithMetaDto.Direction - Enum Class in io.mats3.matssocket

Only used for when the MatsSocketEnvelopeDto is exposed via the MatsSocket API - contains "meta-meta" about the processing of the envelope

MatsSocketServer.MatsSocketEnvelopeWithMetaDto.IncomingResolution - Enum Class in io.mats3.matssocket

Only used for when the MatsSocketEnvelopeDto is exposed via the MatsSocket API - contains "meta-meta" about the processing of the envelope

MatsSocketServer.MatsSocketSession - Interface in io.mats3.matssocket

A MatsSocketSession, either as represented in the data store when gotten via MatsSocketServer.getMatsSocketSessions(boolean, String, String, String) (returning MatsSocketSessionDto), or an ActiveMatsSocketSession representing an active MatsSocketSession connected to this node of the MatsSocketServer instance when gotten via MatsSocketServer.getActiveMatsSocketSessions() (returning ActiveMatsSocketSessionDto), or a LiveMatsSocketSession which is an interface view over the actual live session in the MatsSocketServer when gotten via MatsSocketServer.getLiveMatsSocketSessions().

MatsSocketServer.MatsSocketSessionDto - Class in io.mats3.matssocket

Implementation of MatsSocketServer.MatsSocketSession, which is serializable both for MatsSocket and Mats, i.e.

MatsSocketServer.MessageEvent - Interface in io.mats3.matssocket

MatsSocketServer.MessageEventListener - Interface in io.mats3.matssocket

MatsSocketServer.MessageType - Enum Class in io.mats3.matssocket

All Message Types (aka MatsSocket Envelope Types) used in the wire-protocol of MatsSocket.

MatsSocketServer.ReplyAdapter<I,MR,R> - Interface in io.mats3.matssocket

Used to transform the reply message from the Mats endpoint to the reply for the MatsSocket endpoint, and decide whether to resolve or reject the waiting Client-side Promise (i.e.

MatsSocketServer.SessionEstablishedEvent - Interface in io.mats3.matssocket

MatsSocketServer.SessionEstablishedEvent.SessionEstablishedEventType - Enum Class in io.mats3.matssocket

MatsSocketServer.SessionEstablishedEventListener - Interface in io.mats3.matssocket

MatsSocketServer.SessionRemovedEvent - Interface in io.mats3.matssocket

MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType - Enum Class in io.mats3.matssocket

Type of "remove": Either DEREGISTER, CLOSE or TIMEOUT.

MatsSocketServer.SessionRemovedEventListener - Interface in io.mats3.matssocket

MatsSocketSessionDto() - Constructor for class io.mats3.matssocket.MatsSocketServer.MatsSocketSessionDto

matsSocketTerminator(String, Class<I>, MatsSocketServer.IncomingAuthorizationAndAdapter<I, Void, Void>) - Method in interface io.mats3.matssocket.MatsSocketServer

(Convenience-variant of the base method) Registers a MatsSocket Terminator (no reply), specifically for Client-to-Server "SEND", and to accept a "REPLY" from a Server-to-Client "REQUEST".

mdc - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.LogLineDto

MessageIdAlreadyExistsException(String, Throwable) - Constructor for exception io.mats3.matssocket.ClusterStoreAndForward.MessageIdAlreadyExistsException

messagesProcessed(MatsSocketServer.MessageEvent) - Method in interface io.mats3.matssocket.MatsSocketServer.MessageEventListener

mmrrnn - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.DebugDto

mmrrts - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.DebugDto

mmsts - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.DebugDto

mscnn - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.DebugDto

mscts - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.DebugDto

msg - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto

msgs - Variable in class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto

N

NACK - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MessageType

The specified message was Received, but it did not acknowledge it - i.e.

NEW - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.SessionEstablishedEvent.SessionEstablishedEventType

newSessionAuthenticator() - Method in interface io.mats3.matssocket.AuthenticationPlugin

Invoked by the MatsSocketServer upon each WebSocket connection that wants to establish a MatsSocket - that is, you may provide a connections-specific instance per connection.

nn - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto

nn - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketSessionDto

NO_ACTION - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto.IncomingResolution

IncomingHandler did no action wrt.

NO_SESSION - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSession.MatsSocketSessionState

HELLO not yet processed - only accepts messages up to HELLO.

NODES - Enum constant in enum class io.mats3.matssocket.AuthenticationPlugin.DebugOption

Node-name of the handling nodes of the separate phases.

notifySessionLiveliness(Collection<String>) - Method in interface io.mats3.matssocket.ClusterStoreAndForward

Shall be invoked on some kind of schedule (e.g.

O

ocrip - Variable in class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto

onOpen(Session, ServerEndpointConfig) - Method in interface io.mats3.matssocket.AuthenticationPlugin.SessionAuthenticator

Invoked straight after the HTTP WebSocket handshake request/response is performed, in the Endpoint.onOpen(Session, EndpointConfig) invocation from the WebSocket ServerContainer.

outboxMessagesAttemptedDelivery(String, Collection<String>) - Method in interface io.mats3.matssocket.ClusterStoreAndForward

Marks the specified messages as attempted delivered and notches the ClusterStoreAndForward.StoredOutMessage.getDeliveryCount() one up.

outboxMessagesComplete(String, Collection<String>) - Method in interface io.mats3.matssocket.ClusterStoreAndForward

States that the messages are delivered.

outboxMessagesDeadLetterQueue(String, Collection<String>) - Method in interface io.mats3.matssocket.ClusterStoreAndForward

States that the messages overran the accepted number of delivery attempts.

outboxMessagesUnmarkAttemptedDelivery(String) - Method in interface io.mats3.matssocket.ClusterStoreAndForward

When this method is invoked, ClusterStoreAndForward.getMessagesFromOutbox(String, int) will again return messages that has previously been marked as attempted delivered with ClusterStoreAndForward.outboxMessagesAttemptedDelivery(String, Collection).

P

PING - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MessageType

A PING, to which a MatsSocketServer.MessageType.PONG is expected.

pn - Variable in class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto

PONG - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MessageType

A Reply to a MatsSocketServer.MessageType.PING.

PUB - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MessageType

Topic message from Server: A message is issued on Topic, the TopicId is specified in 'eid', while the message is in 'msg'.

publish(String, String, Object) - Method in interface io.mats3.matssocket.MatsSocketServer

Publish a Message to the specified Topic, with the specified TraceId.

R

rd - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto

REAUTH - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MessageType

The server requests that the Client re-authenticates, where the Client should immediately get a fresh authentication and send it back using either any message it has pending, or in a separate MatsSocketServer.MessageType.AUTH message.

RECONNECT - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketCloseCodes

4002: Both from Server side and from Client/Browser side: REISSUE all outstanding upon reconnect: From Client: The client just fancied a little break (just as if lost connection in a tunnel), used from integration tests. From Server: We ask that the client reconnects.

RECONNECT - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.SessionEstablishedEvent.SessionEstablishedEventType

reevaluateAuthentication(AuthenticationPlugin.AuthenticationContext, String, Principal) - Method in interface io.mats3.matssocket.AuthenticationPlugin.SessionAuthenticator

Invoked on every subsequent "pipeline" of incoming messages (including every time the Client supplies a new Authorization string).

reevaluateAuthenticationForOutgoingMessage(AuthenticationPlugin.AuthenticationContext, String, Principal, long) - Method in interface io.mats3.matssocket.AuthenticationPlugin.SessionAuthenticator

This method is invoked each time the server wants to send a message to the client - either a REPLY to a request from the Client, or a Server-to-Client SEND or MatsSocketServer.request(String, String, String, Object, String, String, byte[]) REQUEST}.

registerSessionAtThisNode(String, String, String, String, String, String) - Method in interface io.mats3.matssocket.ClusterStoreAndForward

Registers a Session home to this node - only one node can ever be home, so any old is deleted.

reject(R) - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointIncomingContext

Only for REQUESTs: Send "Reject" reply (rejects the client side Promise) to the MatsSocket directly, i.e.

reject(R) - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointReplyContext

Send "Reject" reply (rejects the client side Promise) to the MatsSocket directly, i.e.

REJECT - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto.IncomingResolution

For a REQUEST: The IncomingHandler "insta-settled" the request with a Reject.

REJECT - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MessageType

A REJECT-reply to a previous MatsSocketServer.MessageType.REQUEST - if the Client did the REQUEST, the Server will answer with either a REJECT or MatsSocketServer.MessageType.RESOLVE.

request(String, String, String, Object, String, String, byte[]) - Method in interface io.mats3.matssocket.MatsSocketServer

Initiates a request to the specified MatsSocketSession, to the specified Client EndpointId, with a replyTo specified to (typically) a MatsSocket terminator - which includes a String "correlationString" and byte array "correlationBinary" which can be used to correlate the reply to the request (available here and here for the reply processing).

REQUEST - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MessageType

The sender initiates a request, to which a MatsSocketServer.MessageType.RESOLVE or MatsSocketServer.MessageType.REJECT message is expected.

resd - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.DebugDto

resolve(R) - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointIncomingContext

Only for REQUESTs: Send "Resolve" reply (resolves the client side Promise) to the MatsSocket directly, i.e.

resolve(R) - Method in interface io.mats3.matssocket.MatsSocketServer.MatsSocketEndpointReplyContext

Send "Resolve" reply (resolves the client side Promise) to the MatsSocket directly, i.e.

RESOLVE - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto.IncomingResolution

For a REQUEST: The IncomingHandler "insta-settled" the request with a Resolve.

RESOLVE - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MessageType

A RESOLVE-reply to a previous MatsSocketServer.MessageType.REQUEST - if the Client did the REQUEST, the Server will answer with either a RESOLVE or MatsSocketServer.MessageType.REJECT.

RETRY - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MessageType

The sender should retry the message (the receiver could not handle it right now, but a Retry might fix it).

rip - Variable in class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto

rm - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto

rttm - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto

S

s - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.LogLineDto

S2C - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto.Direction

Server-to-Client.

scavengeSessionRemnants() - Method in interface io.mats3.matssocket.ClusterStoreAndForward

Shall be invoked on some kind of schedule (e.g.

scts - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketSessionDto

send(String, String, String, Object) - Method in interface io.mats3.matssocket.MatsSocketServer

Sends a message to the specified MatsSocketSession, to the specified Client TerminatorId.

SEND - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MessageType

The sender sends a "fire and forget" style message.

SERVICE_RESTART - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketCloseCodes

Standard code 1012 - From Server side, Client should REISSUE all outstanding upon reconnect: used when MatsSocketServer.stop(int) is invoked.

SESSION_ESTABLISHED - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSession.MatsSocketSessionState

HELLO is processed and auth verified, and we are processing all kinds of messages.

SESSION_LOST - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketCloseCodes

4001: From Server side, Client should REJECT all outstanding and "crash"/reboot application: A HELLO:RECONNECT was attempted, but the session was gone.

sessionEstablished(MatsSocketServer.SessionEstablishedEvent) - Method in interface io.mats3.matssocket.MatsSocketServer.SessionEstablishedEventListener

sessionRemoved(MatsSocketServer.SessionRemovedEvent) - Method in interface io.mats3.matssocket.MatsSocketServer.SessionRemovedEventListener

setOriginatingRemoteAddr(String) - Method in interface io.mats3.matssocket.AuthenticationPlugin.AuthenticationContext

Sets the Originating Remote Address, as exposed via MatsSocketServer.ActiveMatsSocketSession.getOriginatingRemoteAddr() - read that JavaDoc.

setRemoteAddr(String) - Method in interface io.mats3.matssocket.AuthenticationPlugin.AuthenticationContext

Sets (or overrides) the Remote Address, as exposed via MatsSocketServer.ActiveMatsSocketSession.getRemoteAddr() - read that JavaDoc, in particular that if this server is behind a proxy, this will be the proxy's address.

sets - Variable in class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto

sid - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto

SimpleCurrentNode(String, String) - Constructor for class io.mats3.matssocket.ClusterStoreAndForward.SimpleCurrentNode

SimpleRequestCorrelation(String, String, long, String, String, byte[]) - Constructor for class io.mats3.matssocket.ClusterStoreAndForward.SimpleRequestCorrelation

SimpleStoredInMessage(String, String, long, String, byte[]) - Constructor for class io.mats3.matssocket.ClusterStoreAndForward.SimpleStoredInMessage

SimpleStoredOutMessage(String, String, String, MatsSocketServer.MessageType, String, Long, long, Long, int, String, String, byte[]) - Constructor for class io.mats3.matssocket.ClusterStoreAndForward.SimpleStoredOutMessage

slts - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketSessionDto

smcnn - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.DebugDto

smcts - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.DebugDto

smid - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto

stillValid() - Method in interface io.mats3.matssocket.AuthenticationPlugin.AuthenticationContext

Existing Authentication is still good! Return the result from this method from AuthenticationPlugin.SessionAuthenticator.reevaluateAuthentication(AuthenticationContext, String, Principal) if the 'existingPrincipal' (and implicitly the userId) is still good to go.

stop(int) - Method in interface io.mats3.matssocket.MatsSocketServer

Closes all MatsSocketServer.ActiveMatsSocketSession on this node, closing the WebSocket with CloseReason.CloseCodes.SERVICE_RESTART (assuming that a MatsSocket service will never truly go down, thus effectively asking the client to reconnect, hopefully to another instance).

storeMessageIdInInbox(String, String) - Method in interface io.mats3.matssocket.ClusterStoreAndForward

Stores the incoming message Id, to avoid double delivery.

storeMessageInOutbox(String, String, String, String, MatsSocketServer.MessageType, Long, String, String, byte[]) - Method in interface io.mats3.matssocket.ClusterStoreAndForward

Stores the message for the Session, returning the nodename for the node holding the session, if any.

storeRequestCorrelation(String, String, long, String, String, byte[]) - Method in interface io.mats3.matssocket.ClusterStoreAndForward

SUB - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MessageType

Request from Client: The Client want to subscribe to a Topic, the TopicId is specified in 'eid'.

SUB_LOST - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MessageType

Reply from Server: Subscription went OK, but you've lost messages: The messageId that was referenced in the MatsSocketServer.MessageType.SUB was not known to the server, implying that there are at least one message that has expired, but we don't know whether it was 1 or 1 million - so you won't get any of them "replayed".

SUB_NO_AUTH - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MessageType

Reply from Server: Subscription was not authorized - no messages for this Topic will be delivered.

SUB_OK - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MessageType

Reply from Server: Subscription was OK.

subs - Variable in class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSessionDto

T

t - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.LogLineDto

t - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto

tid - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto

TIMEOUT - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType

The MatsSocketSession was previously MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType.DEREGISTER, but was now "cleaned out" by the timeouter.

timeoutSessions(long) - Method in interface io.mats3.matssocket.ClusterStoreAndForward

Shall be invoked on some kind of schedule (e.g.

TIMESTAMPS - Enum constant in enum class io.mats3.matssocket.AuthenticationPlugin.DebugOption

Timestamp info for the separate phases.

to - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto

toActiveMatsSocketSession() - Method in interface io.mats3.matssocket.MatsSocketServer.LiveMatsSocketSession

toString() - Method in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto

ts - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.LogLineDto

ts - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto

U

uid - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketSessionDto

UNEXPECTED_CONDITION - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketCloseCodes

Standard code 1011 - From Server side, Client should REJECT all outstanding and "crash"/reboot application.

UNSUB - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MessageType

Request from Client: The Client want to unsubscribe from a Topic, the TopicId is specified in 'eid'.

updateMessageInInbox(String, String, String, byte[]) - Method in interface io.mats3.matssocket.ClusterStoreAndForward

Stores the resulting message (envelope and binary), so that if the incoming messages comes again (based on ClusterStoreAndForward.storeMessageIdInInbox(String, String) throwing ClusterStoreAndForward.MessageIdAlreadyExistsException), the result from the previous processing can be returned right away.

V

valueOf(String) - Static method in enum class io.mats3.matssocket.AuthenticationPlugin.DebugOption

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSession.MatsSocketSessionState

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketCloseCodes

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto.Direction

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto.IncomingResolution

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.mats3.matssocket.MatsSocketServer.MessageType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.mats3.matssocket.MatsSocketServer.SessionEstablishedEvent.SessionEstablishedEventType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.mats3.matssocket.MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType

Returns the enum constant of this class with the specified name.

values() - Static method in enum class io.mats3.matssocket.AuthenticationPlugin.DebugOption

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.mats3.matssocket.MatsSocketServer.ActiveMatsSocketSession.MatsSocketSessionState

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketCloseCodes

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto.Direction

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeWithMetaDto.IncomingResolution

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.mats3.matssocket.MatsSocketServer.MessageType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.mats3.matssocket.MatsSocketServer.SessionEstablishedEvent.SessionEstablishedEventType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.mats3.matssocket.MatsSocketServer.SessionRemovedEvent.SessionRemovedEventType

Returns an array containing the constants of this enum class, in the order they are declared.

VIOLATED_POLICY - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MatsSocketCloseCodes

Standard code 1008 - From Server side, Client should REJECT all outstanding and "crash"/reboot application: used when we cannot authenticate.

W

WELCOME - Enum constant in enum class io.mats3.matssocket.MatsSocketServer.MessageType

The reply to a MatsSocketServer.MessageType.HELLO, where the MatsSocketSession is established, and the MatsSocketSessionId is returned.

WrongUserException(String) - Constructor for exception io.mats3.matssocket.ClusterStoreAndForward.WrongUserException

X

x - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto.LogLineDto

x - Variable in class io.mats3.matssocket.MatsSocketServer.MatsSocketEnvelopeDto

A B C D E F G H I L M N O P R S T U V W X
All Classes and Interfaces|All Packages|Serialized Form