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.attribute.resolver.provider.dataConnector;
19  
20  import java.util.Map;
21  
22  import edu.internet2.middleware.shibboleth.common.attribute.BaseAttribute;
23  import edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.AbstractResolutionPlugIn;
24  
25  /**
26   * Base class for {@link DataConnector} plug-ins.
27   */
28  public abstract class BaseDataConnector extends AbstractResolutionPlugIn<Map<String, BaseAttribute>> implements
29          DataConnector {
30  
31      /** ID of the data connector to use if this one fails. */
32      private String failoverDependencyId;
33      
34      /** Constructor. */
35      public BaseDataConnector(){
36          super();
37      }
38  
39      /** {@inheritDoc} */
40      public String getFailoverDependencyId() {
41          return failoverDependencyId;
42      }
43  
44      /**
45       * Set the ID of data connectors to use if this one fails.
46       * 
47       * @param id ID of data connectors to use if this one fails
48       */
49      public void setFailoverDependencyIds(String id) {
50          failoverDependencyId = id;
51      }
52  }