View Javadoc

1   /*
2    * Copyright [2007] [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 edu.internet2.middleware.shibboleth.common.config.attribute.encoding;
18  
19  import javax.xml.namespace.QName;
20  
21  import org.opensaml.xml.util.DatatypeHelper;
22  import org.springframework.beans.factory.BeanCreationException;
23  import org.springframework.beans.factory.support.BeanDefinitionBuilder;
24  import org.springframework.beans.factory.xml.ParserContext;
25  import org.w3c.dom.Element;
26  
27  import edu.internet2.middleware.shibboleth.common.attribute.encoding.provider.SAML2ScopedStringAttributeEncoder;
28  
29  /**
30   * Spring Bean Definition Parser for SAML2 string attribute encoder.
31   */
32  public class SAML2ScopedStringAttributeEncoderBeanDefinitionParser extends
33          BaseScopedAttributeEncoderBeanDefinitionParser {
34  
35      /** Schema type name. */
36      public static final QName TYPE_NAME = new QName(AttributeEncoderNamespaceHandler.NAMESPACE, "SAML2ScopedString");
37  
38      /** Local name of name format attribute. */
39      public static final String NAME_FORMAT_ATTRIBUTE_NAME = "nameFormat";
40  
41      /** Local name of friendly name attribute. */
42      public static final String FRIENDLY_NAME_ATTRIBUTE_NAME = "friendlyName";
43  
44      /** {@inheritDoc} */
45      protected void doParse(Element element, ParserContext parserContext, BeanDefinitionBuilder builder) {
46          super.doParse(element, parserContext, builder);
47          
48          if (element.hasAttributeNS(null, "scopeType")) {
49              builder.addPropertyValue("scopeType", element.getAttribute("scopeType"));
50          } else {
51              builder.addPropertyValue("scopeType", "inline");
52          }
53  
54          String namespace = "urn:oasis:names:tc:SAML:2.0:attrname-format:uri";
55          if (element.hasAttributeNS(null, "nameFormat")) {
56              namespace = DatatypeHelper.safeTrimOrNullString(element.getAttributeNS(null, "nameFormat"));
57          }
58          builder.addPropertyValue("nameFormat", namespace);
59          
60          builder.addPropertyValue("friendlyName", element.getAttribute(FRIENDLY_NAME_ATTRIBUTE_NAME));
61  
62          String attributeName = DatatypeHelper.safeTrimOrNullString(element.getAttributeNS(null, "name"));
63          if (attributeName == null) {
64              throw new BeanCreationException("SAML 2 attribute encoders must contain a name");
65          }
66      }
67  
68      /** {@inheritDoc} */
69      protected Class getBeanClass(Element element) {
70          return SAML2ScopedStringAttributeEncoder.class;
71      }
72  
73  }