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.ResolutionPlugIn;
24  
25  /**
26   * A plugin used to pull attribute information from a data store.
27   * 
28   * Data connectors must be stateless and thread-safe as a single instance may be used to service every request.
29   */
30  public interface DataConnector extends ResolutionPlugIn<Map<String, BaseAttribute>> {
31  
32      /**
33       * Returns the ID of data connectors to use if this one fails.
34       * 
35       * @return ID of data connectors to use if this one fails
36       */
37      public String getFailoverDependencyId();
38  }