com.sun.identity.saml.assertion

Class EvidenceBase

java.lang.Object

com.sun.identity.saml.assertion.EvidenceBase

Direct Known Subclasses:

Evidence

public abstract class EvidenceBase
extends Object

The Evidence element specifies an assertion either by reference or by value. An assertion is specified by reference to the value of the assertion's AssertionIDReference element. An assertion is specified by value by including the entire Assertion object This class is an abstract base class for all Evidence implementations and encapsulates common functionality.

Constructor Summary

Constructors

Constructor and Description
EvidenceBase(Element assertionSpecifierElement) Constructs an Evidence object from a block of existing XML that has already been built into a DOM.
EvidenceBase(Set evidenceContent) Constructs a new Evidence element containing a set of Assertion objects.
EvidenceBase(Set assertionIDRef, Set assertion) Constructs an Evidence from a Set of Assertion and AssertionIDReference objects.

Method Summary

Modifier and Type	Method and Description
boolean	addAssertion(AssertionBase assertion) Adds an Assertion object into the Evidence object.
boolean	addAssertionIDReference(AssertionIDReference assertionIDRef) Adds an AssertionIDReference object into the Evidence object.
protected abstract AssertionBase	createAssertion(Element assertionElement) Creates appropriate Assertion Instance
protected abstract AssertionIDReference	createAssertionIDReference(String assertionID) Creates appropriate AssertionIDReference Instance
Set	getAssertion() Get java.util.Set of Assertion objects in the Evidence
Set	getAssertionIDReference() Get java.util.Set of AssertionIDReference objects in the Evidence
boolean	removeAssertion(AssertionBase assertion) Removes an Assertion object from the Evidence object.
boolean	removeAssertionIDReference(AssertionIDReference assertionIDRef) Removes an AssertionIDReference object from the Evidence object.
String	toString() Returns a String representation of the element.
String	toString(boolean includeNS, boolean declareNS) Returns a String representation of the <Evidence> element (or of the <Evidence> element).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EvidenceBase

public EvidenceBase(Element assertionSpecifierElement)
             throws SAMLException

Constructs an Evidence object from a block of existing XML that has already been built into a DOM.

Parameters:

assertionSpecifierElement - A org.w3c.dom.Element representing DOM tree for Evidence 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.

EvidenceBase

public EvidenceBase(Set evidenceContent)
             throws SAMLException

Constructs a new Evidence element containing a set of Assertion objects.

Parameters:

evidenceContent - A set of Assertion and AssertionIDReference objects to be put within the Evidence element. The same Set contains both type of elements.

Throws:

SAMLException - if the Set is empty or has invalid object.

EvidenceBase

public EvidenceBase(Set assertionIDRef,
                    Set assertion)
             throws SAMLException

Constructs an Evidence from a Set of Assertion and AssertionIDReference objects.

Parameters:

assertionIDRef - Set of AssertionIDReference objects.

assertion - Set of Assertion objects.

Throws:

SAMLException - if either Set is empty or has invalid object.

Method Detail

addAssertion

public boolean addAssertion(AssertionBase assertion)

Adds an Assertion object into the Evidence object.

Parameters:

assertion - Assertion to be added

Returns:

true if operation succeeds.

addAssertionIDReference

public boolean addAssertionIDReference(AssertionIDReference assertionIDRef)

Adds an AssertionIDReference object into the Evidence object.

Parameters:

assertionIDRef - AssertionIDReference to be added.

Returns:

true if operation succeeds.

removeAssertion

public boolean removeAssertion(AssertionBase assertion)

Removes an Assertion object from the Evidence object.

Parameters:

assertion - Assertion to be removed.

Returns:

true if the operation succeeds, Returns failure of the Assertion is the only element inside the Evidence.

removeAssertionIDReference

public boolean removeAssertionIDReference(AssertionIDReference assertionIDRef)

Removes an AssertionIDReference object from the Evidence object.

Parameters:

assertionIDRef - AssertionIDReference to be removed

Returns:

true if the operation succeeds, Returns false if the AssertionIDReference is the only element inside the Evidence.

getAssertionIDReference

public Set getAssertionIDReference()

Get java.util.Set of AssertionIDReference objects in the Evidence

Returns:

java.util.Set of AssertionIDReference objects within this Evidence.

getAssertion

public Set getAssertion()

Get java.util.Set of Assertion objects in the Evidence

Returns:

java.util.Set of Assertion objects within this Evidence.

toString

public String toString()

Returns a String representation of the element.

Overrides:

toString in class Object

Returns:

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

toString

public String toString(boolean includeNS,
                       boolean declareNS)

Returns a String representation of the <Evidence> element (or of the <Evidence> 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:

The string containing the valid XML for this element .The top level element is Evidence.

createAssertion

protected abstract AssertionBase createAssertion(Element assertionElement)
                                          throws SAMLException

Creates appropriate Assertion Instance

Parameters:

assertionElement - the assertion Element

Returns:

the assertion instance

Throws:

SAMLException

createAssertionIDReference

protected abstract AssertionIDReference createAssertionIDReference(String assertionID)
                                                            throws SAMLException

Creates appropriate AssertionIDReference Instance

Parameters:

assertionID - the assertion ID String

Returns:

the AssertionIDReference instance

Throws:

SAMLException