1 /* 2 * Copyright 2010 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.encoding; 18 19 import org.opensaml.xml.XMLObject; 20 21 /** 22 * Base interface for encoders that generate SAML name identifiers. 23 * 24 * @param <NameIDType> the type of name identifier generated 25 */ 26 public interface SAMLNameIdentifierEncoder<NameIDType extends XMLObject> extends XMLObjectAttributeEncoder<NameIDType> { 27 28 /** 29 * Gets the name format URI for the NameID. 30 * 31 * @return name format URI for the NameID 32 */ 33 public String getNameFormat(); 34 35 /** 36 * Sets the name format URI for the NameID. 37 * 38 * @param format name format URI for the NameID 39 */ 40 public void setNameFormat(String format); 41 42 /** 43 * Gets the name domain qualifier for the NameID. 44 * 45 * @return name domain qualifier for the NameID 46 */ 47 public String getNameQualifier(); 48 49 /** 50 * Sets the name domain qualifier for the NameID. 51 * 52 * @param qualifier name domain qualifier for the NameID 53 */ 54 public void setNameQualifier(String qualifier); 55 }