alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Glassfish example source code file (WorkManager.java)

This example Glassfish source code file (WorkManager.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - Glassfish tags/keywords

executioncontext, executioncontext, immediate, indefinite, indefinite, unknown, workexception, workexception, worklistener, worklistener, workmanager

The Glassfish WorkManager.java source code

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, 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/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package javax.resource.spi.work;

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

/**
 * This interface models a <code>WorkManager which provides a facility
 * to submit <code>Work instances for execution. This frees the user
 * from having to create Java threads directly to do work. Further, this
 * allows efficient pooling of thread resources and more control over thread
 * usage.
 *
 * The various stages in <code>Work processing are:
 * <ul>
 * <li> work submit: A Work instance is being submitted for 
 * execution. The <code>Work instance could either be accepted or 
 * rejected with a <code>WorkRejectedException set to an appropriate
 * error code. </li>
 *
 * <li> work accepted: The submitted Work instance has been 
 * accepted. The accepted <code>Work instance could either start 
 * execution or could be rejected again with a 
 * <code>WorkRejectedException set to an appropriate error code.
 * There is no guarantee on when the  execution would start unless a start 
 * timeout duration is specified. When a start timeout is specified, the 
 * <code>Work execution must be started within the specified  
 * duration (not a  real-time guarantee), failing which a 
 * <code>WorkRejectedException set to an error code 
 * (<code>WorkRejected.TIMED_OUT) is thrown. 
 *
 * <li> work rejected: The Work instance has  been rejected. 
 * The <code>Work instance could be rejected during Work
 * submittal  or after the <code>Work instance has been accepted 
 * (but before Work instance starts execution). The rejection could be due 
 * to internal factors or start timeout expiration. A 
 * <code>WorkRejectedException with an appropriate error code 
 * (indicates the reason) is thrown in both cases. </li>
 *
 * <li> work started: The execution of the Work 
 * instance has started. This means that a thread
 * has been allocated for its execution. But this  
 * does not guarantee that the allocated thread has been scheduled to run 
 * on a CPU resource. Once execution is started, the allocated thread 
 * sets up an appropriate execution context (transaction , security, etc)
 * and calls Work.run(). Note, any exception thrown during execution context
 * setup or Work.run() leads to completion of processing. </li>
 *
 * <li> work completed: The execution of the Work has been 
 * completed. The execution could complete with or without an exception.
 * The <code>WorkManager catches any exception thrown during 
 * <code>Work processing (which includes execution context setup), 
 * and wraps it with a <code>WorkCompletedException. 
 * </ul>
 *
 * @version 1.0
 * @author  Ram Jeyaraman
 */
public interface WorkManager {

    /**
     * A constant to indicate timeout duration. A zero timeout value indicates
     * an action be performed immediately. The WorkManager implementation
     * must timeout the action as soon as possible.
     */
    long IMMEDIATE = 0L;

    /**
     * A constant to indicate timeout duration. A maximum timeout value 
     * indicates that an action be performed arbitrarily without any time 
     * constraint.
     */
    long INDEFINITE = Long.MAX_VALUE;

    /**
     * A constant to indicate an unknown start delay duration or other unknown
     * values.
     */
    long UNKNOWN = -1;

    /**
     * Accepts a <code>Work instance for processing. This call
     * blocks until the <code>Work instance completes execution.
     * There is no guarantee on when the accepted <code>Work 
     * instance would start execution ie., there is no time constraint 
     * to start execution. (that is, startTimeout=INDEFINITE)
     *
     * @param work The unit of work to be done.  
     * Could be long or short-lived.
     *
     * @throws WorkRejectedException indicates that a 
     * <code>Work instance has been rejected from further processing.
     * This can occur due to internal factors.
     *
     * @throws WorkCompletedException indicates that a
     * <code>Work instance has completed execution with an exception.
     */
    void doWork(Work work) // startTimeout = INDEFINITE
	throws WorkException;

    /**
     * Accepts a <code>Work instance for processing. This call
     * blocks until the <code>Work instance completes execution.
     *
     * @param work The unit of work to be done.  
     * Could be long or short-lived.
     *
     * @param startTimeout a time duration (in milliseconds) 
     * within which the execution of the <code>Work instance must
     * start. Otherwise, the <code>Work instance is rejected with a
     * <code>WorkRejectedException set to an appropriate error code 
     * (<code>WorkRejectedException.TIMED_OUT). Note, this
     * does not offer real-time guarantees.
     *
     * @param execContext an object containing the execution
     * context with which the submitted <code>Work instance must
     * be executed.
     *
     * @param workListener an object which would be notified
     * when the various <code>Work processing events (work accepted, 
     * work rejected, work started, work completed) occur.
     *
     * @throws WorkRejectedException indicates that a 
     * <code>Work instance has been rejected from further processing.
     * This can occur due to internal factors or start timeout expiration.
     *
     * @throws WorkCompletedException indicates that a
     * <code>Work instance has completed execution with an exception.
     */
    void doWork(Work work, long startTimeout, 
            ExecutionContext execContext, WorkListener workListener) 
	throws WorkException;

    /**
     * Accepts a <code>Work instance for processing. This call
     * blocks until the <code>Work instance starts execution
     * but not until its completion. There is no guarantee on when
     * the accepted <code>Work instance would start
     * execution ie., there is no time constraint to start execution.
     * (that is, startTimeout=INDEFINITE)
     *
     * @param work The unit of work to be done.  
     * Could be long or short-lived.
     *
     * @return the time elapsed (in milliseconds) from <code>Work
     * acceptance until start of execution. Note, this does not offer 
     * real-time guarantees. It is valid to return -1, if the actual start 
     * delay duration is unknown.
     *
     * @throws WorkRejectedException indicates that a 
     * <code>Work instance has been rejected from further processing.
     * This can occur due to internal factors.
     */
    long startWork(Work work) // startTimeout = INDEFINITE
	throws WorkException;

    /**
     * Accepts a <code>Work instance for processing. This call
     * blocks until the <code>Work instance starts execution
     * but not until its completion. There is no guarantee on when
     * the accepted <code>Work instance would start
     * execution ie., there is no time constraint to start execution.
     *
     * @param work The unit of work to be done.  
     * Could be long or short-lived.
     *
     * @param startTimeout a time duration (in milliseconds) 
     * within which the execution of the <code>Work instance must
     * start. Otherwise, the <code>Work instance is rejected with a
     * <code>WorkRejectedException set to an appropriate error code 
     * (<code>WorkRejectedException.TIMED_OUT). Note, this
     * does not offer real-time guarantees.
     *
     * @param execContext an object containing the execution
     * context with which the submitted <code>Work instance must
     * be executed.
     *
     * @param workListener an object which would be notified
     * when the various <code>Work processing events (work accepted, 
     * work rejected, work started, work completed) occur.
     *
     * @return the time elapsed (in milliseconds) from <code>Work
     * acceptance until start of execution. Note, this does not offer 
     * real-time guarantees. It is valid to return -1, if the actual start 
     * delay duration is unknown.
     *
     * @throws WorkRejectedException indicates that a 
     * <code>Work instance has been rejected from further processing.
     * This can occur due to internal factors or start timeout expiration.
     */
    long startWork(Work work, long startTimeout, 
            ExecutionContext execContext, WorkListener workListener) 
	throws WorkException;

    /**
     * Accepts a <code>Work instance for processing. This call
     * does not block and returns immediately once a <code>Work
     * instance has been accepted for processing. There is no guarantee
     * on when the submitted <code>Work instance would start
     * execution ie., there is no time constraint to start execution.
     * (that is, startTimeout=INDEFINITE).
     *
     * @param work The unit of work to be done.  
     * Could be long or short-lived.
     *
     * @throws WorkRejectedException indicates that a 
     * <code>Work instance has been rejected from further processing.
     * This can occur due to internal factors.
     */
    void scheduleWork(Work work) // startTimeout = INDEFINITE
	throws WorkException;

    /**
     * Accepts a <code>Work instance for processing. This call
     * does not block and returns immediately once a <code>Work
     * instance has been accepted for processing.
     *
     * @param work The unit of work to be done. 
     * Could be long or short-lived.
     *
     * @param startTimeout a time duration (in milliseconds) 
     * within which the execution of the <code>Work instance must
     * start. Otherwise, the <code>Work instance is rejected with a
     * <code>WorkRejectedException set to an appropriate error code 
     * (<code>WorkRejectedException.TIMED_OUT). Note, this
     * does not offer real-time guarantees.
     *
     * @param execContext an object containing the execution
     * context with which the submitted <code>Work instance must
     * be executed.
     *
     * @param workListener an object which would be notified
     * when the various <code>Work processing events (work accepted, 
     * work rejected, work started, work completed) occur.
     *
     * @throws WorkRejectedException indicates that a 
     * <code>Work instance has been rejected from further processing.
     * This can occur due to internal factors.
     */
    void scheduleWork(Work work, long startTimeout, 
            ExecutionContext execContext, WorkListener workListener) 
	throws WorkException;
}

Other Glassfish examples (source code examples)

Here is a short list of links related to this Glassfish WorkManager.java source code file:

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.