Package org.signal.libsignal.protocol.groups.state

Interface SenderKeyStore

All Known Subinterfaces:

SignalProtocolStore

All Known Implementing Classes:

InMemorySenderKeyStore, InMemorySignalProtocolStore

public interface SenderKeyStore

Method Summary

Modifier and Type	Method	Description
SenderKeyRecord	loadSenderKey(SignalProtocolAddress sender, java.util.UUID distributionId)	Returns a copy of the SenderKeyRecord corresponding to the (distributionId + senderName + deviceId) tuple, or `null` if one does not exist.
void	storeSenderKey(SignalProtocolAddress sender, java.util.UUID distributionId, SenderKeyRecord record)	Commit to storage the SenderKeyRecord for a given (distributionId + senderName + deviceId) tuple.

Method Detail

storeSenderKey

void storeSenderKey(SignalProtocolAddress sender,
                    java.util.UUID distributionId,
                    SenderKeyRecord record)

Commit to storage the SenderKeyRecord for a given (distributionId + senderName + deviceId) tuple.

Parameters:

sender - The address of the current client.

distributionId - An opaque identifier that uniquely identifies the group (but isn't the group ID).

record - the current SenderKeyRecord for the specified (distributionId + senderName + deviceId) tuple.

loadSenderKey

SenderKeyRecord loadSenderKey(SignalProtocolAddress sender,
                              java.util.UUID distributionId)

Returns a copy of the SenderKeyRecord corresponding to the (distributionId + senderName + deviceId) tuple, or `null` if one does not 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:

sender - The address of the current client.

distributionId - An opaque identifier that uniquely identifies the group (but isn't the group ID).

Returns:

a copy of the SenderKeyRecord corresponding to the (id + senderName + deviceId tuple, or `null` if one does not currently exist.