com.sun.messaging.jmq.util.LockTable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mqcomm-util Show documentation
There is a newer version: 6.5.0
/*
 * Copyright (c) 2000, 2017 Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2020 Payara Services Ltd.
 * Copyright (c) 2021, 2022 Contributors to the Eclipse Foundation
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package com.sun.messaging.jmq.util;

import java.lang.System.Logger;
import java.lang.System.Logger.Level;
import java.util.*;

/**
 * this is a generic class which allows you to wait for notification that an event has occurred even if the objects are
 * different but equivalent (generate the same hashCode/isequals == true)
 */

public class LockTable {

    private static final Logger logger = System.getLogger(LockTable.class.getName());

    HashMap notifyTable = new HashMap<>();

    /**
     * Request notification when notifiy is called on the same or equivalent instance of an object. This method should be
     * called before any notification could occur.
     *
     * @param object object to wait for notification on
     * @throws IllegalAccessException indicates the system is already waiting on that object
     */
    public void requestNotify(Object object) throws IllegalAccessException {
        synchronized (notifyTable) {
            if (notifyTable.containsKey(object)) {
                throw new IllegalAccessException("Already waiting for " + object);
            }
            notifyTable.put(object, new IDLock());
        }
    }

    /**
     * Cancel notification on an object. Cleans up any allocated resources. This call does NOT wake up any resources waiting
     * for notification.
     *
     * @param object equivalent object to the one passed into requestNotify
     */
    public void cancelNotify(Object object) {
        synchronized (notifyTable) {
            notifyTable.remove(object);
        }
    }

    // we cant just sync on interest .. it could be a different
    // object w/ the same contents

    /**
     * Wait for notification on an object.
     *
     * @param object equivalent object to the one passed into requestNotify
     */
    public void wait(Object object) {
        wait(object, 0 /* no timeout */);
    }

    /**
     * Waits up to a timeout for notification on an object.
     *
     * @param timeout time (in milliseconds) to wait for the notification
     * @param object equivalent object to the one passed into requestNotify
     * @return true if the notification was received, false if the system timed out.
     */
    public boolean wait(Object object, long timeout) {
        // OK first get the lock
        IDLock lock = null;
        synchronized (notifyTable) {
            lock = notifyTable.get(object);
        }
        if (lock == null)
         {
            return true; // done
        }
        synchronized (lock) {
            if (lock.isValid()) {
                try {
                    lock.wait(timeout);
                } catch (Exception ex) {
                    logger.log(Level.ERROR, ex.getMessage(), ex);
                }
            }

            if (lock.isValid()) {
                // wait did not complete
                return false;
            }

            synchronized (notifyTable) {
                notifyTable.remove(object);
            }
            return true;

        }
    }

    /**
     * Notify the system that the operation has completed.
     *
     * @param object equivalent object to the one passed into requestNotify
     */
    public void notify(Object object) {
        IDLock lock = null;
        synchronized (notifyTable) {
            lock = notifyTable.get(object);
        }
        if (lock == null) {
            return;
        }
        synchronized (lock) {
            lock.destroy();
            lock.notifyAll();
        }
    }
}