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