View Javadoc

1   /*
2    * Licensed to the University Corporation for Advanced Internet Development, 
3    * Inc. (UCAID) under one or more contributor license agreements.  See the 
4    * NOTICE file distributed with this work for additional information regarding
5    * copyright ownership. The UCAID licenses this file to You under the Apache 
6    * License, Version 2.0 (the "License"); you may not use this file except in 
7    * compliance with the License.  You may obtain a copy of the License at
8    *
9    *    http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package edu.internet2.middleware.shibboleth.common.config.attribute.encoding;
19  
20  import javax.xml.namespace.QName;
21  
22  import org.opensaml.xml.util.DatatypeHelper;
23  import org.springframework.beans.factory.BeanCreationException;
24  import org.springframework.beans.factory.support.BeanDefinitionBuilder;
25  import org.springframework.beans.factory.xml.ParserContext;
26  import org.w3c.dom.Element;
27  
28  import edu.internet2.middleware.shibboleth.common.attribute.encoding.provider.SAML2ScopedStringAttributeEncoder;
29  
30  /**
31   * Spring Bean Definition Parser for SAML2 string attribute encoder.
32   */
33  public class SAML2ScopedStringAttributeEncoderBeanDefinitionParser extends
34          BaseScopedAttributeEncoderBeanDefinitionParser {
35  
36      /** Schema type name. */
37      public static final QName TYPE_NAME = new QName(AttributeEncoderNamespaceHandler.NAMESPACE, "SAML2ScopedString");
38  
39      /** Local name of name format attribute. */
40      public static final String NAME_FORMAT_ATTRIBUTE_NAME = "nameFormat";
41  
42      /** Local name of friendly name attribute. */
43      public static final String FRIENDLY_NAME_ATTRIBUTE_NAME = "friendlyName";
44  
45      /** {@inheritDoc} */
46      protected void doParse(Element element, ParserContext parserContext, BeanDefinitionBuilder builder) {
47          super.doParse(element, parserContext, builder);
48          
49          if (element.hasAttributeNS(null, "scopeType")) {
50              builder.addPropertyValue("scopeType", element.getAttribute("scopeType"));
51          } else {
52              builder.addPropertyValue("scopeType", "inline");
53          }
54  
55          String namespace = "urn:oasis:names:tc:SAML:2.0:attrname-format:uri";
56          if (element.hasAttributeNS(null, "nameFormat")) {
57              namespace = DatatypeHelper.safeTrimOrNullString(element.getAttributeNS(null, "nameFormat"));
58          }
59          builder.addPropertyValue("nameFormat", namespace);
60          
61          builder.addPropertyValue("friendlyName", element.getAttribute(FRIENDLY_NAME_ATTRIBUTE_NAME));
62  
63          String attributeName = DatatypeHelper.safeTrimOrNullString(element.getAttributeNS(null, "name"));
64          if (attributeName == null) {
65              throw new BeanCreationException("SAML 2 attribute encoders must contain a name");
66          }
67      }
68  
69      /** {@inheritDoc} */
70      protected Class getBeanClass(Element element) {
71          return SAML2ScopedStringAttributeEncoder.class;
72      }
73  
74  }