org.whispersystems.libaxolotl.state.SessionStore Maven / Gradle / Ivy
package org.whispersystems.libaxolotl.state;
import java.util.List;
/**
* The interface to the durable store of session state information
* for remote clients.
*
* @author Moxie Marlinspike
*/
public interface SessionStore {
/**
* Returns a copy of the {@link 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.
*
* @param recipientId The recipientID of the remote client.
* @param deviceId The deviceID of the remote client.
* @return a copy of the SessionRecord corresponding to the recipientId + deviceId tuple, or
* a new SessionRecord if one does not currently exist.
*/
public SessionRecord loadSession(long recipientId, int deviceId);
/**
* Returns all known devices with active sessions for a recipient
*
* @param recipientId the recipient ID.
* @return all known sub-devices with active sessions.
*/
public List getSubDeviceSessions(long recipientId);
/**
* Commit to storage the {@link SessionRecord} for a given recipientId + deviceId tuple.
* @param recipientId the recipient ID of the remote client.
* @param deviceId the device ID of the remote client.
* @param record the current SessionRecord for the remote client.
*/
public void storeSession(long recipientId, int deviceId, SessionRecord record);
/**
* Determine whether there is a committed {@link SessionRecord} for a recipientId + deviceId tuple.
* @param recipientId the recipient ID of the remote client.
* @param deviceId the device ID of the remote client.
* @return true if a {@link SessionRecord} exists, false otherwise.
*/
public boolean containsSession(long recipientId, int deviceId);
/**
* Remove a {@link SessionRecord} for a recipientId + deviceId tuple.
*
* @param recipientId the recipient ID of the remote client.
* @param deviceId the device ID of the remote client.
*/
public void deleteSession(long recipientId, int deviceId);
/**
* Remove the {@link SessionRecord}s corresponding to all devices of a recipientId.
*
* @param recipientId the recipient ID of the remote client.
*/
public void deleteAllSessions(long recipientId);
}