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.xml.SAMLConstants;
24  
25  
26  /**
27   * SAML 2.0 Metadata SSODescriptor
28   */
29  public interface SSODescriptor extends RoleDescriptor {
30  
31      /** Element name, no namespace */
32      public final static String DEFAULT_ELEMENT_LOCAL_NAME = "SSODescriptor";
33      
34      /** Default element name */
35      public final static QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML20MD_NS, DEFAULT_ELEMENT_LOCAL_NAME, SAMLConstants.SAML20MD_PREFIX);
36      
37      /** Local name of the XSI type */
38      public final static String TYPE_LOCAL_NAME = "SSODescriptorType"; 
39          
40      /** QName of the XSI type */
41      public final static QName TYPE_NAME = new QName(SAMLConstants.SAML20MD_NS, TYPE_LOCAL_NAME, SAMLConstants.SAML20MD_PREFIX);
42      
43      /**
44       * Gets a list of artifact resolution services for this service.
45       * 
46       * @return list of artifact resolution services for this service
47       */
48  	public List<ArtifactResolutionService> getArtifactResolutionServices();
49      
50      /**
51       * Gets the default artifact resolution service or null if no service is marked as the default.
52       * 
53       * @return default artifact resolution service or null if no service is marked as the default
54       */
55      public ArtifactResolutionService getDefaultArtificateResolutionService();
56  
57      /**
58       * Gets a list of single logout services for this service.
59       * 
60       * @return list of single logout services for this service
61       */
62  	public List<SingleLogoutService> getSingleLogoutServices();
63  
64      /**
65       * Gets a list of manage NameId services for this service.
66       * 
67       * @return list of manage NameId services for this service
68       */
69  	public List<ManageNameIDService> getManageNameIDServices();
70      
71      /**
72       * Gets the list of NameID formats this service supports.
73       * 
74       * @return NameID formats this service supports
75       */
76      public List<NameIDFormat> getNameIDFormats();
77  }