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