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.principalConnector;
18  
19  import java.util.Set;
20  
21  import edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.ResolutionPlugIn;
22  
23  /**
24   * Principal connectors are responsible for taking subject's SAML name identifier and converting it into a string based
25   * principal (user) name.
26   * 
27   * This plugin and all its dependencies are guarenteed to run prior to the attribute definitions meant to provide
28   * attributes about the user, such that those definitions and data connectors will have access to a principal name.
29   */
30  public interface PrincipalConnector extends ResolutionPlugIn<String> {
31  
32      /**
33       * Get NamID format.
34       * 
35       * @return the NameID format
36       */
37      public String getFormat();
38  
39      /**
40       * Get relying parties this connector is valid for.
41       * 
42       * @return set of relying parties
43       */
44      public Set<String> getRelyingParties();
45  }