org.whispersystems.libsignal.state

Interface PreKeyStore

All Known Subinterfaces:

SignalProtocolStore

All Known Implementing Classes:

InMemoryPreKeyStore, InMemorySignalProtocolStore

public interface PreKeyStore

An interface describing the local storage of PreKeyRecords.

Method Summary

Modifier and Type	Method and Description
boolean	containsPreKey(int preKeyId)
PreKeyRecord	loadPreKey(int preKeyId) Load a local PreKeyRecord.
void	removePreKey(int preKeyId) Delete a PreKeyRecord from local storage.
void	storePreKey(int preKeyId, PreKeyRecord record) Store a local PreKeyRecord.

Method Detail

loadPreKey

PreKeyRecord loadPreKey(int preKeyId)
                 throws InvalidKeyIdException

Load a local PreKeyRecord.

Parameters:

preKeyId - the ID of the local PreKeyRecord.

Returns:

the corresponding PreKeyRecord.

Throws:

InvalidKeyIdException - when there is no corresponding PreKeyRecord.

storePreKey

void storePreKey(int preKeyId,
                 PreKeyRecord record)

Store a local PreKeyRecord.

Parameters:

preKeyId - the ID of the PreKeyRecord to store.

record - the PreKeyRecord.

containsPreKey

boolean containsPreKey(int preKeyId)

Parameters:

preKeyId - A PreKeyRecord ID.

Returns:

true if the store has a record for the preKeyId, otherwise false.

removePreKey

void removePreKey(int preKeyId)

Delete a PreKeyRecord from local storage.

Parameters:

preKeyId - The ID of the PreKeyRecord to remove.