KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > services > asyncprocess > AsyncProcessor


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution,
19  * if any, must include the following acknowledgment:
20  * "This product includes software developed by Jcorporate Ltd.
21  * (http://www.jcorporate.com/)."
22  * Alternately, this acknowledgment may appear in the software itself,
23  * if and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. "Jcorporate" and product names such as "Expresso" must
26  * not be used to endorse or promote products derived from this
27  * software without prior written permission. For written permission,
28  * please contact info@jcorporate.com.
29  *
30  * 5. Products derived from this software may not be called "Expresso",
31  * or other Jcorporate product names; nor may "Expresso" or other
32  * Jcorporate product names appear in their name, without prior
33  * written permission of Jcorporate Ltd.
34  *
35  * 6. No product derived from this software may compete in the same
36  * market space, i.e. framework, without prior written permission
37  * of Jcorporate Ltd. For written permission, please contact
38  * partners@jcorporate.com.
39  *
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This software consists of voluntary contributions made by many
55  * individuals on behalf of the Jcorporate Ltd. Contributions back
56  * to the project(s) are encouraged when you make modifications.
57  * Please send them to support@jcorporate.com. For more information
58  * on Jcorporate Ltd. and its products, please see
59  * <http://www.jcorporate.com/>.
60  *
61  * Portions of this software are based upon other open source
62  * products and are subject to their respective licenses.
63  */
64
65 package com.jcorporate.expresso.services.asyncprocess;
66
67 /**
68  * The AsyncProcessor is the entity that actually does the processing of the
69  * AsyncProcess objects. As with all interfaces, the actual implementations
70  * may be different from one another. DefaultAsyncProcessor is the one that
71  * is provided with Expresso.
72  *
73  * @author Michael Rimov
74  * @version $Revision: 1.5 $ on $Date: 2004/11/17 20:48:17 $
75  */
76 public interface AsyncProcessor {
77     /**
78      * If you only do one process at a time, you can use this as the key
79      * to store your ticket in the user's session.
80      */
81     public String JavaDoc SESSION_KEY = "com.centercomp.asyncprocess.AsyncProcess";
82
83     /**
84      * Retrieve the result of the process
85      *
86      * @param ticketId the ticket id of the process
87      * @return java.lang.Object
88      */
89     public AsyncProcessResult getProcessResult(AsyncTicket ticketId);
90
91     /**
92      * Retrieve the result of the process waiting up to a specified time for
93      * the process to complete
94      *
95      * @param ticketId the ticket ID
96      * @param waitTimeout the time in ms to wait for the process to complete
97      * before returning.
98      * @return AsyncProcessResult
99      */
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, long waitTimeout)
123             throws QueueFullException;
124
125     /**
126      * Called when the process is destroyed.
127      */
128     public void destroy();
129 }
130
Popular Tags