org.symphonyoss.s2.common.legacy.id

Class LegacyIdFactory

java.lang.Object

org.symphonyoss.s2.common.legacy.id.LegacyIdFactory

public class LegacyIdFactory
extends Object

A factory to create inferred Hash values each of which is a 2.0 ID which acts as a mirror for an object in the legacy (Symphony1.5) space. Many methods take a tenantId which it uses to generate a globally unique ID for each object across all pods. This means that if the same threadId happens to exist in 2 separate pods and we create a 2.0 Sequence to represent those two threads that the 2.0 IDs will not collide in a multi tenant environment. This also means that where the same message goes xpod that events about the same message originating from different pods will have different event IDs. In the comments below where it says "originating pod" it means the pod where the event originates which may be different from the pod where the message originated. Note that where we refer to userId in this class that we expect the "external" userId which already includes the tenantId and is already globally unique. In this case the tenantId is not included again.

Author:

Bruce Skingle

Constructor Summary

Constructors

Constructor and Description
LegacyIdFactory()

Method Summary

Modifier and Type	Method and Description
Hash	deleteEventId(String tenantId, long requesterId, byte[] deleteMessageId) Create a 2.0 Hash (ID) for a DeleteEvent.
Hash	deliveryReceiptId(String tenantId, long userId, byte[] messageId, byte[] threadId) Create a 2.0 Hash (ID) for the delivery receipt of the given messageId for the given userId.
Hash	downloadAttachmentEventId(String tenantId, long downloadedByUserId, byte[] messageId, String fileId) Create a 2.0 Hash (ID) for a DownloadAttachmentEvent.
Hash	likeEventId(String tenantId, long liker, byte[] likedMessageId) Create a 2.0 Hash (ID) for a LikeEvent.
Hash	maestroId(String tenantId, byte[] messageId, byte[] threadId) Create a 2.0 Hash (ID) for a MaestroMessage.
Hash	messageId(String tenantId, byte[] messageId) Create a 2.0 Hash (ID) for the given messageId.
Hash	offlineNoticeId(String tenantId, long toUserId, byte[] messageId) Create a 2.0 Hash (ID) for an offline notification event.
Hash	readReceiptId(String tenantId, long userId, byte[] messageId, byte[] threadId) Create a 2.0 Hash (ID) for the read receipt of the given messageId for the given userId.
Hash	threadId(String tenantId, byte[] threadId) Create a 2.0 Hash (ID) for the given threadId.
Hash	userId(long userId) Create a 2.0 Hash (ID) for the given userId.

Methods inherited from class java.lang.Object

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

Constructor Detail

LegacyIdFactory

public LegacyIdFactory()

Method Detail

userId

public Hash userId(long userId)

Create a 2.0 Hash (ID) for the given userId.

Parameters:

userId - An external userId

Returns:

The 2.0 object ID for the mirror of the given ID.

messageId

public Hash messageId(String tenantId,
                      byte[] messageId)

Create a 2.0 Hash (ID) for the given messageId.

Parameters:

tenantId - The tenant ID of the pod where this event originated.

messageId - A messageId

Returns:

The 2.0 object ID for the mirror of the given ID.

Throws:

NullPointerException - if any parameter is null.

threadId

public Hash threadId(String tenantId,
                     byte[] threadId)

Create a 2.0 Hash (ID) for the given threadId.

Parameters:

tenantId - The tenant ID of the pod where this event originated.

threadId - A threadId

Returns:

The 2.0 object ID for the mirror of the given ID.

Throws:

NullPointerException - if any parameter is null.

readReceiptId

public Hash readReceiptId(String tenantId,
                          long userId,
                          byte[] messageId,
                          byte[] threadId)

Create a 2.0 Hash (ID) for the read receipt of the given messageId for the given userId.

Parameters:

tenantId - The tenant ID of the pod where this event originated.

userId - The external (globally unique) user ID or the user who read the message.

messageId - The id of the message read.

threadId - The threadId of the message read.

Returns:

The 2.0 object ID for the mirror of the given ID.

Throws:

NullPointerException - if any parameter is null.

deliveryReceiptId

public Hash deliveryReceiptId(String tenantId,
                              long userId,
                              byte[] messageId,
                              byte[] threadId)

Create a 2.0 Hash (ID) for the delivery receipt of the given messageId for the given userId.

Parameters:

tenantId - The tenant ID of the pod where this event originated.

userId - The external (globally unique) user ID or the user who read the message.

messageId - The id of the message read.

threadId - The threadId of the message read.

Returns:

The 2.0 object ID for the mirror of the given ID.

Throws:

NullPointerException - if any parameter is null.

maestroId

public Hash maestroId(String tenantId,
                      byte[] messageId,
                      @Nullable
                      byte[] threadId)

Create a 2.0 Hash (ID) for a MaestroMessage.

Parameters:

tenantId - The tenant ID of the pod where this event originated.

messageId - The message ID.

threadId - The thread ID.

Returns:

The 2.0 object ID for the mirror of the given ID.

Throws:

NullPointerException - if any parameter is null.

offlineNoticeId

public Hash offlineNoticeId(String tenantId,
                            long toUserId,
                            byte[] messageId)

Create a 2.0 Hash (ID) for an offline notification event.

Parameters:

tenantId - The tenant ID of the pod where this event originated. This event means that a user was offline when a message was delivered and an email was sent to them.

toUserId - The id of the offline user.

messageId - The message ID.

Returns:

The 2.0 object ID for the mirror of the given ID.

Throws:

NullPointerException - if any parameter is null.

deleteEventId

public Hash deleteEventId(String tenantId,
                          long requesterId,
                          byte[] deleteMessageId)

Create a 2.0 Hash (ID) for a DeleteEvent.

Parameters:

tenantId - The tenant ID of the pod where this event originated.

requesterId - The id of the requesting user.

deleteMessageId - The message ID of the deleted message.

Returns:

The 2.0 object ID for the mirror of the given ID.

Throws:

NullPointerException - if any parameter is null.

downloadAttachmentEventId

public Hash downloadAttachmentEventId(String tenantId,
                                      long downloadedByUserId,
                                      byte[] messageId,
                                      String fileId)

Create a 2.0 Hash (ID) for a DownloadAttachmentEvent.

Parameters:

tenantId - The tenant ID of the pod where this event originated.

downloadedByUserId - The user ID of the user downloading the attachment.

messageId - The message ID of the attachment.

fileId - The file ID of the attachment.

Returns:

The 2.0 object ID for the mirror of the given ID.

Throws:

NullPointerException - if any parameter is null.

likeEventId

public Hash likeEventId(String tenantId,
                        long liker,
                        byte[] likedMessageId)

Create a 2.0 Hash (ID) for a LikeEvent.

Parameters:

tenantId - The tenant ID of the pod where this event originated.

liker - The user ID of the user sending the like.

likedMessageId - The message ID of liked message.

Returns:

The 2.0 object ID for the mirror of the given ID.

Throws:

NullPointerException - if any parameter is null.