Metadata support for old and new schemas, and API changes.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / metadata / EntityDescriptor.java
1 /*
2  * The Shibboleth License, Version 1. Copyright (c) 2002 University Corporation for Advanced Internet Development, Inc.
3  * All rights reserved Redistribution and use in source and binary forms, with or without modification, are permitted
4  * provided that the following conditions are met: Redistributions of source code must retain the above copyright
5  * notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the
6  * above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other
7  * materials provided with the distribution, if any, must include the following acknowledgment: "This product includes
8  * software developed by the University Corporation for Advanced Internet Development <http://www.ucaid.edu>Internet2
9  * Project. Alternately, this acknowledegement may appear in the software itself, if and wherever such third-party
10  * acknowledgments normally appear. Neither the name of Shibboleth nor the names of its contributors, nor Internet2,
11  * nor the University Corporation for Advanced Internet Development, Inc., nor UCAID may be used to endorse or promote
12  * products derived from this software without specific prior written permission. For written permission, please
13  * contact shibboleth@shibboleth.org Products derived from this software may not be called Shibboleth, Internet2,
14  * UCAID, or the University Corporation for Advanced Internet Development, nor may Shibboleth appear in their name,
15  * without prior written permission of the University Corporation for Advanced Internet Development. THIS SOFTWARE IS
16  * PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES,
17  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
18  * NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS
19  * WITH LICENSEE. IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY CORPORATION FOR ADVANCED
20  * INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
23  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24  * POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 package edu.internet2.middleware.shibboleth.metadata;
28
29 import java.util.Iterator;
30 import java.util.Map;
31
32 import org.w3c.dom.Element;
33
34 /**
35  * <p>Corresponds to SAML Metadata Schema "EntityDescriptorType".
36  * </p><p>
37  * Entities are campuses or departments with either an origin or target
38  * infrastructure (or both). Each implemented component (HS, AA, SHAR) 
39  * has a Role definition with URLs and PKI to locate and authenticate
40  * the provider of that role. Although the Metadata may define all 
41  * roles, target code tends to build objects describing origins, and 
42  * origins are only interested in targets.
43  * 
44  * @author Walter Hoehn (wassa@columbia.edu)
45  */
46 public interface EntityDescriptor {
47
48         public String getId();  // Unique ID used as global key of Provider
49     
50     public boolean isValid();   // Is this entity descriptor "active"?
51
52     public Iterator /* <RoleDescriptor> */ getRoleDescriptors(); // Role definitions
53
54     /**
55      *  Finds a role descriptor of a particular type that supports the
56      *  specified protocol.
57      * 
58      * @param type  The type of role to locate
59      * @param protocol  The protocol constant that must be supported
60      * @return  The matching role decsriptor, if any
61      */
62     public RoleDescriptor getRoleByType(Class type, String protocol);
63     
64     public IDPSSODescriptor getIDPSSODescriptor(String protocol);
65     public SPSSODescriptor getSPSSODescriptor(String protocol);
66     public AuthnAuthorityDescriptor getAuthnAuthorityDescriptor(String protocol);
67     public AttributeAuthorityDescriptor getAttributeAuthorityDescriptor(String protocol);
68     public PDPDescriptor getPDPDescriptor(String protocol);
69     public AffiliationDescriptor getAffiliationDescriptor();
70     
71     public Organization getOrganization();  // associated organization
72     
73     public Iterator /* <ContactPerson> */ getContactPersons();    // support contacts
74     
75     public Map /* <String,String> */ getAdditionalMetadataLocations(); // XML Namespace - location pairs
76     
77     public EntitiesDescriptor getEntitiesDescriptor(); // parent group, if any
78     
79     public Element getElement();    // punch through to raw XML, if enabled
80 }