Package com.sun.identity.saml2.assertion
Interface NameIDType
-
- All Superinterfaces:
XmlSerializable
@SupportedAll public interface NameIDType extends XmlSerializable
TheNameIDTypeis used when an element serves to represent an entity by a string-valued name. In addition to the string content containing the actual identifier, it provides the following optional attributes:NameQualifierSPNameQualifierFormatSPProvidedID
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetFormat()Returns the formatStringgetNameQualifier()Returns the name qualifierStringgetSPNameQualifier()Returns theSPname qualifierStringgetSPProvidedID()Returns theSPprovided IDStringgetValue()Returns the string-valued identifierbooleanisMutable()Returns true if the object is mutablevoidmakeImmutable()Makes the object immutablevoidsetFormat(String value)Sets the formatvoidsetNameQualifier(String value)Sets the name qualifiervoidsetSPNameQualifier(String value)Sets theSPname qualifiervoidsetSPProvidedID(String value)Sets theSPprovided IDvoidsetValue(String value)Sets the string-valued identifier-
Methods inherited from interface com.sun.identity.saml2.common.XmlSerializable
toDocumentFragment, toXMLString, toXMLString
-
-
-
-
Method Detail
-
getValue
String getValue()
Returns the string-valued identifier- Returns:
- the string-valued identifier
-
setValue
void setValue(String value) throws SAML2Exception
Sets the string-valued identifier- Parameters:
value- the string-valued identifier- Throws:
SAML2Exception- if the object is immutable
-
getNameQualifier
String getNameQualifier()
Returns the name qualifier- Returns:
- the name qualifier
-
setNameQualifier
void setNameQualifier(String value) throws SAML2Exception
Sets the name qualifier- Parameters:
value- the name qualifier- Throws:
SAML2Exception- if the object is immutable
-
getSPProvidedID
String getSPProvidedID()
Returns theSPprovided ID- Returns:
- the
SPprovided ID
-
setSPProvidedID
void setSPProvidedID(String value) throws SAML2Exception
Sets theSPprovided ID- Parameters:
value- theSPprovided ID- Throws:
SAML2Exception- if the object is immutable
-
getSPNameQualifier
String getSPNameQualifier()
Returns theSPname qualifier- Returns:
- the
SPname qualifier
-
setSPNameQualifier
void setSPNameQualifier(String value) throws SAML2Exception
Sets theSPname qualifier- Parameters:
value- theSPname qualifier- Throws:
SAML2Exception- if the object is immutable
-
getFormat
String getFormat()
Returns the format- Returns:
- the format
-
setFormat
void setFormat(String value) throws SAML2Exception
Sets the format- Parameters:
value- the format- Throws:
SAML2Exception- if the object is immutable
-
makeImmutable
void makeImmutable()
Makes the object immutable
-
isMutable
boolean isMutable()
Returns true if the object is mutable- Returns:
- true if the object is mutable
-
-