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 has methods to create Subject object.

Field Summary

protected IDPProvidedNameIdentifier

_idpNameIdentifier

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

_nameIdentifier, _subjectConfirmation

Constructor Summary

protected	FSSubject() Default Constructor.
	FSSubject(Element subjectElement) Constructor creates FSSubject object from the Document Element.
	FSSubject(NameIdentifier nameIdentifier, IDPProvidedNameIdentifier idpNameIdentifier) Constructor creates FSSubject object.
	FSSubject(NameIdentifier nameIdentifier, SubjectConfirmation subjectConfirmation, IDPProvidedNameIdentifier idpNameIdentifier) Constructor creates FSSubject object.
	FSSubject(SubjectConfirmation subjectConfirmation) Constructor creates FSSubject object.

Method Summary

IDPProvidedNameIdentifier	getIDPProvidedNameIdentifier() Returns the Identity Provider's NameIdentifier.
boolean	setIDPProvidedNameIdentifier(IDPProvidedNameIdentifier idpNameIdentifier) Sets the Identity Provider's NameIdentifier.
String	toXMLString() Returns a String representation of this object.
String	toXMLString(boolean includeNS, boolean declareNS) Returns a String representation of the Logout Response.

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

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

Field Detail

_idpNameIdentifier

protected IDPProvidedNameIdentifier _idpNameIdentifier

Constructor Detail

FSSubject

protected FSSubject()

Default Constructor.

FSSubject

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

Constructor creates FSSubject object.

Parameters:

nameIdentifier - the NameIdentifier of the subject.

subjectConfirmation - the SubjectConfirmation object.

idpNameIdentifier - the IDPProvidedNameIdentifier object.

Throws:

FSMsgException - if there is an error creating this object.

SAMLException - if there is an error creating this object.

FSSubject

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

Constructor creates FSSubject object.

Parameters:

nameIdentifier - the NameIdentifier of the subject.

idpNameIdentifier - the IDPProvidedNameIdentifier object.

Throws:

FSMsgException - if there is an error creating this object.

SAMLException - if there is an error creating this object.

FSSubject

public FSSubject(Element subjectElement)
          throws FSMsgException,
                 SAMLException

Constructor creates FSSubject object from the Document Element.

Parameters:

subjectElement - the Document Element

Throws:

FSMsgException - if there is an error creating this object.

SAMLException - if there is an error creating this object.

FSSubject

public FSSubject(SubjectConfirmation subjectConfirmation)
          throws SAMLException

Constructor creates FSSubject object.

Parameters:

subjectConfirmation - the SubjectConfirmation object.

Throws:

SAMLException - if there is an error creating this object.

Method Detail

setIDPProvidedNameIdentifier

public boolean setIDPProvidedNameIdentifier(IDPProvidedNameIdentifier idpNameIdentifier)

Sets the Identity Provider's NameIdentifier.

Parameters:

idpNameIdentifier - the Identity Provider's NameIdentifier.

getIDPProvidedNameIdentifier

public IDPProvidedNameIdentifier getIDPProvidedNameIdentifier()

Returns the Identity Provider's NameIdentifier.

Returns:

the Identity Provider's NameIdentifier.

toXMLString

public String toXMLString()
                   throws FSMsgException

Returns a String representation of this object.

Returns:

a string containing the valid XML for this element

Throws:

FSMsgException - if there is an error converting this object ot a string.

toXMLString

public String toXMLString(boolean includeNS,
                          boolean declareNS)
                   throws FSMsgException

Returns a String representation of the Logout Response.

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 converting this object ot a string.