1 /***
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Exoffice Technologies. For written permission,
18 * please contact info@exolab.org.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Exoffice Technologies. Exolab is a registered
23 * trademark of Exoffice Technologies.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.exolab.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 2000-2005 (C) Exoffice Technologies Inc. All Rights Reserved.
42 *
43 * $Id: ConfigurationLoader.java,v 1.3 2005/10/20 14:13:25 tanderson Exp $
44 */
45 package org.exolab.jms.config;
46
47 import java.io.IOException;
48
49 import org.exolab.castor.xml.MarshalException;
50 import org.exolab.castor.xml.ValidationException;
51
52
53 /***
54 * The ConfigurationLoader loads a {@link Configuration} document and populates
55 * unset items with those provided by {@link DefaultConfiguration}.
56 *
57 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
58 * @version $Revision: 1.3 $ $Date: 2005/10/20 14:13:25 $
59 * @see Configuration
60 */
61 public class ConfigurationLoader {
62
63 /***
64 * Construct a new <code>ConfigurationLoader</code>.
65 */
66 public ConfigurationLoader() {
67 }
68
69 /***
70 * Loads the configuration information from the specified file. Unpopulated
71 * configuration elements will be set to those provided by {@link
72 * DefaultConfiguration}.
73 *
74 * @param path the path to the file
75 * @return the configuration
76 * @throws IOException for any I/O error
77 * @throws MarshalException if there is an error during unmarshalling
78 * @throws ValidationException if there is a validation error
79 */
80 public Configuration load(String path)
81 throws IOException, MarshalException, ValidationException {
82 return ConfigurationReader.read(path);
83 }
84
85 /***
86 * Loads unpopulated elements in the supplied configuration with default
87 * values. The default values are provided by {@link DefaultConfiguration}.
88 *
89 * @param config the configuration
90 * @return the configuration, with unpopulated elements set to the defaults
91 * @throws IOException for any I/O error
92 * @throws MarshalException if there is an error during unmarshalling
93 * @throws ValidationException if there is a validation error
94 */
95 public Configuration load(Configuration config)
96 throws IOException, MarshalException, ValidationException {
97 return ConfigurationReader.setDefaults(config);
98 }
99
100 }