saml/assertion/AdviceBase.java

a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
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 *
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 * opensso/legal/CDDLv1.0.txt
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * permission and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Header Notice in each file and include the License file
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * at opensso/legal/CDDLv1.0.txt.
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 *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * $Id: AdviceBase.java,v 1.2 2008/06/25 05:47:31 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpackage com.sun.identity.saml.assertion;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.*;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.*;
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 Fosterimport com.sun.identity.shared.xml.XMLUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *The <code>Advice</code> element contains additional information
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *that the issuer wish to provide.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *This information MAY be ignored by applications without affecting
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *either the semantics or validity. Advice elements MAY be specified in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *an extension schema.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This class is an abstract base class for all Advice implementations and
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * encapsulates common functionality.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *@supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic abstract class AdviceBase {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    protected List _assertionIDRef       = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    protected List _assertion            = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    protected List _otherElements        = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Constructs an Advice element from an existing XML block.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param element representing a DOM tree element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @exception SAMLException if there is an error in the sender or in the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *            element definition.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public AdviceBase(Element element) throws SAMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        // Make sure the input is not null.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (element == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            SAMLUtilsCommon.debug.message("Advice: null input.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new SAMLRequesterException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                      SAMLUtilsCommon.bundle.getString("nullInput"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        // Make sure this element is an Advice element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String tag = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        tag = element.getLocalName();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((tag == null) || (!tag.equals("Advice"))) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            SAMLUtilsCommon.debug.message("Advice: wrong input");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new SAMLRequesterException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                      SAMLUtilsCommon.bundle.getString("wrongInput"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        NodeList  nodes = element.getChildNodes();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        int nodeCount = nodes.getLength();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (nodeCount > 0) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            for (int i = 0; i < nodeCount; i++) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                Node currentNode = nodes.item(i);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                if (currentNode.getNodeType() == Node.ELEMENT_NODE) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    String tagName = currentNode.getLocalName();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    String tagNS = currentNode.getNamespaceURI();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    if ((tagName == null) || tagName.length() == 0 ||
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        tagNS == null || tagNS.length() == 0) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        if (SAMLUtilsCommon.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            SAMLUtilsCommon.debug.message("Advice: " +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                "The tag name or tag namespace of child" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                " element is either null or empty.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        throw new SAMLRequesterException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                             SAMLUtilsCommon.bundle.getString("nullInput"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    if (tagName.equals("AssertionIDReference") &&
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        tagNS.equals(SAMLConstants.assertionSAMLNameSpaceURI)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        AssertionIDReference  assertionid =
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            createAssertionIDReference((Element)currentNode);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        if (_assertionIDRef == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            _assertionIDRef = new ArrayList();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        if ((_assertionIDRef.add(assertionid))== false) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            if (SAMLUtilsCommon.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                SAMLUtilsCommon.debug.message(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                              "Advice:failed to add" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                              " to AssertionIDReference List.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            throw new SAMLRequesterException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                  SAMLUtilsCommon.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                  "addListError"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    } else if (tagName.equals("Assertion") &&
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        tagNS.equals(SAMLConstants.assertionSAMLNameSpaceURI)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        AssertionBase assertion =
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                       createAssertion((Element)currentNode);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        if (_assertion == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            _assertion = new ArrayList();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        if ((_assertion.add(assertion))== false) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            if (SAMLUtilsCommon.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                SAMLUtilsCommon.debug.message(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                        "Advice:failed to add" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                        " to Assertion List.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            throw new SAMLRequesterException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                    SAMLUtilsCommon.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                        "addListError"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        if (_otherElements == null)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            _otherElements = new ArrayList();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        if (( _otherElements.add(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            (Element)currentNode))==false) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            if (SAMLUtilsCommon.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                SAMLUtilsCommon.debug.message("Advice: failed "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                        + "to add to other elements list.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                            throw new SAMLRequesterException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                SAMLUtilsCommon.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                                 "addListError"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            } // end of for loop
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } // end of if (nodeCount > 0)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Constructor
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param assertionidreference A List of <code>AssertionIDReference</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param assertion A List of Assertion
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param otherelement A List of any element defined as
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        <code>any namespace="##other" processContents="lax"</code>;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public AdviceBase(List assertionidreference, List assertion,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        List otherelement) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (assertionidreference != null && !assertionidreference.isEmpty()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (_assertionIDRef == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                _assertionIDRef = new ArrayList();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            _assertionIDRef = assertionidreference;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (assertion != null && !assertion.isEmpty()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (_assertion == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                _assertion = new ArrayList();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            _assertion = assertion;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (otherelement != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (_otherElements == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                _otherElements = new ArrayList();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            _otherElements = otherelement;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Creates appropriate Assertion Instance
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param assertionElement the assertion Element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return the assertion instance
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    protected abstract AssertionBase
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        createAssertion(Element assertionElement) throws SAMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Creates appropriate AssertionIDReference Instance
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param assertionIDRefElement the assertion ID reference Element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return the assertion ID reference instance
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    protected abstract AssertionIDReference
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        createAssertionIDReference(Element assertionIDRefElement)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        throws SAMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns access to the <code>AssertionIDReference</code> in this
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Advice element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return A list of <code>AssertionIDReference</code> in this Advice
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public List getAssertionIDReference() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return _assertionIDRef;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *Gets access to the Assertion in this Advice element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *@return A list of Assertion in this Advice element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public List getAssertion() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return _assertion;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *Gets other element contained within the Advice element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *@return A list of other elements.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public List getOtherElement() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return _otherElements;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *Creates a String representation of the <code>Advice</code> element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *@return A String representing the valid XML for this element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String toString() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return toString(true, false);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns a String representation of the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *         <code>&lt;saml:Advice&gt;</code> element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param includeNS Determines whether or not the namespace qualifier
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        is prepended to the Element when converted
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param declareNS Determines whether or not the namespace is declared
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        within the Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return A string containing the valid XML for this element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String toString(boolean includeNS, boolean declareNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        StringBuffer result = new StringBuffer(1000);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        Iterator iter = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String prefix = "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String uri = "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (includeNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            prefix = SAMLConstants.ASSERTION_PREFIX;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (declareNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            uri = SAMLConstants.assertionDeclareStr;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        result.append("<").append(prefix).append("Advice").append(uri).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster               append(">\n");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (_assertionIDRef != null && (!_assertionIDRef.isEmpty())) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            iter = _assertionIDRef.iterator();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            while (iter.hasNext()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                result.append(((AssertionIDReference)iter.next()).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                              toString(includeNS, false));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (_assertion != null && (!_assertion.isEmpty())) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            iter = _assertion.iterator();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            while (iter.hasNext()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                result.append(((AssertionBase)iter.next()).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                toString(includeNS, false));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (_otherElements != null && !(_otherElements.isEmpty())) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            iter = _otherElements.iterator();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            while (iter.hasNext()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                result.append(XMLUtils.print((Element)iter.next()));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        result.append("</").append(prefix).append("Advice>\n");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return result.toString();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster}