View Javadoc

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