rapture.common.api.LockApi 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.
 */

/**
 * This is an autogenerated file. You should not edit this file as any changes
 * will be overwritten.
 */

package rapture.common.api;
import rapture.common.exception.RaptureException;
import rapture.common.CallingContext;
import java.util.List;
import java.util.Map;
import rapture.common.RaptureLockConfig;
import rapture.common.LockHandle;


@SuppressWarnings("all")
public interface LockApi {
     /**
     * Retrieves the lock providers for a given authority.
     * 
     */
     List getLockManagerConfigs(CallingContext context, String managerUri);

     /**
     * Creates a lock provider with an authority.
     * 
     */
     RaptureLockConfig createLockManager(CallingContext context, String managerUri, String config, String pathPosition);

     /**
     * Returns true if the lock providers found.
     * 
     */
     Boolean lockManagerExists(CallingContext context, String managerUri);

     /**
     * Gets a lock provider by its Uri.
     * 
     */
     RaptureLockConfig getLockManagerConfig(CallingContext context, String managerUri);

     /**
     * Deletes a lock provider by its Uri.
     * 
     */
     void deleteLockManager(CallingContext context, String managerUri);

     /**
     * Acquire a lock. Returns a LockHandle, which you need to pass to releaseLock when
     * calling it. If unable to acquire the lock, returns null.
     * 
     */
     LockHandle acquireLock(CallingContext context, String managerUri, String lockName, long secondsToWait, long secondsToKeep);

     /**
     * Releases a lock.
     * 
     */
     Boolean releaseLock(CallingContext context, String managerUri, String lockName, LockHandle lockHandle);

     /**
     * This is a dangerous variant of release lock that will kick someone else off the lock
     * queue.
     * 
     */
     void forceReleaseLock(CallingContext context, String managerUri, String lockName);

}