KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > mule > config > ConfigurationBuilder


1 /*
2  * $Id: ConfigurationBuilder.java 3798 2006-11-04 04:07:14Z aperepel $
3  * --------------------------------------------------------------------------------------
4  * Copyright (c) MuleSource, Inc. All rights reserved. http://www.mulesource.com
5  *
6  * The software in this package is published under the terms of the MuleSource MPL
7  * license, a copy of which has been included with this distribution in the
8  * LICENSE.txt file.
9  */
10
11 package org.mule.config;
12
13 import java.util.Properties JavaDoc;
14
15 import org.mule.umo.manager.UMOManager;
16
17 /**
18  * <code>ConfigurationBuilder</code> is a Strategy class used to configure a
19  * UMOManager instance using different configuration mechanisms, such as for Xml, a
20  * script or some other means.
21  *
22  * @author <a HREF="mailto:ross.mason@symphonysoft.com">Ross Mason</a>
23  * @version $Revision: 3798 $
24  */
25 public interface ConfigurationBuilder
26 {
27     /**
28      * Will configure a UMOManager based on the configurations made available through
29      * Readers
30      *
31      * @param configResources an array of Readers
32      * @return A configured UMOManager
33      * @throws ConfigurationException
34      */
35     UMOManager configure(ReaderResource[] configResources) throws ConfigurationException;
36
37     /**
38      * Will configure a UMOManager based on the configuration file(s) provided.
39      *
40      * @param configResources a comma separated list of configuration files to load,
41      * this should be accessible on the classpath or filesystem
42      * @return A configured UMOManager
43      * @throws ConfigurationException
44      */
45     UMOManager configure(String JavaDoc configResources) throws ConfigurationException;
46
47     /**
48      * Will configure a UMOManager based on the configuration file(s) provided.
49      *
50      * @param configResources - A comma-separated list of configuration files to
51      * load, these should be accessible on the classpath or filesystem
52      * @param startupPropertiesFile - An optional file containing startup properties.
53      * This is useful for managing different environments (dev, test,
54      * production)
55      * @return A configured UMOManager
56      * @throws ConfigurationException
57      */
58     UMOManager configure(String JavaDoc configResources, String JavaDoc startupPropertiesFile) throws ConfigurationException;
59
60     /**
61      * Will configure a UMOManager based on the configurations made available through
62      * Readers
63      *
64      * @param configResources - An array of Readers, each Reader contains a portion
65      * of the Mule server configuration.
66      * @param startupProperties - Optional properties to be set before configuring
67      * the Mule server. This is useful for managing different environments
68      * (dev, test, production)
69      * @return A configured UMOManager
70      * @throws ConfigurationException
71      */
72     UMOManager configure(ReaderResource[] configResources, Properties JavaDoc startupProperties)
73         throws ConfigurationException;
74
75     boolean isConfigured();
76 }
77
Popular Tags