Package org.symphonyoss.s2.common.legacy.id

Class LegacyIdFactory

java.lang.Object

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

public class LegacyIdFactory
extends java.lang.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. 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	Description
LegacyIdFactory()

Method Summary

Modifier and Type	Method	Description
Hash	deleteEventId(java.lang.String tenantId, long requesterId, byte[] deleteMessageId, byte[] messageId)	Create a 2.0 Hash (ID) for a DeleteEvent.
Hash	deliveryReceiptId(java.lang.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(java.lang.String tenantId, long downloadedByUserId, byte[] messageId)	Create a 2.0 Hash (ID) for a DownloadAttachmentEvent.
Hash	likeEventId(java.lang.String tenantId, long liker, byte[] likedMessageId, byte[] messageId)	Create a 2.0 Hash (ID) for a LikeEvent.
Hash	maestroId(java.lang.String tenantId, java.lang.String typeName, java.lang.Integer fromPod, byte[] messageId, byte[] threadId)	Create a 2.0 Hash (ID) for a MaestroMessage.
Hash	messageId(java.lang.String tenantId, byte[] messageId)	Create a 2.0 Hash (ID) for the given messageId.
Hash	offlineNoticeId(java.lang.String tenantId, long toUserId, byte[] messageId)	Create a 2.0 Hash (ID) for an offline notification event.
Hash	readReceiptId(java.lang.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(java.lang.String tenantId, byte[] threadId)	Create a 2.0 Hash (ID) for the given threadId.

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

messageId

public Hash messageId(java.lang.String tenantId,
                      byte[] messageId)

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

Parameters:

messageId - A messageId

Returns:

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

Throws:

java.lang.NullPointerException - if any parameter is null.

threadId

public Hash threadId(java.lang.String tenantId,
                     byte[] threadId)

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

Parameters:

threadId - A threadId

Returns:

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

Throws:

java.lang.NullPointerException - if any parameter is null.

readReceiptId

public Hash readReceiptId(java.lang.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:

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:

java.lang.NullPointerException - if any parameter is null.

deliveryReceiptId

public Hash deliveryReceiptId(java.lang.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:

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:

java.lang.NullPointerException - if any parameter is null.

maestroId

public Hash maestroId(java.lang.String tenantId,
                      java.lang.String typeName,
                      java.lang.Integer fromPod,
                      byte[] messageId,
                      @Nullable
                      byte[] threadId)

Create a 2.0 Hash (ID) for a MaestroMessage.

Parameters:

typeName - The type of the MaestroPayload.

fromPod - The originating pod id.

messageId - The message ID.

threadId - The thread ID.

Returns:

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

Throws:

java.lang.NullPointerException - if any parameter is null.

offlineNoticeId

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

Create a 2.0 Hash (ID) for an offline notification event. This event means that a user was offline when a message was delivered and an email was sent to them.

Parameters:

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:

java.lang.NullPointerException - if any parameter is null.

deleteEventId

public Hash deleteEventId(java.lang.String tenantId,
                          long requesterId,
                          byte[] deleteMessageId,
                          byte[] messageId)

Create a 2.0 Hash (ID) for a DeleteEvent.

Parameters:

requesterId - The id of the requesting user.

deleteMessageId - The message ID of the deleted message.

messageId - The message ID of the event.

Returns:

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

Throws:

java.lang.NullPointerException - if any parameter is null.

downloadAttachmentEventId

public Hash downloadAttachmentEventId(java.lang.String tenantId,
                                      long downloadedByUserId,
                                      byte[] messageId)

Create a 2.0 Hash (ID) for a DownloadAttachmentEvent.

Parameters:

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

messageId - The message ID of the attachment.

Returns:

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

Throws:

java.lang.NullPointerException - if any parameter is null.

likeEventId

public Hash likeEventId(java.lang.String tenantId,
                        long liker,
                        byte[] likedMessageId,
                        byte[] messageId)

Create a 2.0 Hash (ID) for a LikeEvent.

Parameters:

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

likedMessageId - The message ID of liked message.

messageId - The message ID of the event.

Returns:

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

Throws:

java.lang.NullPointerException - if any parameter is null.