com.sun.identity.federation.message
Class FSSubject

java.lang.Object
  com.sun.identity.saml.assertion.Subject
      com.sun.identity.federation.message.FSSubject

Direct Known Subclasses:

SessionSubject

public class FSSubject

extends Subject

This class FSSubject is used to construct/parse an ID-FF Subject element.

Constructor Summary

FSSubject(org.w3c.dom.Element subjectElement)
Constructor

FSSubject(NameIdentifier nameIdentifier, IDPProvidedNameIdentifier idpNameIdentifier)
Constructor

FSSubject(NameIdentifier nameIdentifier, SubjectConfirmation subjectConfirmation, IDPProvidedNameIdentifier idpNameIdentifier)
Constructor

FSSubject(SubjectConfirmation subjectConfirmation)
Constructor

Method Summary

IDPProvidedNameIdentifier	getIDPProvidedNameIdentifier() Gets IDP provided name identifier
boolean	setIDPProvidedNameIdentifier(IDPProvidedNameIdentifier idpNameIdentifier) Sets IDP provided name identifier.
java.lang.String	toXMLString() Gets a String representation of the object.
java.lang.String	toXMLString(boolean includeNS, boolean declareNS) Gets a String representation of the object.

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

equals, getNameIdentifier, getSubjectConfirmation, removeNameIdentifier, removeSubjectConfirmation, setNameIdentifier, setSubjectConfirmation, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FSSubject

public FSSubject(NameIdentifier nameIdentifier,
                 SubjectConfirmation subjectConfirmation,
                 IDPProvidedNameIdentifier idpNameIdentifier)
          throws FSMsgException,
                 SAMLException

Constructor

Parameters:

nameIdentifier - name identifier for the subject

subjectConfirmation - subject confirmation object

idpNameIdentifier - IDP provider name identifier.

Throws:

SAMLException - if unable to construct the object

FSMsgException - if unable to construct the object

FSSubject

public FSSubject(NameIdentifier nameIdentifier,
                 IDPProvidedNameIdentifier idpNameIdentifier)
          throws FSMsgException,
                 SAMLException

Constructor

Parameters:

nameIdentifier - name identifier for the subject

idpNameIdentifier - IDP provider name identifier.

Throws:

SAMLException - if unable to construct the object

FSMsgException - if unable to construct the object

FSSubject

public FSSubject(org.w3c.dom.Element subjectElement)
          throws FSMsgException,
                 SAMLException

Constructor

Parameters:

subjectElement - DOM Element representing the Subject.

Throws:

SAMLException - if unable to construct the object

FSMsgException - if unable to construct the object

FSSubject

public FSSubject(SubjectConfirmation subjectConfirmation)
          throws SAMLException

Constructor

Parameters:

subjectConfirmation - subject confirmation object

Throws:

SAMLException - if unable to construct the object

Method Detail

setIDPProvidedNameIdentifier

public boolean setIDPProvidedNameIdentifier(IDPProvidedNameIdentifier idpNameIdentifier)

Sets IDP provided name identifier.

Parameters:

idpNameIdentifier - IDP provided name identifier to be set.

Returns:

true if successful, false otherwise.

getIDPProvidedNameIdentifier

public IDPProvidedNameIdentifier getIDPProvidedNameIdentifier()

Gets IDP provided name identifier

Returns:

IDP provided name identifier

toXMLString

public java.lang.String toXMLString()
                             throws FSMsgException

Gets a String representation of the object.

Returns:

A string containing the valid XML for this element

Throws:

FSMsgException - if error occurs.

toXMLString

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

Gets a String representation of the 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 error occurs.