com.sun.identity.saml.assertion
Class Evidence

java.lang.Object
  extended bycom.sun.identity.saml.assertion.Evidence

public class Evidence
extends java.lang.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


Constructor Summary
Evidence(org.w3c.dom.Element assertionSpecifierElement)
          Constructs an Evidence object from a block of existing XML that has already been built into a DOM.
Evidence(java.util.Set evidenceContent)
          Constructs a new Evidence> element containing a set of Assertion objects.
Evidence(java.util.Set assertionIDRef, java.util.Set assertion)
          Constructs an Evidence from a Set of Assertion and AssertionIDReference objects.
 
Method Summary
 boolean addAssertion(Assertion assertion)
          Adds an Assertion object into the Evidence object.
 boolean addAssertionIDReference(AssertionIDReference assertionIDRef)
          Adds an AssertionIDReference object into the Evidence object.
 java.util.Set getAssertion()
          Get java.util.Set of Assertion objects in the Evidence
 java.util.Set getAssertionIDReference()
          Get java.util.Set of AssertionIDReference objects in the Evidence
 boolean removeAssertion(Assertion assertion)
          Removes an Assertion object from the Evidence object.
 boolean removeAssertionIDReference(AssertionIDReference assertionIDRef)
          Removes an AssertionIDReference object from the Evidence object.
 java.lang.String toString()
          Returns a String representation of the element.
 java.lang.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
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Evidence

public Evidence(org.w3c.dom.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.

Evidence

public Evidence(java.util.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.

Evidence

public Evidence(java.util.Set assertionIDRef,
                java.util.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(Assertion 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(Assertion 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 java.util.Set getAssertionIDReference()
Get java.util.Set of AssertionIDReference objects in the Evidence

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

getAssertion

public java.util.Set getAssertion()
Get java.util.Set of Assertion objects in the Evidence

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

toString

public java.lang.String toString()
Returns a String representation of the element.

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 java.lang.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.


Copyright 2005 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.