a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The contents of this file are subject to the terms
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * of the Common Development and Distribution License
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * (the License). You may not use this file except in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * compliance with the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * You can obtain a copy of the License at
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * permission and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Header Notice in each file and include the License file
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * If applicable, add the following below the CDDL Header,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * with the fields enclosed by brackets [] replaced by
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * your own identifying information:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * $Id: EvidenceBase.java,v 1.2 2008/06/25 05:47:32 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLUtilsCommon;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLConstants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLRequesterException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *The <code>Evidence</code> element specifies an assertion either by
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *reference or by value. An assertion is specified by reference to the value of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *the assertion's <code>AssertionIDReference</code> element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *An assertion is specified by value by including the entire
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *<code>Assertion</code> object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This class is an abstract base class for all Evidence implementations and
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * encapsulates common functionality.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *@supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructs an <code>Evidence</code> object from a block of existing XML
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * that has already been built into a DOM.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param assertionSpecifierElement A <code>org.w3c.dom.Element</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * representing DOM tree for <code>Evidence</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception SAMLException if it could not process the Element properly,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * implying that there is an error in the sender or in the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * element definition.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public EvidenceBase(org.w3c.dom.Element assertionSpecifierElement)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String elementName = assertionSpecifierElement.getLocalName();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster SAMLUtilsCommon.debug.message("Evidence:local name "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "missing");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new SAMLRequesterException(SAMLUtilsCommon.bundle.getString
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster ("nullInput")) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "Evidence: invalid root element");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new SAMLRequesterException(SAMLUtilsCommon.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster NodeList nl = assertionSpecifierElement.getChildNodes();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster +"no sub elements found in this Element");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new SAMLRequesterException(SAMLUtilsCommon.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "noElement")) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (child.getNodeType() != Node.ELEMENT_NODE) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster _assertion.add(createAssertion((Element)child));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster } else if (childName.equals("AssertionIDReference")) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster _assertionIDRef.add(createAssertionIDReference(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "invalid sub element");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster SAMLUtilsCommon.bundle.getString("invalidElement")) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructs a new <code>Evidence></code> element containing a
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * set of <code>Assertion</code> objects.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param evidenceContent A set of <code>Assertion</code> and
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>AssertionIDReference</code> objects to be put within the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>Evidence</code> element. The same Set contains both type
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * of elements.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception SAMLException if the Set is empty or has invalid object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public EvidenceBase(Set evidenceContent) throws SAMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster SAMLUtilsCommon.debug.message("Evidence: null input "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "specified");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new SAMLRequesterException(SAMLUtilsCommon.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "nullInput")) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster } else if (obj instanceof AssertionIDReference) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster _assertionIDRef.add((AssertionIDReference)obj);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "Evidence: Invalid input Element");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster SAMLUtilsCommon.bundle.getString("invalidElement")) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructs an Evidence from a Set of <code>Assertion</code> and
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>AssertionIDReference</code> objects.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param assertionIDRef Set of <code>AssertionIDReference</code> objects.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param assertion Set of <code>Assertion</code> objects.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception SAMLException if either Set is empty or has invalid object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public EvidenceBase(Set assertionIDRef, Set assertion)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (assertionIDRef.isEmpty() && assertion.isEmpty()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster SAMLUtilsCommon.debug.message("Evidence: null input "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "specified");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new SAMLRequesterException(SAMLUtilsCommon.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "nullInput")) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster _assertionIDRef.add((AssertionIDReference)assID);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "Evidence: Invalid input Element");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster SAMLUtilsCommon.bundle.getString("invalidElement")) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "Evidence: Invalid input Element");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster SAMLUtilsCommon.bundle.getString("invalidElement")) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Adds an <code>Assertion</code> object into the Evidence object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param assertion <code>Assertion</code> to be added
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return true if operation succeeds.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public boolean addAssertion(AssertionBase assertion) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster SAMLUtilsCommon.debug.message("Evidence: null input "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "specified");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return false;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Adds an <code>AssertionIDReference</code> object into the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>Evidence</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param assertionIDRef <code>AssertionIDReference</code> to be added.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return true if operation succeeds.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public boolean addAssertionIDReference(AssertionIDReference assertionIDRef)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster SAMLUtilsCommon.debug.message("Evidence: null input "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "specified");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return false;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Removes an <code>Assertion</code> object from the <code>Evidence</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param assertion <code>Assertion</code> to be removed.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return true if the operation succeeds, Returns failure of the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>Assertion</code> is the only element inside the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>Evidence</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public boolean removeAssertion(AssertionBase assertion)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (_assertionIDRef.size() + _assertion.size() > 1 ) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster SAMLUtilsCommon.debug.message("Evidence: null input "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "specified");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return false;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Removes an <code>AssertionIDReference</code> object from the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>Evidence</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param assertionIDRef <code>AssertionIDReference</code> to be removed
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return true if the operation succeeds, Returns false if the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>AssertionIDReference</code> is the only element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * inside the <code>Evidence</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public boolean removeAssertionIDReference(AssertionIDReference
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (_assertionIDRef.size() + _assertion.size() > 1 ) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster SAMLUtilsCommon.debug.message("Evidence: null input "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "specified");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return false;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *Get <code>java.util.Set</code> of <code>AssertionIDReference</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *objects in the <code>Evidence</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *@return <code>java.util.Set</code> of <code>AssertionIDReference</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *objects within this Evidence.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *Get <code>java.util.Set</code> of <code>Assertion</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *objects in the <code>Evidence</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *@return <code>java.util.Set</code> of <code>Assertion</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *objects within this Evidence.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a String representation of the element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return A string containing the valid XML for this element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * By default name space name is prepended to the element name
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * example <code><saml:Evidence></code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster // call toString() with includeNS true by default and declareNS false
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a String representation of the <code><Evidence></code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * element (or of the <code><Evidence></code> element).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param includeNS Determines whether or not the namespace qualifier is
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * prepended to the <code>Element</code> when converted.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param declareNS Determines whether or not the namespace is declared
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * within the Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return The string containing the valid XML for this element .The top
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * level element is <code>Evidence</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public java.lang.String toString(boolean includeNS, boolean declareNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster o = SAMLUtilsCommon.makeStartElementTagXML("Evidence",
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster AssertionBase assertion = (AssertionBase)it.next();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster xml.append(assertion.toString(includeNS, false));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster AssertionIDReference aidRef = (AssertionIDReference)it.next();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster o = SAMLUtilsCommon.makeEndElementTagXML("Evidence",includeNS);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Creates appropriate Assertion Instance
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param assertionElement the assertion Element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the assertion instance
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster protected abstract AssertionBase
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Creates appropriate AssertionIDReference Instance
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param assertionID the assertion ID String
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the AssertionIDReference instance
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster protected abstract AssertionIDReference