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.dataConnector;
19  
20  import java.util.List;
21  import java.util.Map;
22  
23  import javax.xml.namespace.QName;
24  
25  import org.opensaml.xml.util.DatatypeHelper;
26  import org.slf4j.Logger;
27  import org.slf4j.LoggerFactory;
28  import org.springframework.beans.factory.support.BeanDefinitionBuilder;
29  import org.springframework.beans.factory.xml.ParserContext;
30  import org.w3c.dom.Element;
31  
32  import edu.internet2.middleware.shibboleth.common.config.attribute.resolver.AbstractResolutionPlugInBeanDefinitionParser;
33  import edu.internet2.middleware.shibboleth.common.config.attribute.resolver.AttributeResolverNamespaceHandler;
34  
35  /**
36   * Base spring bean definition parser for data connectors. DataConnector implementations should provide a custom
37   * BeanDefinitionParser by extending this class and overriding the
38   * {@link #doParse(String, Element, Map, BeanDefinitionBuilder, ParserContext)} method to parse any additional
39   * attributes or elements it requires. Standard attributes and elements defined by the ResolutionPlugIn and
40   * DataConnector schemas will automatically attempt to be parsed.
41   */
42  public abstract class BaseDataConnectorBeanDefinitionParser extends AbstractResolutionPlugInBeanDefinitionParser {
43  
44      /** Failover data connector attribute name. */
45      public static final QName FAILOVER_DATA_CONNECTOR_ELEMENT_NAME = new QName(
46              AttributeResolverNamespaceHandler.NAMESPACE, "FailoverDataConnector");
47  
48      /** Log4j logger. */
49      private final Logger log = LoggerFactory.getLogger(BaseDataConnectorBeanDefinitionParser.class);
50  
51      /** {@inheritDoc} */
52      protected void doParse(String pluginId, Element pluginConfig, Map<QName, List<Element>> pluginConfigChildren,
53              BeanDefinitionBuilder pluginBuilder, ParserContext parserContext) {
54  
55          List<Element> failoverConnector = pluginConfigChildren.get(FAILOVER_DATA_CONNECTOR_ELEMENT_NAME);
56          if (failoverConnector != null && !failoverConnector.isEmpty()) {
57              String connectorId = DatatypeHelper.safeTrimOrNullString(failoverConnector.get(0).getAttributeNS(null,
58                      "ref"));
59              log.debug("Setting the following failover data connector dependencies for plugin {}: {}", pluginId,
60                      connectorId);
61              pluginBuilder.addPropertyValue("failoverDataConnectorIds", connectorId);
62          }
63      }
64  }