com.sun.identity.liberty.ws.security
Class SessionSubject

java.lang.Object
  |
  +--com.sun.identity.saml.assertion.Subject
        |
        +--com.sun.identity.federation.message.FSSubject
              |
              +--com.sun.identity.liberty.ws.security.SessionSubject

public class SessionSubject

extends com.sun.identity.federation.message.FSSubject

The SessionSubject class represents a liberty subject with associated session status.

Constructor Summary

SessionSubject(org.w3c.dom.Element subjectElement)
Constructs a SessionSubject object from a DOM element.

SessionSubject(NameIdentifier nameIdentifier, com.sun.identity.federation.message.common.IDPProvidedNameIdentifier idpNameIdentifier)
Constructs a SessionSubject object from a NameIdentifier object and a IDPProvidedNameIdentifier object.

SessionSubject(NameIdentifier nameIdentifier, SubjectConfirmation subjectConfirmation, com.sun.identity.federation.message.common.IDPProvidedNameIdentifier idpNameIdentifier)
Constructs a SessionSubject object from a NameIdentifier object, SubjectConfirmation and IDPProvidedNameIdentifier object.

SessionSubject(SubjectConfirmation subjectConfirmation)
Constructs a SessionSubject object from a SubjectConfirmation object.

Method Summary

java.lang.String	toXMLString() Creates a String representation of the element.
java.lang.String	toXMLString(boolean includeNS, boolean declareNS) Create a String representation of the <Subject> element.

Methods inherited from class com.sun.identity.federation.message.FSSubject

getIDPProvidedNameIdentifier, setIDPProvidedNameIdentifier

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

SessionSubject

public SessionSubject(NameIdentifier nameIdentifier,
                      SubjectConfirmation subjectConfirmation,
                      com.sun.identity.federation.message.common.IDPProvidedNameIdentifier idpNameIdentifier)
               throws com.sun.identity.federation.message.common.FSMsgException,
                      SAMLException

Constructs a SessionSubject object from a NameIdentifier object, SubjectConfirmation and IDPProvidedNameIdentifier object.

Parameters:

nameIdentifier - NameIdentifier object.

subjectConfirmation - SubjectConfirmation object.

idpNameIdentifier - IDPProvidedNameIdentifier object.

Throws:

com.sun.identity.federation.message.common.FSMsgException - if idpNameIdentifier is null.

SAMLException - if both nameIdentifier and subjectConfirmation are null.

SessionSubject

public SessionSubject(NameIdentifier nameIdentifier,
                      com.sun.identity.federation.message.common.IDPProvidedNameIdentifier idpNameIdentifier)
               throws com.sun.identity.federation.message.common.FSMsgException,
                      SAMLException

Constructs a SessionSubject object from a NameIdentifier object and a IDPProvidedNameIdentifier object.

Parameters:

nameIdentifier - NameIdentifier object.

idpNameIdentifier - IDPProvidedNameIdentifier object.

Throws:

com.sun.identity.federation.message.common.FSMsgException - if idpNameIdentifier is null.

SAMLException - if nameIdentifier is null.

SessionSubject

public SessionSubject(org.w3c.dom.Element subjectElement)
               throws com.sun.identity.federation.message.common.FSMsgException,
                      SAMLException

Constructs a SessionSubject object from a DOM element. which has already been built into a DOM.

Parameters:

subjectElement - An Element representing DOM tree for Subject object

Throws:

SAMLException - if can not create the object of NameIdentifier or SubjectConfirmation inside the DOM element.

com.sun.identity.federation.message.common.FSMsgException - if it could not process the Element properly, implying that there is an error in the sender or in the element definition.

SessionSubject

public SessionSubject(SubjectConfirmation subjectConfirmation)
               throws SAMLException

Constructs a SessionSubject object from a SubjectConfirmation object.

Parameters:

subjectConfirmation - SubjectConfirmation object to be added to the object.

Throws:

SAMLException - if subjectConfirmation is null.

Method Detail

toXMLString

public java.lang.String toXMLString()
                             throws com.sun.identity.federation.message.common.FSMsgException

Creates a String representation of the element.

Overrides:

toXMLString in class com.sun.identity.federation.message.FSSubject

Returns:

a string containing the valid XML for this element By default name space name is prepended to the element name example <saml:Subject>.

Throws:

com.sun.identity.federation.message.common.FSMsgException - if could not create a String representation of this element.

toXMLString

public java.lang.String toXMLString(boolean includeNS,
                                    boolean declareNS)
                             throws com.sun.identity.federation.message.common.FSMsgException

Create a String representation of the <Subject> element.

Overrides:

toXMLString in class com.sun.identity.federation.message.FSSubject

Parameters:

includeNS - if true prepends all elements by their Namespace name example <saml:Subject>

declareNS - if true includes the namespace within the generated XML.

Returns:

a string containing the valid XML for this element.

Throws:

com.sun.identity.federation.message.common.FSMsgException - if could not create a String representation of this element.