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