001: /* ====================================================================
002: * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
003: *
004: * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by Jcorporate Ltd.
021: * (http://www.jcorporate.com/)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. "Jcorporate" and product names such as "Expresso" must
026: * not be used to endorse or promote products derived from this
027: * software without prior written permission. For written permission,
028: * please contact info@jcorporate.com.
029: *
030: * 5. Products derived from this software may not be called "Expresso",
031: * or other Jcorporate product names; nor may "Expresso" or other
032: * Jcorporate product names appear in their name, without prior
033: * written permission of Jcorporate Ltd.
034: *
035: * 6. No product derived from this software may compete in the same
036: * market space, i.e. framework, without prior written permission
037: * of Jcorporate Ltd. For written permission, please contact
038: * partners@jcorporate.com.
039: *
040: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
041: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
042: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
043: * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
044: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
045: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
046: * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
047: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
048: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
049: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
050: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
051: * SUCH DAMAGE.
052: * ====================================================================
053: *
054: * This software consists of voluntary contributions made by many
055: * individuals on behalf of the Jcorporate Ltd. Contributions back
056: * to the project(s) are encouraged when you make modifications.
057: * Please send them to support@jcorporate.com. For more information
058: * on Jcorporate Ltd. and its products, please see
059: * <http://www.jcorporate.com/>.
060: *
061: * Portions of this software are based upon other open source
062: * products and are subject to their respective licenses.
063: */
064:
065: package com.jcorporate.expresso.services.asyncprocess;
066:
067: /**
068: * The AsyncProcessor is the entity that actually does the processing of the
069: * AsyncProcess objects. As with all interfaces, the actual implementations
070: * may be different from one another. DefaultAsyncProcessor is the one that
071: * is provided with Expresso.
072: *
073: * @author Michael Rimov
074: * @version $Revision: 1.5 $ on $Date: 2004/11/17 20:48:17 $
075: */
076: public interface AsyncProcessor {
077: /**
078: * If you only do one process at a time, you can use this as the key
079: * to store your ticket in the user's session.
080: */
081: public String SESSION_KEY = "com.centercomp.asyncprocess.AsyncProcess";
082:
083: /**
084: * Retrieve the result of the process
085: *
086: * @param ticketId the ticket id of the process
087: * @return java.lang.Object
088: */
089: public AsyncProcessResult getProcessResult(AsyncTicket ticketId);
090:
091: /**
092: * Retrieve the result of the process waiting up to a specified time for
093: * the process to complete
094: *
095: * @param ticketId the ticket ID
096: * @param waitTimeout the time in ms to wait for the process to complete
097: * before returning.
098: * @return AsyncProcessResult
099: */
100: public AsyncProcessResult getProcessResult(AsyncTicket ticketId,
101: long waitTimeout);
102:
103: /**
104: * Adds a process to the queue to get complete
105: *
106: * @param newProcess the process to complete
107: * @return integer - ticketID
108: */
109: public AsyncTicket addToQueue(AsyncProcess newProcess)
110: throws QueueFullException;
111:
112: /**
113: * Add an asynchronous process ot the queue
114: *
115: * @param newProcess the process to add to the queue
116: * @param waitTimeout the time in milliseconds to wait before
117: * returning. Will return 'completeed' if that occurs before
118: * the timeout is reached.
119: * @return AsyncTicket object for use in reeming the process' status.
120: * @throws QueueFullException if there are too many jobs waiting.
121: */
122: public AsyncTicket addToQueue(AsyncProcess newProcess,
123: long waitTimeout) throws QueueFullException;
124:
125: /**
126: * Called when the process is destroyed.
127: */
128: public void destroy();
129: }
|