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

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

public class SPProvidedNameIdentifier

extends NameIdentifier

This class SPProvidedNameIdentifier represents the ID-FF SPProvidedNameIdentifier element.

Constructor Summary

SPProvidedNameIdentifier(org.w3c.dom.Element spProvidedNameIdentifierElement)
Constructs a SPProvidedNameIdentifier element from an existing XML block.

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

SPProvidedNameIdentifier(java.lang.String name, java.lang.String nameQualifier, java.lang.String format)
Constructs a SPProvidedNameIdentifier 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 SPProvidedNameIdentifier element.
java.lang.String	toXMLString(boolean includeNS, boolean declareNS) Gets a String representation of the SPProvidedNameIdentifier 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

SPProvidedNameIdentifier

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

Constructs a SPProvidedNameIdentifier 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.

SPProvidedNameIdentifier

public SPProvidedNameIdentifier(org.w3c.dom.Element spProvidedNameIdentifierElement)
                         throws FSMsgException

Constructs a SPProvidedNameIdentifier element from an existing XML block.

Parameters:

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

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.

SPProvidedNameIdentifier

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

Constructs a SPProvidedNameIdentifier 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 SPProvidedNameIdentifier 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 SPProvidedNameIdentifier 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