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