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.resolver.principalConnector;
19  
20  import org.springframework.beans.factory.support.BeanDefinitionBuilder;
21  import org.springframework.beans.factory.xml.ParserContext;
22  import org.w3c.dom.Element;
23  
24  import edu.internet2.middleware.shibboleth.common.config.attribute.resolver.AbstractResolutionPlugInBeanDefinitionParser;
25  
26  /**
27   * Base spring bean definition parser for principal connectors. PrincipalConnector implementations should provide a
28   * custom BeanDefinitionParser by extending this class and overriding the doParse() method to parse any additional
29   * attributes or elements it requires. Standard attributes and elements defined by the ResolutionPlugIn and
30   * PrincipalConnector schemas will automatically attempt to be parsed.
31   */
32  public abstract class BasePrincipalConnectrBeanDefinitionParser extends AbstractResolutionPlugInBeanDefinitionParser {
33  
34      /** NameID format attribute name. */
35      public static final String NAMEID_FORMAT_ATTRIBUTE_NAME = "nameIDFormat";
36  
37      /** {@inheritDoc} */
38      protected void doParse(String pluginId, Element pluginConfig,
39              java.util.Map<javax.xml.namespace.QName, java.util.List<Element>> pluginConfigChildren,
40              BeanDefinitionBuilder pluginBuilder, ParserContext parserContext) {
41  
42          pluginBuilder.addPropertyValue("nameIdFormat", pluginConfig.getAttributeNS(null, NAMEID_FORMAT_ATTRIBUTE_NAME));
43      }
44  }