001/*
002 * HA-JDBC: High-Availability JDBC
003 * Copyright (c) 2004-2007 Paul Ferraro
004 * 
005 * This library is free software; you can redistribute it and/or modify it 
006 * under the terms of the GNU Lesser General Public License as published by the 
007 * Free Software Foundation; either version 2.1 of the License, or (at your 
008 * option) any later version.
009 * 
010 * This library is distributed in the hope that it will be useful, but WITHOUT
011 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
012 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License 
013 * for more details.
014 * 
015 * You should have received a copy of the GNU Lesser General Public License
016 * along with this library; if not, write to the Free Software Foundation, 
017 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
018 * 
019 * Contact: ferraro@users.sourceforge.net
020 */
021package net.sf.hajdbc;
022
023import java.util.concurrent.locks.Lock;
024
025import net.sf.hajdbc.util.Strings;
026
027/**
028 * Manages a set of named read/write locks.  A global lock is represented by an empty name (i.e "").
029 * Obtaining a named read or write lock should implicitly obtain a global read lock.
030 * Consequently, all named locks are blocked if a global write lock is obtained.
031 * @author Paul Ferraro
032 */
033public interface LockManager extends Lifecycle
034{
035        public static final String GLOBAL = Strings.EMPTY;
036        
037        /**
038         * Obtains a named read lock.
039         * @param object an object to lock
040         * @return a read lock
041         */
042        public Lock readLock(String object);
043
044        /**
045         * Obtains a named write lock.
046         * @param object an object to lock
047         * @return a write lock
048         */
049        public Lock writeLock(String object);
050}