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