org.usergrid.locking.Lock Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of usergrid-core Show documentation

Core services for Usergrid system.

There is a newer version: 0.0.27.1

/*******************************************************************************
 * Copyright 2012 Apigee Corporation
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/
package org.usergrid.locking;

import java.util.concurrent.TimeUnit;

import org.usergrid.locking.exception.UGLockException;

/**
 * The lock object to acquire
 * @author tnine
 *
 */
public interface Lock {

  /**
   * Acquire the lock.  Wait the specified amount of time before giving up
   * @param timeout The amount of time to wait
   * @param time the units of time to wait
   */
  public boolean tryLock(long timeout, TimeUnit time) throws UGLockException;
  
  /**
   * Block until a lock is available 
   * @throws UGLockException
   */
  public void lock() throws UGLockException;
  
  /**
   * Release the lock
   */
  public void unlock() throws UGLockException;
}