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 edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.dataConnector.BaseDataConnector;
21  import edu.internet2.middleware.shibboleth.common.config.attribute.resolver.AbstractResolutionPluginFactoryBean;
22  
23  /**
24   * Base class for data connector factories.
25   */
26  public abstract class BaseDataConnectorFactoryBean extends AbstractResolutionPluginFactoryBean {
27  
28      /** ID of failover data connectors for this plugin. */
29      private String failoverDataConnectorId;
30  
31      /**
32       * Gets the ID of failover data connectors for this plugin.
33       * 
34       * @return ID of failover data connectors for this plugin
35       */
36      public String getFailoverDataConnectorId() {
37          return failoverDataConnectorId;
38      }
39  
40      /**
41       * Sets the ID of failover data connectors for this plugin.
42       * 
43       * @param id ID of failover data connectors for this plugin
44       */
45      public void setFailoverDataConnectorIds(String id) {
46          failoverDataConnectorId = id;
47      }
48  
49      /**
50       * Populates data connector with information from this factory.
51       * 
52       * @param connector data connector with information from this factory
53       */
54      protected void populateDataConnector(BaseDataConnector connector) {
55          connector.setId(getPluginId());
56  
57          if (getDependencyIds() != null) {
58              connector.getDependencyIds().addAll(getDependencyIds());
59          }
60  
61          if (getFailoverDataConnectorId() != null) {
62              connector.setFailoverDependencyIds(getFailoverDataConnectorId());
63          }
64      }
65  }