Mutex.java

/*
 * This is a common dao with basic CRUD operations and is not limited to any 
 * persistent layer implementation
 * 
 * Copyright (C) 2008  Imran M Yousuf (imyousuf@smartitengineering.com)
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package com.smartitengineering.dao.common.cache;

/**
 *
 * @author imyousuf
 */
public interface Mutex<KeyType extends Object> {

    public Lock<KeyType> acquire(KeyType key)
        throws InterruptedException;

    public Lock<KeyType> acquire(KeyType key,
                        long waitTimeout)
        throws InterruptedException;
    
    public Lock<KeyType> getAttainedLockForCurrentThread();

    public void release(Lock<KeyType> lock);
    
    public void expire(KeyType key);

    public int getConcurrentPermissions();

    public void setConcurrentPermissions(int permissions);

    public void setDefaultWaitTimeoutInMillisecond(long defaultWait);

    public long getDefaultWaitTimeoutInMillisecond();
    
    public void setExpiryPeriod(long durationInMillisecond);
    
    public long getExpiryPeriod();
    
    public ExpiryPolicy getExpiryPolicy();
    
    public enum ExpiryPolicy{
        IDLE_FOR_DURATION,
        SIMPLE_TIME_TRIGGERED_EXPIRATION;
    }
}