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.service;
19  
20  import java.util.List;
21  
22  import org.opensaml.xml.util.XMLHelper;
23  import org.springframework.beans.factory.support.AbstractBeanDefinition;
24  import org.springframework.beans.factory.support.BeanDefinitionBuilder;
25  import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser;
26  import org.springframework.beans.factory.xml.ParserContext;
27  import org.w3c.dom.Element;
28  
29  import edu.internet2.middleware.shibboleth.common.config.SpringConfigurationUtils;
30  
31  /** Base bean definition parser for service objects. */
32  public abstract class AbstractServiceBeanDefinitionParser extends AbstractSingleBeanDefinitionParser {
33  
34      /** {@inheritDoc} */
35      protected void doParse(Element configElement, ParserContext parserContext, BeanDefinitionBuilder builder) {
36          List<Element> configurationResources = XMLHelper.getChildElementsByTagNameNS(configElement,
37                  ServiceNamespaceHandler.NAMESPACE, "ConfigurationResource");
38          builder.addPropertyValue("serviceConfigurations", SpringConfigurationUtils.parseInnerCustomElements(
39                  configurationResources, parserContext));
40  
41          builder.addDependsOn("shibboleth.LogbackLogging");
42          for (String dependency : XMLHelper
43                  .getAttributeValueAsList(configElement.getAttributeNodeNS(null, "depends-on"))) {
44              builder.addDependsOn(dependency);
45          }
46  
47          builder.setInitMethodName("initialize");
48      }
49  
50      /** {@inheritDoc} */
51      protected String resolveId(Element configElement, AbstractBeanDefinition beanDef, ParserContext parserContext) {
52          return getServiceId(configElement);
53      }
54      
55      /**
56       * Gets the ID of the service.
57       * 
58       * @param configElement service configuration element
59       * 
60       * @return ID of the service
61       */
62      protected String getServiceId(Element configElement){
63          return configElement.getAttributeNS(null, "id");
64      }
65  }