Remove obsolete schema method from PluggableConfigurationComponent interface
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / serviceprovider / PluggableConfigurationComponent.java
1 /*
2  * Copyright [2005] [University Corporation for Advanced Internet Development, Inc.]
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 /*
18  * PluggableConfigurationComponent.java
19  * 
20  * Classes that implement a Pluggable configuration service
21  * must also implement this interface.
22  * 
23  * After loading a class by passing the type= attribute to
24  * Class.forName(), a specific sanity check can be performed
25  * by verifying that the loaded class implements this interface.
26  * This ensures that it really is a Plugin.
27  * 
28  * The initialize() method is then called, passing a DOM
29  * node that represents the configuration information for
30  * the plugin, either as opaque inline XML or from a 
31  * loaded external file.
32  * 
33  * Note: in earlier releases the DOM node was passed to
34  * the constructor, but it is safer to support a default
35  * (no argument) constructor and handle initialization though
36  * an interface like this.
37  * 
38  * Note: To be useful, the implementing class must also
39  * implement some functional interface, such as Trust or
40  * AAP. This interface just manages the load and initialization
41  * part.
42  * 
43  * For examples of use, see one of the builtin implementation
44  * classes (XMLMetadataImpl, ...).
45  */
46 package edu.internet2.middleware.shibboleth.serviceprovider;
47
48 import org.apache.xmlbeans.XmlException;
49 import org.w3c.dom.Node;
50
51 import edu.internet2.middleware.shibboleth.common.ShibbolethConfigurationException;
52
53 interface PluggableConfigurationComponent {
54     
55     public abstract void 
56     initialize(Node dom) 
57         throws 
58         XmlException, // If there is a problem in the configuration data
59         ShibbolethConfigurationException; // for other problems
60     
61 }