org.whispersystems.libsignal.groups.state

Interface SenderKeyStore

public interface SenderKeyStore

Method Summary

Modifier and Type	Method and Description
SenderKeyRecord	loadSenderKey(SenderKeyName senderKeyName) Returns a copy of the SenderKeyRecord corresponding to the (groupId + senderId + deviceId) tuple, or a new SenderKeyRecord if one does not currently exist.
void	storeSenderKey(SenderKeyName senderKeyName, SenderKeyRecord record) Commit to storage the SenderKeyRecord for a given (groupId + senderId + deviceId) tuple.

Method Detail

storeSenderKey

void storeSenderKey(SenderKeyName senderKeyName,
                    SenderKeyRecord record)

Commit to storage the SenderKeyRecord for a given (groupId + senderId + deviceId) tuple.

Parameters:

senderKeyName - the (groupId + senderId + deviceId) tuple.

record - the current SenderKeyRecord for the specified senderKeyName.

loadSenderKey

SenderKeyRecord loadSenderKey(SenderKeyName senderKeyName)

Returns a copy of the SenderKeyRecord corresponding to the (groupId + senderId + deviceId) tuple, or a new SenderKeyRecord if one does not currently exist.

It is important that implementations return a copy of the current durable information. The returned SenderKeyRecord 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.

Parameters:

senderKeyName - The (groupId + senderId + deviceId) tuple.

Returns:

a copy of the SenderKeyRecord corresponding to the (groupId + senderId + deviceId tuple, or a new SenderKeyRecord if one does not currently exist.