001/*
002 * HA-JDBC: High-Availability JDBC
003 * Copyright (C) 2012  Paul Ferraro
004 *
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Lesser General Public License as published by
007 * the Free Software Foundation, either version 3 of the License, or
008 * (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
013 * GNU Lesser General Public License for more details.
014 *
015 * You should have received a copy of the GNU Lesser General Public License
016 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
017 */
018package net.sf.hajdbc.lock;
019
020import java.util.concurrent.locks.Lock;
021
022import net.sf.hajdbc.Lifecycle;
023
024/**
025 * Manages a set of named read/write locks.  A global lock is represented by a null object.
026 * Obtaining a named read or write lock should implicitly obtain a global read lock.
027 * Consequently, all named locks are blocked if a global write lock is obtained.
028 * @author Paul Ferraro
029 */
030public interface LockManager extends Lifecycle
031{
032        /**
033         * Obtains a named read lock.
034         * @param object an object to lock
035         * @return a read lock
036         */
037        Lock readLock(String object);
038
039        /**
040         * Obtains a named write lock.
041         * @param object an object to lock
042         * @return a write lock
043         */
044        Lock writeLock(String object);
045}