View Javadoc
1 /* ====================================================================
2 * License:
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in
13 * the documentation and/or other materials provided with the
14 * distribution.
15 *
16 * 3. The end-user documentation included with the redistribution,
17 * if any, must include the following acknowledgment:
18 * "This product includes software developed by
19 * Robert Half International (http://www.rhi.com/)."
20 * Alternately, this acknowledgment may appear in the software itself,
21 * if and wherever such third-party acknowledgments normally appear.
22 *
23 * 4. The names "Parc", "RHI", and "Robert Half International" must
24 * not be used to endorse or promote products derived from this
25 * software without prior written permission. For written
26 * permission, please contact pete.mckinstry@rhi.com.
27 *
28 * 5. Products derived from this software may not be called "PARC",
29 * nor may "PARC" appear in their name, without prior written
30 * permission of Robert Half International.
31 *
32 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
33 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
34 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
35 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
36 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
37 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
38 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
39 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
40 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
41 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
42 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
43 * SUCH DAMAGE.
44 * ====================================================================
45 *
46 */
47 package com.rhi.architecture.parc;
48
49 import java.util.Collection;
50
51 /***
52 * The Channel interface represents the glue that ties processing
53 * elements together in the pipeline architecture. The channel is both
54 * a consumer and a supplier. Records can be 'put' into the channel
55 * by the supplier, and 'taken' out of the channel by the consumer.
56 *
57 * Credits:
58 * (1) Doug Lea's concurrency package.
59 * (2) Bundle Routing Architecture developed for Iridium.
60 *
61 * @author Pete McKinstry
62 * @copyright 2001, Robert Half Int'l., Inc. All rights reserved.
63 *
64 * @since 1.0
65 */
66 public interface Channel extends Consumer, Supplier, Cloneable {
67
68 /***
69 * Place a collection of Records in the channel, blocking until
70 * they are all accepted.
71 *
72 * @param set - the group of records to be inserted.
73 * @exception ProcessingException - error adding records to the
74 * channel.
75 *
76 * @since 1.0
77 */
78 public void push(Collection set) throws ProcessingException;
79
80 /***
81 * Extract a collection of records from the Channel up to the
82 * provided maximum record count. This method can, but is not
83 * required to timeout after a certain period.
84 *
85 * @param max - the maximum number of records to pull from the channel.
86 * @return Collection - a set of records extracted from the
87 * channel.
88 * @exception ProcessingException - error extracting records
89 * from the channel.
90 *
91 * @since 1.0
92 */
93 public Collection pull(int max) throws ProcessingException;
94
95 /***
96 * Clone of this channel. A clone() creates an identical Channel
97 * instance w/o any records. This is used by the framework to
98 * hookup Fitlers using a default channel implementation.
99 *
100 * @return Object copy of this Channel.
101 *
102 * @since 1.0
103 */
104 public Object clone();
105
106 }
This page was automatically generated by Maven