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

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

public class IDPProvidedNameIdentifier

extends NameIdentifier

This class IDPProvidedNameIdentifier represents the ID-FF IDPProvidedNameIdentifier element.

Constructor Summary

IDPProvidedNameIdentifier(org.w3c.dom.Element idpProvidedNameIdentifierElement)
Constructs a IDPProvidedNameIdentifier element from an existing XML block.

IDPProvidedNameIdentifier(java.lang.String securityDomain, java.lang.String name)
Constructs a IDPProvidedNameIdentifier instance.

IDPProvidedNameIdentifier(java.lang.String name, java.lang.String nameQualifier, java.lang.String format)
Constructs a IDPProvidedNameIdentifier instance.

Method Summary

int	getMinorVersion() Gets minor version
void	setMinorVersion(int version) Sets minor version
java.lang.String	toXMLString() Gets a String representation of the IDPProvidedNameIdentifier element.
java.lang.String	toXMLString(boolean includeNS, boolean declareNS) Gets a String representation of the IDPProvidedNameIdentifier element.

Methods inherited from class com.sun.identity.saml.assertion.NameIdentifier

equals, getFormat, getName, getNameQualifier, setFormat, setNameQualifier, toString, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IDPProvidedNameIdentifier

public IDPProvidedNameIdentifier(java.lang.String name,
                                 java.lang.String nameQualifier,
                                 java.lang.String format)
                          throws SAMLException

Constructs a IDPProvidedNameIdentifier instance.

Parameters:

name - The string representing the name of the Subject

nameQualifier - The security or administrative domain that qualifies the name of the Subject. This is optional could be null or "".

format - The syntax used to describe the name of the Subject. This optional, could be null or "".

Throws:

SAMLException - if the input has an error.

IDPProvidedNameIdentifier

public IDPProvidedNameIdentifier(org.w3c.dom.Element idpProvidedNameIdentifierElement)
                          throws FSMsgException

Constructs a IDPProvidedNameIdentifier element from an existing XML block.

Parameters:

idpProvidedNameIdentifierElement - A org.w3c.dom.Element representing DOM tree for IDPProvidedNameIdentifier

Throws:

FSMsgException - if it could not process the org.w3c.dom.Element properly, implying that there is an error in the sender or in the element definition.

IDPProvidedNameIdentifier

public IDPProvidedNameIdentifier(java.lang.String securityDomain,
                                 java.lang.String name)
                          throws FSMsgException

Constructs a IDPProvidedNameIdentifier instance.

Parameters:

securityDomain - The security or administrative domain that qualifies the name of the Subject. This is optional, could be null or "".

name - The string representing the name of the Subject

Throws:

FSMsgException - if the input has an error.

Method Detail

setMinorVersion

public void setMinorVersion(int version)

Sets minor version

Parameters:

version - minor version to be set

getMinorVersion

public int getMinorVersion()

Gets minor version

Returns:

minor version

toXMLString

public java.lang.String toXMLString()
                             throws FSMsgException

Gets a String representation of the IDPProvidedNameIdentifier element.

Returns:

A string containing the valid XML for this element

Throws:

FSMsgException - if unable to get the XML string

toXMLString

public java.lang.String toXMLString(boolean includeNS,
                                    boolean declareNS)
                             throws FSMsgException

Gets a String representation of the IDPProvidedNameIdentifier element.

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 unable to get the XML string