Class InterProcessMutex

    • Constructor Detail

      • InterProcessMutex

        public InterProcessMutex​(CuratorFramework client,
                                 String path)
        Parameters:
        client - client
        path - the path to lock
    • Method Detail

      • acquire

        public void acquire()
                     throws Exception
        Acquire the mutex - blocking until it's available. Note: the same thread can call acquire re-entrantly. Each call to acquire must be balanced by a call to release()
        Specified by:
        acquire in interface InterProcessLock
        Throws:
        Exception - ZK errors, connection interruptions
      • acquire

        public boolean acquire​(long time,
                               TimeUnit unit)
                        throws Exception
        Acquire the mutex - blocks until it's available or the given time expires. Note: the same thread can call acquire re-entrantly. Each call to acquire that returns true must be balanced by a call to release()
        Specified by:
        acquire in interface InterProcessLock
        Parameters:
        time - time to wait
        unit - time unit
        Returns:
        true if the mutex was acquired, false if not
        Throws:
        Exception - ZK errors, connection interruptions
      • isAcquiredInThisProcess

        public boolean isAcquiredInThisProcess()
        Returns true if the mutex is acquired by a thread in this JVM
        Specified by:
        isAcquiredInThisProcess in interface InterProcessLock
        Returns:
        true/false
      • release

        public void release()
                     throws Exception
        Perform one release of the mutex if the calling thread is the same thread that acquired it. If the thread had made multiple calls to acquire, the mutex will still be held when this method returns.
        Specified by:
        release in interface InterProcessLock
        Throws:
        Exception - ZK errors, interruptions, current thread does not own the lock
      • getParticipantNodes

        public Collection<String> getParticipantNodes()
                                               throws Exception
        Return a sorted list of all current nodes participating in the lock
        Returns:
        list of nodes
        Throws:
        Exception - ZK errors, interruptions, etc.
      • isOwnedByCurrentThread

        public boolean isOwnedByCurrentThread()
        Returns true if the mutex is acquired by the calling thread
        Returns:
        true/false
      • getLockNodeBytes

        protected byte[] getLockNodeBytes()
      • getLockPath

        protected String getLockPath()