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  import org.opensaml.saml2.core.Attribute;
25  import org.opensaml.xml.schema.XSBooleanValue;
26  
27  /**
28   * SAML 2.0 Metadata IDPSSODescriptorType
29   */
30  public interface IDPSSODescriptor extends SSODescriptor {
31  
32      /** Local name, no namespace */
33      public final static String DEFAULT_ELEMENT_LOCAL_NAME = "IDPSSODescriptor";
34  
35      /** Default element name */
36      public final static QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML20MD_NS, DEFAULT_ELEMENT_LOCAL_NAME,
37              SAMLConstants.SAML20MD_PREFIX);
38  
39      /** Local name of the XSI type */
40      public final static String TYPE_LOCAL_NAME = "IDPSSODescriptorType";
41  
42      /** QName of the XSI type */
43      public final static QName TYPE_NAME = new QName(SAMLConstants.SAML20MD_NS, TYPE_LOCAL_NAME,
44              SAMLConstants.SAML20MD_PREFIX);
45  
46      /** "WantAuthnRequestSigned" attribute name */
47      public final static String WANT_AUTHN_REQ_SIGNED_ATTRIB_NAME = "WantAuthnRequestsSigned";
48  
49      /**
50       * Checks if the IDP SSO service wants authentication requests signed.
51       * 
52       * @return true is signing is desired, false if not
53       */
54      public Boolean getWantAuthnRequestsSigned();
55  
56      /**
57       * Checks if the IDP SSO service wants authentication requests signed.
58       * 
59       * @return true is signing is desired, false if not
60       */
61      public XSBooleanValue getWantAuthnRequestsSignedXSBoolean();
62  
63      /**
64       * Sets whether the IDP SSO service wants authentication requests signed. Boolean values will be marshalled to
65       * either "true" or "false".
66       * 
67       * @param newWantSigned true if request should be signed, false if not
68       */
69      public void setWantAuthnRequestsSigned(Boolean newWantSigned);
70  
71      /**
72       * Sets whether the IDP SSO service wants authentication requests signed.
73       * 
74       * @param newWantSigned true if request should be signed, false if not
75       */
76      public void setWantAuthnRequestsSigned(XSBooleanValue newWantSigned);
77  
78      /**
79       * Gets the list of single sign on services for this IDP.
80       * 
81       * @return list of single sign on services
82       */
83      public List<SingleSignOnService> getSingleSignOnServices();
84  
85      /**
86       * Gets the list of NameID mapping services for this service.
87       * 
88       * @return the list of NameID mapping services for this service
89       */
90      public List<NameIDMappingService> getNameIDMappingServices();
91  
92      /**
93       * Gets the list of assertion ID request services.
94       * 
95       * @return assertion ID request services
96       */
97      public List<AssertionIDRequestService> getAssertionIDRequestServices();
98  
99      /**
100      * Gets the list of attribute profiles supported by this IdP.
101      * 
102      * @return attribute profiles supported by this IdP
103      */
104     public List<AttributeProfile> getAttributeProfiles();
105 
106     /**
107      * Gets the list of attributes supported by this IdP.
108      * 
109      * @return attributes supported by this IdP
110      */
111     public List<Attribute> getAttributes();
112 }