Package com.sun.identity.saml2.protocol.impl

Class NameIDPolicyImpl

java.lang.Object

com.sun.identity.saml2.protocol.impl.NameIDPolicyImpl

All Implemented Interfaces:

NameIDPolicy

public class NameIDPolicyImpl
extends Object
implements NameIDPolicy

This interface defines methods to retrieve name identifier related properties.

Constructor Summary

Constructors

Constructor	Description
NameIDPolicyImpl()	Constructor creates NameIDPolicy object.
NameIDPolicyImpl(String xmlString)	Returns the NameIDPolicy Object.
NameIDPolicyImpl(Element element)	Constructor creates NameIDPolicy object.

Method Summary

Modifier and Type	Method	Description
String	getFormat()	Returns the value of Format attribute.
String	getSPNameQualifier()	Returns the value of the SPNameQualifier 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 value)	Sets the value of AllowCreate attribute.
void	setFormat(String uri)	Sets the value of the Format attribute.
void	setSPNameQualifier(String spNameQualifier)	Sets the value of SPNameQualifier attribute.
String	toXMLString()	Returns a String representation of this Object.
String	toXMLString(boolean includeNSPrefix, boolean declareNS)	Returns a String representation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NameIDPolicyImpl

public NameIDPolicyImpl()

Constructor creates NameIDPolicy object.

NameIDPolicyImpl

public NameIDPolicyImpl(Element element)
                 throws SAML2Exception

Constructor creates NameIDPolicy object.

Parameters:

element - Document Element of NameIDPolicy Object.

Throws:

SAML2Exception - if NameIDPolicy cannot be created.

NameIDPolicyImpl

public NameIDPolicyImpl(String xmlString)
                 throws SAML2Exception

Returns the NameIDPolicy Object.

Parameters:

xmlString - XML String Representation of NameIDPolicy object.

Throws:

SAML2Exception - if NameIDPolicy cannot be created.

Method Detail

getFormat

public String getFormat()

Returns the value of Format attribute.

Specified by:

getFormat in interface NameIDPolicy

Returns:

the value of Format attribute.

See Also:

setFormat(String)

setFormat

public void setFormat(String uri)
               throws SAML2Exception

Sets the value of the Format attribute.

Specified by:

setFormat in interface NameIDPolicy

Parameters:

uri - the new value of Format attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

setFormat(String)

getSPNameQualifier

public String getSPNameQualifier()

Returns the value of the SPNameQualifier attribute.

Specified by:

getSPNameQualifier in interface NameIDPolicy

Returns:

the value of SPNameQualifier attribute.

See Also:

NameIDPolicy.setSPNameQualifier(String)

setSPNameQualifier

public void setSPNameQualifier(String spNameQualifier)
                        throws SAML2Exception

Sets the value of SPNameQualifier attribute.

Specified by:

setSPNameQualifier in interface NameIDPolicy

Parameters:

spNameQualifier - new value of SPNameQualifier attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

NameIDPolicy.getSPNameQualifier()

setAllowCreate

public void setAllowCreate(boolean value)
                    throws SAML2Exception

Sets the value of AllowCreate attribute.

Specified by:

setAllowCreate in interface NameIDPolicy

Parameters:

value - e the new value of AllowCreate attribute.

Throws:

SAML2Exception - if the object is immutable.

isAllowCreate

public boolean isAllowCreate()

Returns true if the identity provider is allowed to create a new identifier to represent the principal.

Specified by:

isAllowCreate in interface NameIDPolicy

Returns:

value of AllowCreate attribute.

toXMLString

public String toXMLString()
                   throws SAML2Exception

Returns a String representation of this Object.

Specified by:

toXMLString in interface NameIDPolicy

Returns:

String representation of this Object.

Throws:

SAML2Exception - if cannot create String object.

toXMLString

public String toXMLString(boolean includeNSPrefix,
                          boolean declareNS)
                   throws SAML2Exception

Returns a String representation

Specified by:

toXMLString in interface NameIDPolicy

Parameters:

includeNSPrefix - determines whether or not the namespace qualifier is prepended to the Element when converted

declareNS - 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

public void makeImmutable()

Makes this object immutable.

Specified by:

makeImmutable in interface NameIDPolicy

isMutable

public boolean isMutable()

Returns true if object is mutable.

Specified by:

isMutable in interface NameIDPolicy

Returns:

true if object is mutable.