Package org.apache.polaris.persistence.nosql.nodeids.api

Interface NodeLease

public interface NodeLease

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable Node
    node()
    Returns the Node representation for this lease if the lease has not been released or null.
    int
    nodeIdIfValid()
    Returns the node ID if the lease is active/valid or -1.
    void
    release()
    Permanently release the lease.
    void
    renew()
    Force a lease renewal, generally not recommended nor necessary.

  • Method Details

    • node

      @Nullable Node node()
      Returns the Node representation for this lease if the lease has not been released or null.

    • release

      void release()
      Permanently release the lease. Does nothing, if already released.

      If persisting the released state fails, this lease is still considered locally released and cannot be retried or reused. The backend lease may therefore remain live until it expires naturally.

    • renew

      void renew()
      Force a lease renewal, generally not recommended nor necessary. Throws, if the lease is already released.

    • nodeIdIfValid

      int nodeIdIfValid()
      Returns the node ID if the lease is active/valid or -1.