com.sun.identity.federation.message.common
Class IDPProvidedNameIdentifier

java.lang.Object
  extended by com.sun.identity.saml.assertion.NameIdentifier
      extended by com.sun.identity.federation.message.common.IDPProvidedNameIdentifier

public class IDPProvidedNameIdentifier
extends NameIdentifier

This class has methods to create the NameIdentifier object provided by the Identity Provider.


Field Summary
protected  int minorVersion
           
 
Constructor Summary
IDPProvidedNameIdentifier(Element idpProvidedNameIdentifierElement)
          Constructor creates IDPProvidedNameIdentifier object from Document Element.
IDPProvidedNameIdentifier(String securityDomain, String name)
          Constructor creates IDPProvidedNameIdentifier object.
IDPProvidedNameIdentifier(String name, String nameQualifier, String format)
          Constructor creates IDPProvidedNameIdentifier object.
 
Method Summary
 int getMinorVersion()
          Returns the MinorVersion attribute.
 void setMinorVersion(int version)
          Sets the MinorVersion attribute.
 String toXMLString()
          Returns the string representation of this object.
 String toXMLString(boolean includeNS, boolean declareNS)
          Returns the string representation of this object.
 
Methods inherited from class com.sun.identity.saml.assertion.NameIdentifier
equals, getFormat, getName, getNameQualifier, setFormat, setName, setNameQualifier, toString, toString
 

Field Detail

minorVersion

protected int minorVersion
Constructor Detail

IDPProvidedNameIdentifier

public IDPProvidedNameIdentifier(String name,
                                 String nameQualifier,
                                 String format)
                          throws SAMLException
Constructor creates IDPProvidedNameIdentifier object.

Parameters:
name - the Identity Provider name.
nameQualifier -
format -
Throws:
SAMLException - on error.

IDPProvidedNameIdentifier

public IDPProvidedNameIdentifier(Element idpProvidedNameIdentifierElement)
                          throws FSMsgException
Constructor creates IDPProvidedNameIdentifier object from Document Element.

Parameters:
idpProvidedNameIdentifierElement - the Document Element.
Throws:
FSMsgException - on error.

IDPProvidedNameIdentifier

public IDPProvidedNameIdentifier(String securityDomain,
                                 String name)
                          throws FSMsgException
Constructor creates IDPProvidedNameIdentifier object.

Parameters:
securityDomain -
name -
Throws:
FSMsgException - on error.
Method Detail

setMinorVersion

public void setMinorVersion(int version)
Sets the MinorVersion attribute.

Parameters:
version - the MinorVersion attribute.
See Also:
IDPProvidedNameIdentifier.getMinorVersion()

getMinorVersion

public int getMinorVersion()
Returns the MinorVersion attribute.

Returns:
the MinorVersion attribute.
See Also:
IDPProvidedNameIdentifier.setMinorVersion(int)

toXMLString

public String toXMLString()
                   throws FSMsgException
Returns the string representation of this object.

Returns:
a string containing the valid XML for this element
Throws:
FSMsgException - if there is an error creating XML string from this object.

toXMLString

public String toXMLString(boolean includeNS,
                          boolean declareNS)
                   throws FSMsgException
Returns the string representation of this object.

Parameters:
includeNS - 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:
a string containing the valid XML for this element
Throws:
FSMsgException - if there is an error creating XML string from this object.