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  
20  import java.util.List;
21  
22  import javax.xml.namespace.QName;
23  
24  import org.opensaml.common.SAMLObject;
25  import org.opensaml.common.xml.SAMLConstants;
26  import org.opensaml.saml2.core.Attribute;
27  
28  /**
29   * SAML 2.0 Metadata AttributeAuthorityDescriptor
30   */
31  public interface AttributeAuthorityDescriptor extends SAMLObject, RoleDescriptor {
32  	
33  	/** Element name, no namespace */
34  	public final static String DEFAULT_ELEMENT_LOCAL_NAME = "AttributeAuthorityDescriptor";
35      
36      /** Default element name */
37      public final static QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML20MD_NS, DEFAULT_ELEMENT_LOCAL_NAME, SAMLConstants.SAML20MD_PREFIX);
38      
39      /** Local name of the XSI type */
40      public final static String TYPE_LOCAL_NAME = "AttributeAuthorityDescriptorType"; 
41          
42      /** QName of the XSI type */
43      public final static QName TYPE_NAME = new QName(SAMLConstants.SAML20MD_NS, TYPE_LOCAL_NAME, SAMLConstants.SAML20MD_PREFIX);
44  
45      /**
46       * Gets a list of attribute service {@link Endpoint}s for this authority.
47       * 
48       * @return list of attributes services
49       */
50      public List<AttributeService> getAttributeServices();
51      
52      /**
53       * Gets a list of Assertion ID request services.
54       * 
55       * @return list of Assertion ID request services
56       */
57      public List<AssertionIDRequestService> getAssertionIDRequestServices();
58      
59      /**
60       * Gets a list of NameID formats supported by this authority.
61       * 
62       * @return list of NameID formats supported by this authority
63       */
64      public List<NameIDFormat> getNameIDFormats();
65      
66      /**
67       * Gets a list of Attribute profiles supported by this authority.
68       * 
69       * @return list of Attribute profiles supported by this authority
70       */
71      public List<AttributeProfile> getAttributeProfiles();
72      
73      /**
74       * Gets the list of attribute available from this authority.
75       * 
76       * @return list of attribute available from this authority
77       */
78      public List<Attribute> getAttributes();
79  }