rapture.lock.ILockingHandler Maven / Gradle / Ivy

Go to download
/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2011-2016 Incapture Technologies LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package rapture.lock;

import java.util.Map;

import rapture.common.LockHandle;

/**
 * Something that implements a locking handler can do these tasks
 * 
 * @author alan
 * 
 */
public interface ILockingHandler {
    /**
     * The lockContext is simply a class (that toString is useful for) that will
     * be used to record "who has the lock" It's expected that the same
     * lockContext will be given to the releaseLock call.
     * 
     * @param lockContext
     * @param lockName
     * @param secondsToWait
     * @param secondsToHold
     * @return @
     */
    LockHandle acquireLock(String lockHolder, String lockName, long secondsToWait, long secondsToHold);

    Boolean releaseLock(String lockHolder, String lockName, LockHandle lockHandle);

    void setConfig(Map config);

    void setInstanceName(String instanceName);

    Boolean forceReleaseLock(String lockName);
}