Package com.broadleafcommerce.common.messaging.provider.jpa.domain

Class JpaResourceLock

java.lang.Object
com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock
All Implemented Interfaces:
Serializable
@Entity public class JpaResourceLock extends Object implements Serializable
Represents a single lock on a resource held in the current datastore. This is often used to prevent concurrent mutating operations on the same resource. A common application of this concept is the locking of sandbox workflow operations on the same Trackable resource.
Author:
Jeff Fischer
See Also:

  • Constructor Details

    • JpaResourceLock

      public JpaResourceLock()

  • Method Details

    • get_id

      public String get_id()

    • getContextId

      public String getContextId()
      The contextId of the Trackable resource to lock
      Returns:
      The contextId of the Trackable resource to lock

    • getTypeAlias

      public String getTypeAlias()
      An alias used to represent the Java type of the resource being locked. This is most often the Java class simple name.
      Returns:
      An alias used to represent the Java type of the resource being locked

    • getOptional

      public String getOptional()
      Optional information related to the lock. May contain sandboxId, or other relevant information, such as status.
      Returns:
      The optional information to include with the lock

    • getConceptKey

      public String getConceptKey()
      A generally descriptive key that identifies the overall concept for which the lock is taking place. WorkflowTransitionHelper#LOCK_CONCEPT_KEY is an example that identifies locks for sandbox workflows. Other concept keys may be used to apply locks for the same resource under a different context.
      Returns:
      A generally descriptive key

    • getLocked

      public Boolean getLocked()
      Whether or not the resource is locked
      Returns:
      Whether or not the resource is locked

    • getTimestamp

      public Instant getTimestamp()
      The time at which the lock was set to true
      Returns:
      The time at which the lock was set to true

    • getExpirationTimestamp

      public Instant getExpirationTimestamp()
      The time at which the lock will naturally expire
      Returns:
      The time at which the lock will naturally expire

    • getToken

      public String getToken()
      The token assigned the last time the lock was set to true. The token simply identifies the lock record and can be used to unlock the resource.
      Returns:
      The token assigned the last time the lock was set to true

    • set_id

      public void set_id(String _id)

    • setContextId

      public void setContextId(String contextId)
      The contextId of the Trackable resource to lock
      Parameters:
      contextId - The contextId of the Trackable resource to lock

    • setTypeAlias

      public void setTypeAlias(String typeAlias)
      An alias used to represent the Java type of the resource being locked. This is most often the Java class simple name.
      Parameters:
      typeAlias - An alias used to represent the Java type of the resource being locked

    • setOptional

      public void setOptional(String optional)
      Optional information related to the lock. May contain sandboxId, or other relevant information, such as status.
      Parameters:
      optional - The optional information to include with the lock

    • setConceptKey

      public void setConceptKey(String conceptKey)
      A generally descriptive key that identifies the overall concept for which the lock is taking place. WorkflowTransitionHelper#LOCK_CONCEPT_KEY is an example that identifies locks for sandbox workflows. Other concept keys may be used to apply locks for the same resource under a different context.
      Parameters:
      conceptKey - A generally descriptive key

    • setLocked

      public void setLocked(Boolean locked)
      Whether or not the resource is locked
      Parameters:
      locked - Whether or not the resource is locked

    • setTimestamp

      public void setTimestamp(Instant timestamp)
      The time at which the lock was set to true
      Parameters:
      timestamp - The time at which the lock was set to true

    • setExpirationTimestamp

      public void setExpirationTimestamp(Instant expirationTimestamp)
      The time at which the lock will naturally expire
      Parameters:
      expirationTimestamp - The time at which the lock will naturally expire

    • setToken

      public void setToken(String token)
      The token assigned the last time the lock was set to true. The token simply identifies the lock record and can be used to unlock the resource.
      Parameters:
      token - The token assigned the last time the lock was set to true

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object