EngineConfiguration


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  import org.jboss.axis.encoding.TypeMappingRegistry;
59  import org.jboss.axis.handlers.soap.SOAPService;
60  
61  import javax.xml.namespace.QName  ;
62  import java.util.Hashtable  ;
63  import java.util.Iterator  ;
64  
65  /**
66   * EngineConfiguration is an interface that the Message Flow subsystem
67   * provides so that engine configuration can be provided in a pluggable
68   * way. An instance of EngineConfiguration provides configuration
69   * for a particular engine instance.
70   * <p/>
71   * Concrete implementations of this interface will obtain configuration
72   * information from some source (examples might be files, Strings, or
73   * databases) and are responsible for writing it into an AxisEngine, and
74   * writing an AxisEngine's state back out to whatever storage medium is in use.
75   *
76   * @author Glyn Normington (glyn@apache.org)
77   * @author Glen Daniels (gdaniels@macromedia.com)
78   */
79  public interface EngineConfiguration
80  {
81     /**
82      * Property name used for setting an EngineConfiguration to be used
83      * in creating engines.
84      */
85     static final String   PROPERTY_NAME = "engineConfig";
86  
87     /**
88      * Configure this AxisEngine using whatever data source we have.
89      *
90      * @param engine the AxisEngine we'll deploy state to
91      * @throws ConfigurationException if there was a problem
92      */
93     void configureEngine(AxisEngine engine) throws ConfigurationException;
94  
95     /**
96      * Read the configuration from an engine, and store it somehow.
97      *
98      * @param engine the AxisEngine from which to read state.
99      * @throws ConfigurationException if there was a problem
100     */
101    void writeEngineConfig(AxisEngine engine) throws ConfigurationException;
102 
103    /**
104     * retrieve an instance of the named handler
105     *
106     * @param qname XXX
107     * @return XXX
108     * @throws ConfigurationException XXX
109     */
110    Handler getHandler(QName   qname) throws ConfigurationException;
111 
112    /**
113     * retrieve an instance of the named service
114     *
115     * @param qname XXX
116     * @return XXX
117     * @throws ConfigurationException XXX
118     */
119    SOAPService getService(QName   qname) throws ConfigurationException;
120 
121    /**
122     * Get a service which has been mapped to a particular namespace
123     *
124     * @param namespace a namespace URI
125     * @return an instance of the appropriate Service, or null
126     */
127    SOAPService getServiceByNamespaceURI(String   namespace)
128            throws ConfigurationException;
129 
130    /**
131     * retrieve an instance of the named transport
132     *
133     * @param qname XXX
134     * @return XXX
135     * @throws ConfigurationException XXX
136     */
137    Handler getTransport(QName   qname) throws ConfigurationException;
138 
139    /**
140     * Retrieve the TypeMappingRegistry for this engine
141     */
142    TypeMappingRegistry getTypeMappingRegistry()
143            throws ConfigurationException;
144 
145    /**
146     * Returns a global request handler.
147     */
148    Handler getGlobalRequest() throws ConfigurationException;
149 
150    /**
151     * Returns a global response handler.
152     */
153    Handler getGlobalResponse() throws ConfigurationException;
154 
155    /**
156     * Returns the global configuration options.
157     */
158    Hashtable   getGlobalOptions() throws ConfigurationException;
159 
160    /**
161     * Get an enumeration of the services deployed to this engine,
162     * these are represented as ServiceDesc objects
163     *
164     * @return something to iterate with
165     * @see org.jboss.axis.description.ServiceDesc
166     */
167    Iterator   getDeployedServices() throws ConfigurationException;
168 }
169
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags