element SHOULD NOT identify more than one
principal.
|
Constructor Summary |
Subject(org.w3c.dom.Element subjectElement)
This constructor builds a subject element from an existing XML block
which has already been built into a DOM. |
Subject(NameIdentifier nameIdentifier)
This constructor creates a Subject object from a
NameIdentifier object. |
Subject(NameIdentifier nameIdentifier,
SubjectConfirmation subjectConfirmation)
This constructor creates a Subject object from a NameIdentifier
object and a SubjectConfirmation object. |
Subject(SubjectConfirmation subjectConfirmation)
This constructor creates a Subject object from a
SubjectConfirmation object. |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Subject
public Subject(NameIdentifier nameIdentifier,
SubjectConfirmation subjectConfirmation)
throws SAMLException
- This constructor creates a Subject object from a
NameIdentifier
object and a SubjectConfirmation object.
- Parameters:
nameIdentifier: - NameIdentifier object.subjectConfirmation: - SubjectConfirmation object.- Throws:
throws - SAMLException if it could not process the
Element properly, implying that there is an error in the sender or in the
element definition.
Subject
public Subject(NameIdentifier nameIdentifier)
throws SAMLException
- This constructor creates a Subject object from a
NameIdentifier object.
- Parameters:
nameIdentifier: - NameIdentifier object.- Throws:
throws - SAMLException if it could not process the
Element properly, implying that there is an error in the sender or in the
element definition.
Subject
public Subject(org.w3c.dom.Element subjectElement)
throws SAMLException
- This constructor builds a subject element from an existing XML block
which has already been built into a DOM.
- Parameters:
subjectElement: - An Element representing DOM tree for Subject object- Throws:
SAMLException - if it could not process the
Element properly, implying that there is an error in the sender or in the
element definition.
Subject
public Subject(SubjectConfirmation subjectConfirmation)
throws SAMLException
- This constructor creates a Subject object from a
SubjectConfirmation object.
- Parameters:
subjectConfirmation: - SubjectConfirmation object to be
added to the object.- Throws:
SAMLException - if subjectConfirmation is null.
equals
public boolean equals(Subject subject)
- Checks for equality between this object and the Subject
passed down as paramater. If
NameIdentifier is present,
checks for its equality by calling Nameidentifier.equals().
if SubjectConfirmation is present calls
equals() method of SubjectConfirmation too
passing in the subject's SubjectConfirmation element.
- Parameters:
Subject - to be checked.- Returns:
- true if this object and
subject are equals.
setSubjectConfirmation
public boolean setSubjectConfirmation(SubjectConfirmation subjectConfirmation)
- Set the subject confirmation to the subject
- Parameters:
subjectConfirmation: - SubjectConfirmation to be set.
return boolean indicating success or failure of the operation.
removeSubjectConfirmation
public boolean removeSubjectConfirmation()
- Remove subject confirmation from the subject
return boolean indicating success or failure of the operation.
setNameIdentifier
public boolean setNameIdentifier(NameIdentifier nameIdentifier)
- Set the NameIdentifier to the subject
- Parameters:
nameIdentifier: - NameIdentifier to be set.
return boolean indicating success or failure of the operation.
removeNameIdentifier
public boolean removeNameIdentifier()
- Remove NameIdentifier from the subject
return boolean indicating success or failure of the operation.
getNameIdentifier
public NameIdentifier getNameIdentifier()
- Get the
NameIdentifier within the Subject element
- Returns:
NameIdentifier object, within this Subject.
getSubjectConfirmation
public SubjectConfirmation getSubjectConfirmation()
- Get the
SubjectConfirmation within the Subject element
- Returns:
SubjectConfirmation object, within this Subject if
exists else null
toString
public java.lang.String toString()
- Create a String representation of the element
- Overrides:
toString in class java.lang.Object
- Returns:
- A string containing the valid XML for this element
By default name space name is prepended to the element name
eg <saml:Subject>
toString
public java.lang.String toString(boolean includeNS,
boolean declareNS)
- Create a String representation of the <Subject> element
- Parameters:
boolean - includeNS if true prepends all elements by their Namspace
name eg boolean - declareNS if true includes the namespace within the
generated XML.- Returns:
- A string containing the valid XML for this element