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 javax.xml.namespace.QName;
20  
21  import org.opensaml.common.xml.SAMLConstants;
22  import org.opensaml.saml2.core.Attribute;
23  import org.opensaml.xml.schema.XSBooleanValue;
24  
25  /**
26   * SAML 2.0 Metadata RequestedAttribute
27   * 
28   */
29  public interface RequestedAttribute extends Attribute {
30  
31      /** Local name, no namespace */
32      public final static String DEFAULT_ELEMENT_LOCAL_NAME = "RequestedAttribute";
33  
34      /** Default element name */
35      public final static QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML20MD_NS, DEFAULT_ELEMENT_LOCAL_NAME,
36              SAMLConstants.SAML20MD_PREFIX);
37  
38      /** Local name of the XSI type */
39      public final static String TYPE_LOCAL_NAME = "RequestedAttributeType";
40  
41      /** QName of the XSI type */
42      public final static QName TYPE_NAME = new QName(SAMLConstants.SAML20MD_NS, TYPE_LOCAL_NAME,
43              SAMLConstants.SAML20MD_PREFIX);
44  
45      /** "isRequired" attribute's local name */
46      public final static String IS_REQUIRED_ATTRIB_NAME = "isRequired";
47  
48      /**
49       * Checks to see if this requested attribute is also required.
50       * 
51       * @return true if this attribute is required
52       */
53      public Boolean isRequired();
54  
55      /**
56       * Checks to see if this requested attribute is also required.
57       * 
58       * @return true if this attribute is required
59       */
60      public XSBooleanValue isRequiredXSBoolean();
61  
62      /**
63       * Sets if this requested attribute is also required. Boolean values will be marshalled to either "true" or "false".
64       * 
65       * @param newIsRequire true if this attribute is required
66       */
67      public void setIsRequired(Boolean newIsRequire);
68  
69      /**
70       * Sets if this requested attribute is also required.
71       * 
72       * @param newIsRequire true if this attribute is required
73       */
74      public void setIsRequired(XSBooleanValue newIsRequire);
75  }