KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > axis > EngineConfigurationFactory


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2002-2003 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Axis" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation. For more
52  * information on the Apache Software Foundation, please see
53  * <http://www.apache.org/>.
54  */
55
56 package org.jboss.axis;
57
58 /**
59  * EngineConfigurationFactory is an interface used to construct
60  * concrete EngineConfiguration instances.
61  * <p/>
62  * Each EngineConfigurationFactory must also (directly) implement
63  * the following static method:
64  * <p/>
65  * //Creates and returns a new EngineConfigurationFactory.
66  * //If a factory cannot be created, return 'null'.
67  * //
68  * //The factory may return non-NULL only if:
69  * // - it knows what to do with the param (check type & process value)
70  * // - it can find it's configuration information
71  * //
72  * //@see org.jboss.axis.configuration.EngineConfigurationFactoryFinder
73  * <p/>
74  * public static EngineConfigurationFactory newFactory(Object param);
75  * <p/>
76  * This is checked at runtime and a warning generated for
77  * factories found that do NOT implement this.
78  *
79  * @author Richard A. Sitze
80  * @author Glyn Normington (glyn@apache.org)
81  */
82 public interface EngineConfigurationFactory
83 {
84    /**
85     * Property name used for setting an EngineConfiguration to be used
86     * in creating engines.
87     */
88    public static final String JavaDoc SYSTEM_PROPERTY_NAME = "axis.EngineConfigFactory";
89
90    /**
91     * Get a default client engine configuration.
92     *
93     * @return a client EngineConfiguration
94     */
95    public EngineConfiguration getClientEngineConfig();
96
97    /**
98     * Get a default server engine configuration.
99     *
100     * @return a server EngineConfiguration
101     */
102    public EngineConfiguration getServerEngineConfig();
103 }
104
Popular Tags