Lock Notification

The lock notifications are published on dedicated topics to indicate lock timeout, removal, or grant.

Granting or expiring a lock is asynchronous. The client applications need channels for receiving lock notifications. These are notifications from TIBCO Fulfillment Subscriber Inventory to the client application on JMS topics.

The following are the three topics per tenant:

  • com.tibco.inventory.notification.lock.obtained.topic.[tenantId]

    This topic is used for messages indicating that a lock was granted.

  • com.tibco.inventory.notification.lock.removed.topic.[tenantId]

    This topic is used for messages indicating that a lock request was removed by the user or API interaction. This is not sent when the current lock is "unlocked" on an item or party. It is only meant for removal. A new lock request acquiring the lock on the item or party will get a lock obtained notification.

  • com.tibco.inventory.notification.lock.expired.topic.[tenantId]

    This topic is used for messages indicating that a lock request has expired.

The following elements are used on the JMS topics:
Element Type Cardinality Description
entityid String Mandatory This is the ID of the entity for which the notification has been emitted.
entityType EntityClassType Mandatory This is the entity type of the entity the lock notification is referring to. This can either be "PARTY" or "ITEM" (quotes and capitalization is required).
eventDate dateTime Opti This is the event date of the entity the lock notification is referring to.
lockKey String Mandatory This is the key of the lock the notification is referring to.
Timeout Long Mandatory This is the timeout of the initial lock in seconds.
Priority Int Mandatory This is the priority of the initial lock.