com.sun.identity.saml2.protocol.impl.AssertionIDRequestImpl Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of openam-federation-library Show documentation
OpenAM Federation Library Components
There is a newer version: 14.8.4
Show newest version
/**
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2008 Sun Microsystems Inc. All Rights Reserved
 *
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at
 * https://opensso.dev.java.net/public/CDDLv1.0.html or
 * opensso/legal/CDDLv1.0.txt
 * See the License for the specific language governing
 * permission and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL
 * Header Notice in each file and include the License file
 * at opensso/legal/CDDLv1.0.txt.
 * If applicable, add the following below the CDDL Header,
 * with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * $Id: AssertionIDRequestImpl.java,v 1.2 2008/06/25 05:47:59 qcheng Exp $
 *
 */


package com.sun.identity.saml2.protocol.impl;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
import java.util.Set;
import org.w3c.dom.Document;
import org.w3c.dom.Element;

import com.sun.identity.saml2.assertion.AssertionFactory;
import com.sun.identity.saml2.assertion.AssertionIDRef;
import com.sun.identity.saml2.common.SAML2Constants;
import com.sun.identity.saml2.common.SAML2Exception;
import com.sun.identity.saml2.common.SAML2Utils;
import com.sun.identity.saml2.protocol.AssertionIDRequest;
import com.sun.identity.shared.xml.XMLUtils;

/**
 * This class represents the AssertionIDRequest element in SAMLv2 protocol
 * schema.
 * The following schema fragment specifies the expected 	
 * content contained within this java content object. 	
 * 

 * 
 * <element name="AssertionIDRequest" type="{urn:oasis:names:tc:SAML:2.0:protocol}AssertionIDRequestType"/>
 * 
 *
 */
public class AssertionIDRequestImpl extends RequestAbstractImpl
    implements AssertionIDRequest {

    protected List assertionIDRefs;

    /**
     * Constructor to create AssertionIDRequest Object .
     */
    public AssertionIDRequestImpl() {
        elementName = SAML2Constants.ASSERTION_ID_REQUEST;
        isMutable = true;
    }

    /**
     * Constructor to create AssertionIDRequest Object.
     *
     * @param element the Document Element Object.
     * @throws SAML2Exception if error creating AssertionIDRequest
     *     Object. 
     */
    public AssertionIDRequestImpl(Element element) throws SAML2Exception {
        parseDOMElement(element);
        elementName = SAML2Constants.ASSERTION_ID_REQUEST;
        if (isSigned) {
            signedXMLString = XMLUtils.print(element);
        }
    }

    /**
     * Constructor to create AssertionIDRequest Object.
     *
     * @param xmlString the XML String.
     * @throws SAML2Exception if error creating AssertionIDRequest
     *     Object. 
     */
    public AssertionIDRequestImpl(String xmlString) throws SAML2Exception {
        Document xmlDocument = XMLUtils.toDOMDocument(xmlString,
            SAML2Utils.debug);
        if (xmlDocument == null) {
            throw new SAML2Exception(SAML2Utils.bundle.getString(
                "errorObtainingElement"));
        }
        parseDOMElement(xmlDocument.getDocumentElement());
        elementName = SAML2Constants.ASSERTION_ID_REQUEST;
        if (isSigned) {
            signedXMLString = xmlString;
        }
    }

    /** 
     * Returns a list of AssertionIDRef objects.
     *
     * @return list of AssertionIDRef objects.
     * @see #setAssertionIDRefs(List)
     */
    public List getAssertionIDRefs() {
        return assertionIDRefs;
    }

    /** 
     * Sets a list of AssertionIDRef Objects.
     *
     * @param assertionIDRefs the list of AssertionIDRef objects.
     * @throws SAML2Exception if the object is immutable.
     * @see #getAssertionIDRefs
     */
    public void setAssertionIDRefs(List assertionIDRefs) throws SAML2Exception {
        if (!isMutable) {
            throw new SAML2Exception(SAML2Utils.bundle.getString(
                "objectImmutable"));
        }
        this.assertionIDRefs = assertionIDRefs;
    }

    protected void getXMLString(Set namespaces, StringBuffer attrs,
        StringBuffer childElements, boolean includeNSPrefix, boolean declareNS)
        throws SAML2Exception {

        validateData();

        if (declareNS) {
            namespaces.add(SAML2Constants.PROTOCOL_DECLARE_STR.trim());
            namespaces.add(SAML2Constants.ASSERTION_DECLARE_STR.trim());
        }

        super.getXMLString(namespaces, attrs, childElements, includeNSPrefix,
            declareNS);

        for(Iterator iter = assertionIDRefs.iterator(); iter.hasNext();) {
            AssertionIDRef assertionIDRef = (AssertionIDRef)iter.next();
            childElements.append(assertionIDRef.toXMLString(
                includeNSPrefix, declareNS)).append(SAML2Constants.NEWLINE);
	}
    }

    protected void validateData() throws SAML2Exception {
        if ((assertionIDRefs == null) || (assertionIDRefs.isEmpty())) {
            if (SAML2Utils.debug.messageEnabled()) {
                SAML2Utils.debug.message("AssertionIDRequestImpl." +
                "getXMLString: AssertionIDRef is expected");
            }

            throw new SAML2Exception(SAML2Utils.bundle.getString(
                "schemaViolation"));
        }
    }

    /** 
     * Parses attributes of the Docuemnt Element for this object.
     * 
     * @param element the Document Element of this object.
     * @throws SAML2Exception if error parsing the Document Element.
     */ 
    protected void parseDOMAttributes(Element element) throws SAML2Exception {
        super.parseDOMAttributes(element);
    }

    /** 
     * Parses child elements of the Docuemnt Element for this object.
     * 
     * @param iter the child elements iterator.
     * @throws SAML2Exception if error parsing the Document Element.
     */ 
    protected void parseDOMChileElements(ListIterator iter)
        throws SAML2Exception {

        super.parseDOMChileElements(iter);

        AssertionFactory aFactory = AssertionFactory.getInstance();
        while(iter.hasNext()) {
            Element childElement = (Element)iter.next();
            String localName = childElement.getLocalName() ;
            if (SAML2Constants.ASSERTION_ID_REF.equals(localName)) {
                AssertionIDRef assertionIDRef =
                    aFactory.createAssertionIDRef(childElement);
                if (assertionIDRefs == null) {
                    assertionIDRefs = new ArrayList();
                }
                assertionIDRefs.add(assertionIDRef);
            } else {
                iter.previous();
                break;
            }
        }

        if (assertionIDRefs == null) {
            throw new SAML2Exception(SAML2Utils.bundle.getString(
                "schemaViolation"));
        }
    }
}