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.logging.LogUtil;
50 import com.rhi.architecture.logging.Logger;
51 import com.rhi.architecture.parc.Process;
52 import com.rhi.architecture.parc.ProcessSet;
53 import com.rhi.architecture.parc.ProcessingException;
54 import com.rhi.architecture.config.ConfigurationException;
55 import com.rhi.architecture.resource.InitializationException;
56
57 import java.util.Properties;
58
59 /***
60 * DummyProcess for testing ProcessSet
61 *
62 * @author Pete McKinstry
63 * @copyright 2002, Robert Half Int'l., Inc. All rights reserved.
64 *
65 * @since 1.0
66 */
67 public class DummyProcess implements Process {
68
69 // Logger implementation. Log4J or otherwise.
70 private Logger log;
71 // unique name for this Pipeline process
72 private String name;
73 private Properties props;
74
75 /***
76 * Constructor
77 */
78 public DummyProcess() {
79 // no-op
80 }
81
82 /***
83 * Init method will be called prior to run to allow the
84 * strategy to initialize itself & acquire any necessary
85 * resources.
86 *
87 * @param props
88 * @since 1.0
89 * @throws InitializationException
90 */
91 public void init(Properties props) throws InitializationException {
92 this.props = props;
93
94 // concrete logger impl
95 try {
96 log = LogUtil.getLogger();
97 }
98 catch (ConfigurationException e) {
99 throw new InitializationException("logger not found. e = " + e);
100 }
101 }
102
103 /***
104 * Run each Process w/in the set serially in the order they
105 * were added. .
106 *
107 * @exception ProcessingException
108 *
109 * @since 1.0
110 */
111 public void run() throws ProcessingException {
112 //try {
113 log.info("DummyProcess::run() - Running...");
114 //}
115 //catch ( ProcessingException pe ) {
116 //log.error("ProcessingException thrown. pe = " + pe );
117 // throw new ProcessingException( pe.toString() );
118 //}
119 }
120
121 /***
122 * Perform any cleanup required. This allows the Process to
123 * keep resources open after the run() method in case a
124 * multi-call strategy is used to execute run() repeatedly.
125 *
126 * @since 1.0
127 */
128 public void cleanup() {
129 log.info("DummyProcess::cleanup() - Running...");
130 }
131
132 /***
133 * getName returns the configured name for this process. This
134 * method must return a unique identifier for each process
135 * running w/in the same BatchApplication. It is used to
136 * identify properties that are specific to a given Process.
137 *
138 * @return String
139 *
140 * @since 1.0
141 */
142 public String getName() {
143 if (name == null) {
144 String tmp = ProcessSet.class.getName();
145 int idx = tmp.lastIndexOf(".");
146 return tmp.substring(idx + 1);
147 }
148 return name;
149 }
150 /***
151 * setName is called by either the ProcessSet if this Process is
152 * contained w/in a ProcessSet to provide it w/ a unique name for
153 * property lookups. (name precedes properties specific to the
154 * process)
155 *
156 * @param name
157 *
158 * @since 1.0
159 */
160 public void setName(String name) {
161 this.name = name;
162 }
163
164 /***
165 * get the configuration properties
166 *
167 * @return Properties
168 *
169 * @since 1.0
170 */
171 public Properties getProperties() {
172 return props;
173 }
174
175 }
This page was automatically generated by Maven