org.whispersystems.libsignal.state

Interface SignedPreKeyStore

All Known Subinterfaces:

SignalProtocolStore

All Known Implementing Classes:

InMemorySignalProtocolStore, InMemorySignedPreKeyStore

public interface SignedPreKeyStore

Method Summary

Modifier and Type	Method and Description
boolean	containsSignedPreKey(int signedPreKeyId)
SignedPreKeyRecord	loadSignedPreKey(int signedPreKeyId) Load a local SignedPreKeyRecord.
java.util.List<SignedPreKeyRecord>	loadSignedPreKeys() Load all local SignedPreKeyRecords.
void	removeSignedPreKey(int signedPreKeyId) Delete a SignedPreKeyRecord from local storage.
void	storeSignedPreKey(int signedPreKeyId, SignedPreKeyRecord record) Store a local SignedPreKeyRecord.

Method Detail

loadSignedPreKey

SignedPreKeyRecord loadSignedPreKey(int signedPreKeyId)
                             throws InvalidKeyIdException

Load a local SignedPreKeyRecord.

Parameters:

signedPreKeyId - the ID of the local SignedPreKeyRecord.

Returns:

the corresponding SignedPreKeyRecord.

Throws:

InvalidKeyIdException - when there is no corresponding SignedPreKeyRecord.

loadSignedPreKeys

java.util.List<SignedPreKeyRecord> loadSignedPreKeys()

Load all local SignedPreKeyRecords.

Returns:

All stored SignedPreKeyRecords.

storeSignedPreKey

void storeSignedPreKey(int signedPreKeyId,
                       SignedPreKeyRecord record)

Store a local SignedPreKeyRecord.

Parameters:

signedPreKeyId - the ID of the SignedPreKeyRecord to store.

record - the SignedPreKeyRecord.

containsSignedPreKey

boolean containsSignedPreKey(int signedPreKeyId)

Parameters:

signedPreKeyId - A SignedPreKeyRecord ID.

Returns:

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

removeSignedPreKey

void removeSignedPreKey(int signedPreKeyId)

Delete a SignedPreKeyRecord from local storage.

Parameters:

signedPreKeyId - The ID of the SignedPreKeyRecord to remove.