KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > soap > util > ConfigManager


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2000 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 "SOAP" 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 and was
52  * originally based on software copyright (c) 2000, International
53  * Business Machines, Inc., http://www.apache.org. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  */
57
58 package org.apache.soap.util;
59
60 import java.util.* ;
61 import javax.servlet.* ;
62 import javax.servlet.http.* ;
63 import org.apache.soap.* ;
64 import org.apache.soap.rpc.* ;
65 import org.apache.soap.server.* ;
66
67 /**
68  * A <code>ConfigManager</code> ...
69  *
70  * @author Dug (dug@us.ibm.com)
71  *
72  * With the introduction of a ConfigManager, the notion of a SOAP
73  * configuration file was also introduced. The SOAP server will now
74  * look for a 'soap.xml' file - or whatever filename was specified
75  * by the 'ConfigFile' init parameter of the Servlet.
76  * The soap.xml file should look like:
77  * <soapServer>
78  * <!-- This section defines the same thing you get if you don't -->
79  * <!-- specify anything at all - aka the default -->
80  * <configManager value="org.apache.soap.server.DefaultConfigManager" >
81  * <option name="filename" value="DS.ds" />
82  * </configManager>
83  * </soapServer>
84  *
85  * See 'DefaultConfigManager' for more info.
86  *
87  * Classes that implement these APIs are responsible for saving and
88  * loading the list of deployed services. The SOAP server will just
89  * call deploy/undeploy... and its up to the class that implements
90  * these API to handling the persistence of the list. See the
91  * DefaultConfigManager to see an example of how to do this.
92  *
93  * Init will be called after the 'setOptions' call allowing the ConfigMgr
94  * to do any setup.
95  *
96  */
97 public interface ConfigManager
98 {
99   public void setContext(ServletContext context);
100   public void setOptions( Hashtable options ) throws SOAPException ;
101   public void init() throws SOAPException ;
102   public void deploy( DeploymentDescriptor dd ) throws SOAPException ;
103   public String JavaDoc[] list() throws SOAPException ;
104
105   public DeploymentDescriptor undeploy( String JavaDoc id ) throws SOAPException ;
106   public DeploymentDescriptor query(String JavaDoc id) throws SOAPException ;
107 }
108
Popular Tags