Update to current Trust 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 getSchemaPathname() method returns the resource name
29  * of the schema file used to parse the XML configuration data.
30  * 
31  * The initialize() method is then called, passing a DOM
32  * node that represents the configuration information for
33  * the plugin, either as opaque inline XML or from a 
34  * loaded external file.
35  * 
36  * Note: in earlier releases the DOM node was passed to
37  * the constructor, but it is safer to support a default
38  * (no argument) constructor and handle initialization though
39  * an interface like this.
40  * 
41  * Note: To be useful, the implementing class must also
42  * implement some functional interface, such as Trust or
43  * AAP. This interface just manages the load and initialization
44  * part.
45  * 
46  * For examples of use, see one of the builtin implementation
47  * classes (XMLMetadataImpl, ...).
48  */
49 package edu.internet2.middleware.shibboleth.serviceprovider;
50
51 import org.apache.xmlbeans.XmlException;
52 import org.w3c.dom.Node;
53
54 import edu.internet2.middleware.shibboleth.common.ShibbolethConfigurationException;
55
56 interface PluggableConfigurationComponent {
57     
58     public abstract void 
59     initialize(Node dom) 
60         throws 
61         XmlException, // If there is a problem in the configuration data
62         ShibbolethConfigurationException; // for other problems
63     
64     public String getSchemaPathname();
65 }