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 com.rhi.architecture.resource.InitializationException;
50
51 /***
52 * Processing pipeline component. Responsible for hooking
53 * filter(s) up to an input channel & an output channel &
54 * running a them.
55 *
56 * @author Pete McKinstry
57 * @copyright 2002, Robert Half Int'l., Inc. All rights reserved.
58 *
59 * @since 1.0
60 */
61 public interface Pipeline {
62
63 /***
64 * Allow the framework to provide a default Channel
65 * implementation.
66 *
67 * @param ch
68 * @since 1.1
69 * @throws InitializationException
70 */
71 public void init(Channel ch) throws InitializationException;
72
73 /***
74 * Set exception handler instance
75 *
76 * @param handler
77 * @since 1.1
78 */
79 public void setExceptionHandler(ExceptionHandler handler);
80
81 /***
82 * Run the filter.
83 *
84 * @since 1.0
85 * @throws ProcessingException
86 */
87 public void process() throws ProcessingException;
88
89 /***
90 * Cleanup in-process work and shutdown queues.
91 *
92 * @since 1.0
93 */
94 public void flush();
95
96 /***
97 * Return the input channel to which the pipe is hooked.
98 *
99 * @since 1.0
100 * @return
101 */
102 public Channel getInputChannel();
103
104 /***
105 * Return the output channel to which the pipe is hooked up.
106 *
107 * @since 1.0
108 * @return
109 */
110 public Channel getOutputChannel();
111
112 /***
113 * Return the error channel to which the pipe is hooked up.
114 *
115 * @since 1.0
116 * @return
117 */
118 public Channel getErrorChannel();
119
120 /***
121 * Add a filter using the default channel.
122 *
123 * @param f
124 * @since 1.1
125 */
126 public void addFilter(Filter f);
127
128 /***
129 * Add a filer using the provided Channel.
130 *
131 * @param f
132 * @param c
133 * @since 1.1
134 */
135 public void addFilter(Filter f, Channel c);
136
137 }
This page was automatically generated by Maven