Package org.signal.libsignal.protocol.state.impl

Class InMemorySessionStore

java.lang.Object

org.signal.libsignal.protocol.state.impl.InMemorySessionStore

All Implemented Interfaces:

SessionStore

public class InMemorySessionStore
extends java.lang.Object
implements SessionStore

Constructor Summary

Constructors

Constructor	Description
InMemorySessionStore()

Method Summary

Modifier and Type	Method	Description
boolean	containsSession(SignalProtocolAddress address)	Determine whether there is a committed SessionRecord for a recipientId + deviceId tuple.
void	deleteAllSessions(java.lang.String name)	Remove the SessionRecords corresponding to all devices of a recipientId.
void	deleteSession(SignalProtocolAddress address)	Remove a SessionRecord for a recipientId + deviceId tuple.
java.util.List<java.lang.Integer>	getSubDeviceSessions(java.lang.String name)	Returns all known devices with active sessions for a recipient
java.util.List<SessionRecord>	loadExistingSessions(java.util.List<SignalProtocolAddress> addresses)	Returns the SessionRecords corresponding to the given addresses.
SessionRecord	loadSession(SignalProtocolAddress remoteAddress)	Returns a copy of the SessionRecord corresponding to the recipientId + deviceId tuple, or a new SessionRecord if one does not currently exist.
void	storeSession(SignalProtocolAddress address, SessionRecord record)	Commit to storage the SessionRecord for a given recipientId + deviceId tuple.

Methods inherited from class java.lang.Object

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

Constructor Detail

InMemorySessionStore

public InMemorySessionStore()

Method Detail

loadSession

public SessionRecord loadSession(SignalProtocolAddress remoteAddress)

Description copied from interface: SessionStore

Returns a copy of the SessionRecord corresponding to the recipientId + deviceId tuple, or a new SessionRecord if one does not currently exist.

It is important that implementations return a copy of the current durable information. The returned SessionRecord may be modified, but those changes should not have an effect on the durable session state (what is returned by subsequent calls to this method) without the store method being called here first.

Specified by:

loadSession in interface SessionStore

Parameters:

remoteAddress - The name and device ID of the remote client.

Returns:

a copy of the SessionRecord corresponding to the recipientId + deviceId tuple, or a new SessionRecord if one does not currently exist.

loadExistingSessions

public java.util.List<SessionRecord> loadExistingSessions(java.util.List<SignalProtocolAddress> addresses)
                                                   throws NoSessionException

Description copied from interface: SessionStore

Returns the SessionRecords corresponding to the given addresses.

Specified by:

loadExistingSessions in interface SessionStore

Parameters:

addresses - The name and device ID of each remote client.

Returns:

the SessionRecords corresponding to each recipientId + deviceId tuple.

Throws:

NoSessionException - if any address does not have an active session.

getSubDeviceSessions

public java.util.List<java.lang.Integer> getSubDeviceSessions(java.lang.String name)

Description copied from interface: SessionStore

Returns all known devices with active sessions for a recipient

Specified by:

getSubDeviceSessions in interface SessionStore

Parameters:

name - the name of the client.

Returns:

all known sub-devices with active sessions.

storeSession

public void storeSession(SignalProtocolAddress address,
                         SessionRecord record)

Description copied from interface: SessionStore

Commit to storage the SessionRecord for a given recipientId + deviceId tuple.

Specified by:

storeSession in interface SessionStore

Parameters:

address - the address of the remote client.

record - the current SessionRecord for the remote client.

containsSession

public boolean containsSession(SignalProtocolAddress address)

Description copied from interface: SessionStore

Determine whether there is a committed SessionRecord for a recipientId + deviceId tuple.

Specified by:

containsSession in interface SessionStore

Parameters:

address - the address of the remote client.

Returns:

true if a SessionRecord exists, false otherwise.

deleteSession

public void deleteSession(SignalProtocolAddress address)

Description copied from interface: SessionStore

Remove a SessionRecord for a recipientId + deviceId tuple.

Specified by:

deleteSession in interface SessionStore

Parameters:

address - the address of the remote client.

deleteAllSessions

public void deleteAllSessions(java.lang.String name)

Description copied from interface: SessionStore

Remove the SessionRecords corresponding to all devices of a recipientId.

Specified by:

deleteAllSessions in interface SessionStore

Parameters:

name - the name of the remote client.