View Javadoc

1   /*
2    * Copyright [2006] [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.samlext.saml2mdquery;
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.metadata.NameIDFormat;
25  import org.opensaml.saml2.metadata.RoleDescriptor;
26  import org.opensaml.xml.schema.XSBooleanValue;
27  
28  /**
29   * SAML 2.0 Metadata extension QueryDescriptorType.
30   */
31  public interface QueryDescriptorType extends RoleDescriptor {
32      
33      /** Local name of the XSI type. */
34      public static final String TYPE_LOCAL_NAME = "QueryDescriptorType";
35  
36      /** QName of the XSI type. */
37      public static final QName TYPE_NAME = new QName(SAMLConstants.SAML20MDQUERY_NS, TYPE_LOCAL_NAME,
38              SAMLConstants.SAML20MDQUERY_PREFIX);
39      
40      /** "WantAssertionSigned" attribute's local name. */
41      public static final String WANT_ASSERTIONS_SIGNED_ATTRIB_NAME = "WantAssertionsSigned";
42      
43      /**
44       * Gets whether assertions to this endpoint should be signed.
45       * 
46       * @return whether assertions to this endpoint should be signed
47       */
48      public Boolean getWantAssertionsSigned();
49      
50      /**
51       * Gets whether assertions to this endpoint should be signed.
52       * 
53       * @return whether assertions to this endpoint should be signed
54       */
55      public XSBooleanValue getWantAssertionsSignedXSBoolean();
56      
57      /**
58       * Sets whether assertions to this endpoint should be signed.
59       * 
60       * @param newWantAssertionsSigned whether assertions to this endpoint should be signed
61       */
62      public void setWantAssertionsSigned(Boolean newWantAssertionsSigned);
63      
64      /**
65       * Sets whether assertions to this endpoint should be signed.
66       * 
67       * @param newWantAssertionsSigned whether assertions to this endpoint should be signed
68       */
69      public void setWantAssertionsSigned(XSBooleanValue newWantAssertionsSigned);
70      
71      /**
72       * Gets the list of name ID formats supported by this query service.
73       * 
74       * @return the list of name ID formats supported by this query service
75       */
76      public List<NameIDFormat> getNameIDFormat();
77  }