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 import java.util.Properties;
52
53 /***
54 * The Process Abstraction is the container or implementor of
55 * application logic. It's principle reason for being is to allow
56 * multiple processes to run w/in the same application.
57 *
58 * @author Pete McKinstry
59 * @copyright 2002, Robert Half Int'l., Inc. All rights reserved.
60 *
61 * @since 1.0
62 */
63 public interface Process {
64
65 /***
66 * separator used in configuration properties between a process key &
67 * the name/type of the process.
68 */
69 public static String SEPARATOR = ".";
70 /***
71 * the last part of the key used to find the name of the process
72 * in the config data.
73 */
74 public static String NAME = "name";
75 /***
76 * the last part of the key used to find the type (class name) of
77 * the process in the config data.
78 */
79 public static String TYPE = "type";
80
81 /***
82 * Init method will be called prior to run to allow the
83 * strategy to initialize itself & acquire any necessary
84 * resources.
85 *
86 * @param p
87 * @throws InitializationException
88 * @since 1.0
89 */
90 public void init(Properties p) throws InitializationException;
91
92 /***
93 * The run method provides the strategy implementation
94 * It should run the pipeline using whatever strategy
95 * it provides.
96 *
97 * @exception ProcessingException
98 *
99 * @since 1.0
100 */
101 public void run() throws ProcessingException;
102
103 /***
104 * Perform any cleanup required. This allows the Process to
105 * keep resources open after the run() method in case a
106 * multi-call strategy is used to execute run() repeatedly.
107 *
108 * @since 1.0
109 */
110 public void cleanup();
111
112 /***
113 * getName returns the configured name for this process. This
114 * method must return a unique identifier for each process
115 * running w/in the same BatchApplication. It is used to
116 * identify properties that are specific to a given Process.
117 *
118 * @return String
119 *
120 * @since 1.0
121 */
122 public String getName();
123 /***
124 * setName is called by the framework to provide the correct
125 * process name.
126 *
127 * @param name
128 *
129 * @since 1.0
130 */
131 public void setName(String name);
132
133 }
This page was automatically generated by Maven