View Javadoc

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  package org.opensaml.saml2.metadata;
18  
19  import java.util.List;
20  
21  import javax.xml.namespace.QName;
22  
23  import org.opensaml.common.SignableSAMLObject;
24  import org.opensaml.common.xml.SAMLConstants;
25  import org.opensaml.saml2.common.CacheableSAMLObject;
26  import org.opensaml.saml2.common.Extensions;
27  import org.opensaml.saml2.common.TimeBoundSAMLObject;
28  import org.opensaml.xml.AttributeExtensibleXMLObject;
29  
30  /**
31   * SAML 2.0 Metadata AffiliationDescriptorType
32   */
33  public interface AffiliationDescriptor extends SignableSAMLObject, TimeBoundSAMLObject, CacheableSAMLObject,
34          AttributeExtensibleXMLObject {
35  
36      /** Element name, no namespace */
37      public final static String DEFAULT_ELEMENT_LOCAL_NAME = "AffiliationDescriptor";
38      
39      /** Default element name */
40      public final static QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML20MD_NS, DEFAULT_ELEMENT_LOCAL_NAME, SAMLConstants.SAML20MD_PREFIX);
41      
42      /** Local name of the XSI type */
43      public final static String TYPE_LOCAL_NAME = "AffiliationDescriptorType"; 
44          
45      /** QName of the XSI type */
46      public final static QName TYPE_NAME = new QName(SAMLConstants.SAML20MD_NS, TYPE_LOCAL_NAME, SAMLConstants.SAML20MD_PREFIX);
47  
48      /** "affiliationOwnerID" attribute's local name */
49      public final static String OWNER_ID_ATTRIB_NAME = "affiliationOwnerID";
50  
51      /** ID attribute's local name */
52      public final static String ID_ATTRIB_NAME = "ID";
53  
54      /**
55       * Gets the ID of the owner of this affiliation. The owner may, or may not, be a memeber of the affiliation.
56       * 
57       * @return the ID of the owner of this affiliation
58       */
59      public String getOwnerID();
60  
61      /**
62       * Gets the ID of this Descriptor.
63       * 
64       * @return the ID of this Descriptor
65       */
66      public String getID();
67  
68      /**
69       * Gets the Extensions child of this object.
70       * 
71       * @return the Extensions child of this object
72       */
73      public Extensions getExtensions();
74  
75      /**
76       * Sets the Extensions child of this object.
77       * 
78       * @param extensions the Extensions child of this object
79       * 
80       * @throws IllegalArgumentException thrown if the given extensions Object is already a child of another SAMLObject
81       */
82      public void setExtensions(Extensions extensions) throws IllegalArgumentException;
83  
84      /**
85       * Sets the ID of the owner of this affiliation.
86       * 
87       * @param ownerID the ID of the owner of this affiliation
88       */
89      public void setOwnerID(String ownerID);
90  
91      /**
92       * Sets the ID of this descriptor.
93       * 
94       * @param newID the ID of this descriptor
95       */
96      public void setID(String newID);
97  
98      /**
99       * Gets a list of the members of this affiliation.
100      * 
101      * @return a list of affiliate members
102      */
103     public List<AffiliateMember> getMembers();
104 
105     /**
106      * Gets an immutable list of KeyDescriptors for this affiliation.
107      * 
108      * @return list of {@link KeyDescriptor}s for this affiliation
109      */
110     public List<KeyDescriptor> getKeyDescriptors();
111 }