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.batch.AuditAgent;
50 import com.rhi.architecture.resource.InitializationException;
51
52 import java.util.Properties;
53
54 /***
55 * Interface for all adapters.
56 *
57 * @author Pete McKinstry
58 * @copyright 2002, Robert Half Int'l., Inc. All rights reserved.
59 *
60 * @since 1.0
61 */
62 public interface Adapter {
63
64 /***
65 * Set method to tell the InputAdapter what audit
66 * agent to use. The input Adapter creates the initial
67 * audit record w/ the # of records being processed.
68 *
69 * @param agent
70 *
71 * @since 1.0
72 */
73 public void setAuditAgent(AuditAgent agent);
74 /***
75 * get audit agent
76 * @return AuditAgent
77 *
78 * @since 1.0
79 */
80 public AuditAgent getAuditAgent();
81
82 /***
83 * Initialization of the Adapter
84 *
85 * @param props
86 *
87 * @throws InitializationException - an error occured while
88 * configuring the output adapter. This will cause the
89 * application to shutdown.
90 *
91 * @since 1.0
92 */
93 public void init(Properties props) throws InitializationException;
94
95 /***
96 * Perform any cleanup. Called by PARCApplication during
97 * application shutdown. Since the application
98 * is shutting down when cleanup is called, there are no
99 * checked exceptions thrown from this method. Cleanup failures
100 * should be able to be ignored.
101 *
102 * @since 1.0
103 */
104 public void cleanup();
105
106 }
This page was automatically generated by Maven