org.whispersystems.libsignal.groups

Class GroupSessionBuilder

java.lang.Object

org.whispersystems.libsignal.groups.GroupSessionBuilder

public class GroupSessionBuilder
extends java.lang.Object

GroupSessionBuilder is responsible for setting up group SenderKey encrypted sessions. Once a session has been established, GroupCipher can be used to encrypt/decrypt messages in that session.

The built sessions are unidirectional: they can be used either for sending or for receiving, but not both. Sessions are constructed per (groupId + senderId + deviceId) tuple. Remote logical users are identified by their senderId, and each logical recipientId can have multiple physical devices.

Constructor Summary

Constructors

Constructor and Description
GroupSessionBuilder(SenderKeyStore senderKeyStore)

Method Summary

Modifier and Type	Method and Description
SenderKeyDistributionMessage	create(SenderKeyName senderKeyName) Construct a group session for sending messages.
void	process(SenderKeyName senderKeyName, SenderKeyDistributionMessage senderKeyDistributionMessage) Construct a group session for receiving messages from senderKeyName.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GroupSessionBuilder

public GroupSessionBuilder(SenderKeyStore senderKeyStore)

Method Detail

process

public void process(SenderKeyName senderKeyName,
                    SenderKeyDistributionMessage senderKeyDistributionMessage)

Construct a group session for receiving messages from senderKeyName.

Parameters:

senderKeyName - The (groupId, senderId, deviceId) tuple associated with the SenderKeyDistributionMessage.

senderKeyDistributionMessage - A received SenderKeyDistributionMessage.

create

public SenderKeyDistributionMessage create(SenderKeyName senderKeyName)

Construct a group session for sending messages.

Parameters:

senderKeyName - The (groupId, senderId, deviceId) tuple. In this case, 'senderId' should be the caller.

Returns:

A SenderKeyDistributionMessage that is individually distributed to each member of the group.