Package com.sun.identity.saml2.protocol
Interface NameIDPolicy
-
@SupportedAll public interface NameIDPolicy
This interface defines methods to retrieve name identifier related properties.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getFormat()
Returns the value ofFormat
attribute.String
getSPNameQualifier()
Returns the value of theSPNameQualifier
attribute.boolean
isAllowCreate()
Returns true if the identity provider is allowed to create a new identifier to represent the principal.boolean
isMutable()
Returns true if object is mutable.void
makeImmutable()
Makes this object immutable.void
setAllowCreate(boolean allowCreate)
Sets the value ofAllowCreate
attribute.void
setFormat(String uri)
Sets the value of theFormat
attribute.void
setSPNameQualifier(String spNameQualifier)
Sets the value ofSPNameQualifier
attribute.String
toXMLString()
Returns a String representation of this Object.String
toXMLString(boolean includeNSPrefix, boolean declareNS)
Returns a String representation of this object.
-
-
-
Method Detail
-
getFormat
String getFormat()
Returns the value ofFormat
attribute.- Returns:
- the value of
Format
attribute. - See Also:
setFormat(String)
-
setFormat
void setFormat(String uri) throws SAML2Exception
Sets the value of theFormat
attribute.- Parameters:
uri
- the new value ofFormat
attribute.- Throws:
SAML2Exception
- if the object is immutable.- See Also:
getFormat()
-
getSPNameQualifier
String getSPNameQualifier()
Returns the value of theSPNameQualifier
attribute.- Returns:
- the value of
SPNameQualifier
attribute. - See Also:
setSPNameQualifier(String)
-
setSPNameQualifier
void setSPNameQualifier(String spNameQualifier) throws SAML2Exception
Sets the value ofSPNameQualifier
attribute.- Parameters:
spNameQualifier
- new value ofSPNameQualifier
attribute.- Throws:
SAML2Exception
- if the object is immutable.- See Also:
getSPNameQualifier()
-
setAllowCreate
void setAllowCreate(boolean allowCreate) throws SAML2Exception
Sets the value ofAllowCreate
attribute.- Parameters:
allowCreate
- the new value ofAllowCreate
attribute.- Throws:
SAML2Exception
- if the object is immutable.
-
isAllowCreate
boolean isAllowCreate()
Returns true if the identity provider is allowed to create a new identifier to represent the principal.- Returns:
- value of
AllowCreate
attribute.
-
toXMLString
String toXMLString() throws SAML2Exception
Returns a String representation of this Object.- Returns:
- String representation of this Object.
- Throws:
SAML2Exception
- if cannot create String object.
-
toXMLString
String toXMLString(boolean includeNSPrefix, boolean declareNS) throws SAML2Exception
Returns a String representation of this object.- Parameters:
includeNSPrefix
- determines whether or not the namespace qualifier is prepended to the Element when converteddeclareNS
- determines whether or not the namespace is declared within the Element.- Returns:
- String representation of this Object.
- Throws:
SAML2Exception
- if cannot create String object.
-
makeImmutable
void makeImmutable()
Makes this object immutable.
-
isMutable
boolean isMutable()
Returns true if object is mutable.- Returns:
- true if object is mutable.
-
-