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 org.opensaml.saml2.core; 18 19 /** 20 * SAML 2.0 Assertion NameID schema type. 21 */ 22 public interface NameIDType { 23 24 /** NameQualifier attribute name. */ 25 public static final String NAME_QUALIFIER_ATTRIB_NAME = "NameQualifier"; 26 27 /** SPNameQualifier attribute name. */ 28 public static final String SP_NAME_QUALIFIER_ATTRIB_NAME = "SPNameQualifier"; 29 30 /** Format attribute name. */ 31 public static final String FORMAT_ATTRIB_NAME = "Format"; 32 33 /** SPProviderID attribute name. */ 34 public static final String SPPROVIDED_ID_ATTRIB_NAME = "SPProvidedID"; 35 36 /** URI for unspecified name format. */ 37 public static final String UNSPECIFIED = "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified"; 38 39 /** URI for email name format. */ 40 public static final String EMAIL = "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress"; 41 42 /** URI for X509 subject name format. */ 43 public static final String X509_SUBJECT = "urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName"; 44 45 /** URI for windows domain qualified name name format. */ 46 public static final String WIN_DOMAIN_QUALIFIED = "urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName"; 47 48 /** URI for kerberos name format. */ 49 public static final String KERBEROS = "urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos"; 50 51 /** URI for SAML entity name format. */ 52 public static final String ENTITY = "urn:oasis:names:tc:SAML:2.0:nameid-format:entity"; 53 54 /** URI for persistent name format. */ 55 public static final String PERSISTENT = "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"; 56 57 /** URI for transient name format. */ 58 public static final String TRANSIENT = "urn:oasis:names:tc:SAML:2.0:nameid-format:transient"; 59 60 /** Special URI used by NameIDPolicy to indicate a NameID should be encrypted. */ 61 public static final String ENCRYPTED = "urn:oasis:names:tc:SAML:2.0:nameid-format:encrypted"; 62 63 /** 64 * Gets the value of this type. 65 * 66 * @return the value of this type 67 */ 68 public String getValue(); 69 70 /** 71 * Sets the value of this type. 72 * 73 * @param newValue the value of this type 74 */ 75 public void setValue(String newValue); 76 77 /** 78 * Gets the NameQualifier value. 79 * 80 * @return the NameQualifier value 81 */ 82 public String getNameQualifier(); 83 84 /** 85 * Sets the NameQualifier value. 86 * 87 * @param newNameQualifier the NameQualifier value 88 */ 89 public void setNameQualifier(String newNameQualifier); 90 91 /** 92 * Gets the SPNameQualifier value. 93 * 94 * @return the SPNameQualifier value 95 */ 96 public String getSPNameQualifier(); 97 98 /** 99 * Sets the SPNameQualifier value. 100 * 101 * @param newSPNameQualifier the SPNameQualifier value 102 */ 103 public void setSPNameQualifier(String newSPNameQualifier); 104 105 /** 106 * Gets the format of the NameID. 107 * 108 * @return the format of the NameID 109 */ 110 public String getFormat(); 111 112 /** 113 * Sets the format of the NameID. 114 * 115 * @param newFormat the format of the NameID 116 */ 117 public void setFormat(String newFormat); 118 119 /** 120 * Gets the SPProvidedID of this NameID. 121 * 122 * @return the SPProvidedID of this NameID 123 */ 124 public String getSPProvidedID(); 125 126 /** 127 * Sets the SPProvddedID of this NameID. 128 * 129 * @param newSPProvidedID the SPProvidedID of this NameID 130 */ 131 public void setSPProvidedID(String newSPProvidedID); 132 133 }