WorkListener.java

/*
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the License).  You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the license at
 * https://glassfish.dev.java.net/public/CDDLv1.0.html or
 * glassfish/bootstrap/legal/CDDLv1.0.txt.
 * See the License for the specific language governing
 * permissions and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL
 * Header Notice in each file and include the License file
 * at glassfish/bootstrap/legal/CDDLv1.0.txt.
 * If applicable, add the following below the CDDL Header,
 * with the fields enclosed by brackets [] replaced by
 * you own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
 */

package javax.resource.spi.work;

import java.lang.Object;
import java.lang.Runnable;
import java.lang.Exception;
import java.lang.Throwable;
import java.util.EventListener;

/**
 * This models a <code>WorkListener</code> instance which would be notified
 * by the <code>WorkManager</code> when the various <code>Work</code>
 * processing events (work accepted, work rejected, work started,
 * work completed) occur.
 *
 * The <code>WorkListener</code> instance must not make any thread
 * assumptions and must be thread-safe ie., a notification could
 * occur from any arbitrary thread. Further, it must not make any
 * assumptions on the ordering of notifications.
 *
 * @version 1.0
 * @author  Ram Jeyaraman
 */
public interface WorkListener extends EventListener {

    /**
     * Invoked when a <code>Work</code> instance has been accepted.
     */
    void workAccepted(WorkEvent e);

    /**
     * Invoked when a <code>Work</code> instance has been rejected.
     */
    void workRejected(WorkEvent e);

    /**
     * Invoked when a <code>Work</code> instance has started execution.
     * This only means that a thread has been allocated.
     */
    void workStarted(WorkEvent e);

    /**
     * Invoked when a <code>Work</code> instance has completed execution.
     */
    void workCompleted(WorkEvent e);
}