protocol/impl/NameIDMappingResponseImpl.java

/**
 * 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: NameIDMappingResponseImpl.java,v 1.2 2008/06/25 05:48:00 qcheng Exp $
 *
 */

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

import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

import com.sun.identity.saml.common.SAMLUtils;
import com.sun.identity.saml.xmlsig.XMLSignatureException;
import com.sun.identity.saml2.assertion.AssertionFactory;
import com.sun.identity.saml2.assertion.EncryptedID;
import com.sun.identity.saml2.assertion.NameID;
import com.sun.identity.saml2.common.SAML2Constants;
import com.sun.identity.saml2.common.SAML2Exception;
import com.sun.identity.saml2.common.SAML2SDKUtils;
import com.sun.identity.saml2.protocol.NameIDMappingResponse;
import com.sun.identity.saml2.protocol.ProtocolFactory;
import com.sun.identity.shared.DateUtils;
import com.sun.identity.shared.xml.XMLUtils;

public class NameIDMappingResponseImpl extends StatusResponseImpl
   implements NameIDMappingResponse {

    public final String elementName = "NameIDMappingResponse";
    NameID nameID = null;
    EncryptedID encryptedID = null;

    /**
     * Constructor to create <code>ManageNameIDResponse</code> Object.
     */
    public NameIDMappingResponseImpl() {
        isMutable = true;
    }

    /**
     * Constructor to create <code>ManageNameIDResponse</code> Object.
     *
     * @param element Document Element of <code>ManageNameIDRequest<code>
     *     object.
     * @throws SAML2Exception if <code>ManageNameIDRequest<code> cannot be
     *     created.
     */
    public NameIDMappingResponseImpl(Element element) throws SAML2Exception {
        parseElement(element);
        if (isSigned) {
            signedXMLString = XMLUtils.print(element);
        }
        makeImmutable();
    }

    /**
     * Constructor to create <code>ManageNameIDResponse</code> Object.
     *
     * @param xmlString XML representation of the
     *     <code>ManageNameIDRequest<code> object.
     * @throws SAML2Exception if <code>ManageNameIDRequest<code> cannot be
     *     created.
     */
    public NameIDMappingResponseImpl(String xmlString) throws SAML2Exception {
        Document doc = XMLUtils.toDOMDocument(xmlString, SAMLUtils.debug);
        if (doc == null) {
            throw new SAML2Exception("errorObtainingElement");
        }
        parseElement(doc.getDocumentElement());
        if (isSigned) {
            signedXMLString = xmlString;
        }
        makeImmutable();
    }

    private void parseElement(Element element) throws SAML2Exception {
        AssertionFactory af = AssertionFactory.getInstance();
        ProtocolFactory pf = ProtocolFactory.getInstance();

        // make sure that the input xml block is not null
        if (element == null) {
            if (SAML2SDKUtils.debug.messageEnabled()) {
                SAML2SDKUtils.debug.message(
                    "NameIDMappingResponseImpl.parseElement: Input is null.");
            }
            throw new SAML2Exception(
                SAML2SDKUtils.bundle.getString("nullInput"));
        }
        // Make sure this is an EncryptedAssertion.
        String tag = null;
        tag = element.getLocalName();
        if ((tag == null) || (!tag.equals(elementName))) {
            if (SAML2SDKUtils.debug.messageEnabled()) {
                SAML2SDKUtils.debug.message(
                    "NameIDMappingResponseImpl.parseElement: " +
                    "not ManageNameIDResponse.");
            }
            throw new SAML2Exception(
                SAML2SDKUtils.bundle.getString("wrongInput"));
        }

        responseId = element.getAttribute("ID");
        validateID(responseId);

        version = element.getAttribute("Version");
        validateVersion(version);

        String issueInstantStr = element.getAttribute("IssueInstant");
        validateIssueInstant(issueInstantStr);

        destination = element.getAttribute("Destination");
        consent = element.getAttribute("Consent");
        inResponseTo = element.getAttribute("InResponseTo");

        NodeList nList = element.getChildNodes();

        if ((nList !=null) && (nList.getLength() >0)) {
            for (int i = 0; i < nList.getLength(); i++) {
                Node childNode = nList.item(i);
                String cName = childNode.getLocalName() ;
                if (cName != null)  {
                    if (cName.equals("Issuer")) {
                        issuer = af.createIssuer((Element)childNode);
                    } else if (cName.equals("Signature")) {
                        signatureString =
                            XMLUtils.getElementString((Element)childNode);
                        isSigned = true;
                    } else if (cName.equals("Extensions")) {
                        extensions = pf.createExtensions((Element)childNode);
                    } else if (cName.equals("NameID")) {
                        nameID = af.createNameID((Element)childNode);
                    } else if (cName.equals("EncryptedID")) {
                        encryptedID = af.createEncryptedID((Element)childNode);
                    } else if (cName.equals("Status")) {
                        status = pf.createStatus((Element)childNode);
                    }
                }
            }
        }
    }

    /**
     * Returns the <code>ManageNameIDResponse</code> in an XML document String
     * format based on the <code>ManageNameIDResponse</code> schema described
     * above.
     *
     * @return An XML String representing the <code>ManageNameIDResponse</code>.
     * @throws SAML2Exception if it could not create String object.
     */
    public String toXMLString() throws SAML2Exception {
        return toXMLString(true, false);
    }

    /**
     * Returns the <code>ManageNameIDResponse</code> in an XML document String
     * format based on the <code>ManageNameIDResponse</code> schema described
     * above.
     *
     * @param includeNSPrefix Determines whether the namespace qualifier is
     *     prepended to the Element when converted
     * @param declareNS Determines whether or not the namespace is declared
     *     within the Element.
     * @return A XML String representing the <code>ManageNameIDResponse</code>.
    *  @throws SAML2Exception if it could not create String object.
     */
    public String toXMLString(boolean includeNSPrefix, boolean declareNS)
        throws SAML2Exception {

        if (isSigned && signedXMLString != null) {
            return signedXMLString;
        }

        validateData();

        StringBuffer result= new StringBuffer();
        String NS="";
        String NSP="";
        String uri="";

        if (declareNS) {
            NS = SAML2Constants.PROTOCOL_DECLARE_STR;
            uri=NS;
        }

        if (includeNSPrefix) {
            NSP = SAML2Constants.PROTOCOL_PREFIX;
        }

        result.append("<").append(NSP).append("NameIDMappingResponse")
              .append(uri).append(" ID=\"").append(responseId).append("\"");
        if (inResponseTo != null && inResponseTo.trim().length() != 0) {
            result.append(" InResponseTo=\"").append(inResponseTo).append("\"");
        }

        result.append(" Version=\"").append(version).append("\"")
              .append(" IssueInstant=\"")
              .append(DateUtils.toUTCDateFormat(issueInstant)).append("\"");
        if ((destination != null) && (destination.trim().length() != 0)) {
            result.append(" Destination=\"").append(destination)
                  .append("\"");
        }
        if ((consent != null) && (consent.trim().length() != 0)) {
            result.append(" Consent=\"").append(consent).append("\"");
        }
        result.append(">");
        if (issuer != null) {
            result.append(issuer.toXMLString(includeNSPrefix, declareNS));
        }
        if (signatureString != null) {
            result.append(signatureString);
        }
        if (extensions != null) {
            result.append(extensions.toXMLString(includeNSPrefix, declareNS));
        }
        if (nameID != null) {
            result.append(nameID.toXMLString(includeNSPrefix,declareNS));
        }
        if (encryptedID != null) {
            result.append(encryptedID.toXMLString(includeNSPrefix,declareNS));
        }

        result.append(status.toXMLString(includeNSPrefix, declareNS));

        result.append("</").append(NSP).append(elementName).append(">");

        return result.toString();
    }

    /**
     * Returns the value of the <code>encryptedID</code> property.
     *
     * @return the value of the <code>encryptedID</code> property.
     * @see #setEncryptedID(EncryptedID)
     */
    public EncryptedID getEncryptedID()
    {
        return encryptedID;
    }

    /**
     * Sets the value of the <code>encryptedID</code> property.
     *
     * @param value the value of the <code>encryptedID</code> property.
     * @exception SAML2Exception if <code>Object</code> is immutable.
     * @see #getEncryptedID
     */
    public void setEncryptedID(EncryptedID value) throws SAML2Exception
    {
        if (!isMutable) {
            throw new SAML2Exception(
                SAML2SDKUtils.bundle.getString("objectImmutable"));
        }

        encryptedID = value;
    }

    /**
     * Returns the value of the <code>nameID</code> property.
     *
     * @return the value of the <code>nameID</code> property.
     * @see #setNameID(NameID)
     */
    public NameID getNameID()
    {
        return nameID;
    }


    /**
     * Sets the value of the <code>nameID</code> property.
     *
     * @param value the value of the <code>nameID</code> property.
     * @exception SAML2Exception if <code>Object</code> is immutable.
     * @see #getNameID
     */
    public void setNameID(NameID value) throws SAML2Exception
    {
        if (!isMutable) {
            throw new SAML2Exception(
                SAML2SDKUtils.bundle.getString("objectImmutable"));
        }

        nameID = value;
    }

    protected void validateData() throws SAML2Exception {
        if (((nameID != null) && (encryptedID != null)) ||
            ((nameID == null) && (encryptedID == null))){
            throw new SAML2Exception("nameIDMRespWrongID");
        }

    }
}