federation/message/FSNameRegistrationResponse.java

	FSNameRegistrationResponse.java revision ccf9d4a5c6453fa9f8b839baeee25147865fbb7d
a78048ccbdb6256da15e6b0e7e95355e480c2301nd/*
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
fd9abdda70912b99b24e3bf1a38f26fde908a74cnd *
fd9abdda70912b99b24e3bf1a38f26fde908a74cnd * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
fd9abdda70912b99b24e3bf1a38f26fde908a74cnd *
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * The contents of this file are subject to the terms
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * of the Common Development and Distribution License
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * (the License). You may not use this file except in
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * compliance with the License.
96ad5d81ee4a2cc66a4ae19893efc8aa6d06fae7jailletc *
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * You can obtain a copy of the License at
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * https://opensso.dev.java.net/public/CDDLv1.0.html or
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen * opensso/legal/CDDLv1.0.txt
2e545ce2450a9953665f701bb05350f0d3f26275nd * See the License for the specific language governing
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen * permission and limitations under the License.
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen *
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * When distributing Covered Code, include this CDDL
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * Header Notice in each file and include the License file
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * at opensso/legal/CDDLv1.0.txt.
af33a4994ae2ff15bc67d19ff1a7feb906745bf8rbowen * If applicable, add the following below the CDDL Header,
3f08db06526d6901aa08c110b5bc7dde6bc39905nd * with the fields enclosed by brackets [] replaced by
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * your own identifying information:
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * "Portions Copyrighted [year] [name of copyright owner]"
a78048ccbdb6256da15e6b0e7e95355e480c2301nd *
3f08db06526d6901aa08c110b5bc7dde6bc39905nd * $Id: FSNameRegistrationResponse.java,v 1.3 2008/06/25 05:46:45 qcheng Exp $
a78048ccbdb6256da15e6b0e7e95355e480c2301nd *
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * Portions Copyrighted 2014-2016 ForgeRock AS.
a78048ccbdb6256da15e6b0e7e95355e480c2301nd */
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301ndpackage com.sun.identity.federation.message;
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport static org.forgerock.openam.utils.Time.*;
4b575a6b6704b516f22d65a3ad35696d7b9ba372rpluem
4b575a6b6704b516f22d65a3ad35696d7b9ba372rpluemimport com.sun.identity.federation.common.FSUtils;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport com.sun.identity.federation.common.IFSConstants;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport com.sun.identity.federation.message.common.FSMsgException;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport com.sun.identity.saml.common.SAMLConstants;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport com.sun.identity.saml.common.SAMLException;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport com.sun.identity.saml.common.SAMLResponderException;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport com.sun.identity.saml.common.SAMLVersionMismatchException;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport com.sun.identity.saml.protocol.AbstractResponse;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport com.sun.identity.saml.protocol.Status;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport com.sun.identity.saml.protocol.StatusCode;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport com.sun.identity.saml.xmlsig.XMLSignatureManager;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport com.sun.identity.shared.DateUtils;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport com.sun.identity.shared.encode.Base64;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport com.sun.identity.shared.encode.URLEncDec;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport com.sun.identity.shared.xml.XMLUtils;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport java.text.ParseException;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport java.util.Date;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport java.util.List;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport javax.servlet.http.HttpServletRequest;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport org.w3c.dom.Document;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport org.w3c.dom.Element;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport org.w3c.dom.Node;
a78048ccbdb6256da15e6b0e7e95355e480c2301ndimport org.w3c.dom.NodeList;
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd/**
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * This class has methods to create <code>NameRegistrationResponse</code>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * object.
a78048ccbdb6256da15e6b0e7e95355e480c2301nd *
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * @supported.all.api
a78048ccbdb6256da15e6b0e7e95355e480c2301nd * @deprecated since 12.0.0
a78048ccbdb6256da15e6b0e7e95355e480c2301nd */
a78048ccbdb6256da15e6b0e7e95355e480c2301nd@Deprecated
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
f4cbda69df0490c6deaacb8d04f103d200ddd183ndpublic class FSNameRegistrationResponse extends AbstractResponse {
00964e7a8c1409d8229a4d8f02c56b2bf26b3596rbowen    private String providerId = null;
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    private String relayState = "";
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    private Status status = null;
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh    protected String xmlString        = null;
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar    protected String signatureString        = null;
f4cbda69df0490c6deaacb8d04f103d200ddd183nd    protected String id = null;
f4cbda69df0490c6deaacb8d04f103d200ddd183nd    protected int minorVersion = 0;
f4cbda69df0490c6deaacb8d04f103d200ddd183nd
f4cbda69df0490c6deaacb8d04f103d200ddd183nd    /**
f4cbda69df0490c6deaacb8d04f103d200ddd183nd     * Default Constructor.
f4cbda69df0490c6deaacb8d04f103d200ddd183nd     */
f4cbda69df0490c6deaacb8d04f103d200ddd183nd    public FSNameRegistrationResponse() {
f4cbda69df0490c6deaacb8d04f103d200ddd183nd        try {
f4cbda69df0490c6deaacb8d04f103d200ddd183nd            setIssueInstant(newDate());
f4cbda69df0490c6deaacb8d04f103d200ddd183nd            StatusCode statusCode = new StatusCode(IFSConstants.SAML_SUCCESS);
f4cbda69df0490c6deaacb8d04f103d200ddd183nd            status = new Status(statusCode);
f4cbda69df0490c6deaacb8d04f103d200ddd183nd        } catch(Exception e){
f4cbda69df0490c6deaacb8d04f103d200ddd183nd            FSUtils.debug.error("FSNameRegistrationResponse.Constructor", e);
f4cbda69df0490c6deaacb8d04f103d200ddd183nd        }
f4cbda69df0490c6deaacb8d04f103d200ddd183nd    }
f4cbda69df0490c6deaacb8d04f103d200ddd183nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    /**
00964e7a8c1409d8229a4d8f02c56b2bf26b3596rbowen     * Returns the value of <code>RelayState</code> attribute.
00964e7a8c1409d8229a4d8f02c56b2bf26b3596rbowen     *
00964e7a8c1409d8229a4d8f02c56b2bf26b3596rbowen     * @return the value of <code>RelayState</code> attribute.
00964e7a8c1409d8229a4d8f02c56b2bf26b3596rbowen     * @see #setRelayState(String)
00964e7a8c1409d8229a4d8f02c56b2bf26b3596rbowen     */
00964e7a8c1409d8229a4d8f02c56b2bf26b3596rbowen    public String getRelayState(){
00964e7a8c1409d8229a4d8f02c56b2bf26b3596rbowen        return relayState;
60ee73f225a3fd9bb1e561ec3aadda7fcd8243a9igalic    }
00964e7a8c1409d8229a4d8f02c56b2bf26b3596rbowen
00964e7a8c1409d8229a4d8f02c56b2bf26b3596rbowen    /**
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     * Set the value of <code>RelayState</code> attribute.
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     *
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     * @param relayState the value of <code>RelayState</code> attribute.
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     * @see #getRelayState()
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     */
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    public void setRelayState(String relayState){
a78048ccbdb6256da15e6b0e7e95355e480c2301nd        this.relayState = relayState;
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    }
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    /**
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     * Returns the value of <code>id</code> attribute.
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     *
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     * @return the value of <code>id</code> attribute.
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     * @see #setID(String)
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     */
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    public String getID(){
a78048ccbdb6256da15e6b0e7e95355e480c2301nd        return id;
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    }
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    /**
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     * Sets the value of <code>id</code> attribute.
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     *
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     * @param id the value of <code>id</code> attribute.
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     * @see #getID()
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     */
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    public void setID(String id){
a78048ccbdb6256da15e6b0e7e95355e480c2301nd        this.id = id;
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    }
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    /**
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     * Returns the value of <code>ProviderID</code> attribute.
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     *
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     * @return the value of <code>ProviderID</code> attribute.
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     * @see #setProviderId(String).
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     */
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    public String getProviderId(){
a78048ccbdb6256da15e6b0e7e95355e480c2301nd        return providerId;
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    }
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    /**
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     * Sets the value of providerID attribute.
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     *
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     * @param providerId the value of providerID attribute.
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     * @see #getProviderId()
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     */
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    public void setProviderId(String providerId){
a78048ccbdb6256da15e6b0e7e95355e480c2301nd        this.providerId = providerId;
a78048ccbdb6256da15e6b0e7e95355e480c2301nd    }
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung
727872d18412fc021f03969b8641810d8896820bhumbedooh    /**
0d0ba3a410038e179b695446bb149cce6264e0abnd     * Returns signed <code>XML</code> representation of this
727872d18412fc021f03969b8641810d8896820bhumbedooh     * object.
cc7e1025de9ac63bd4db6fe7f71c158b2cf09fe4humbedooh     *
0d0ba3a410038e179b695446bb149cce6264e0abnd     * @return xmlString signed <code>XML</code> representation of this
cc7e1025de9ac63bd4db6fe7f71c158b2cf09fe4humbedooh     *         object.
727872d18412fc021f03969b8641810d8896820bhumbedooh     */
0d0ba3a410038e179b695446bb149cce6264e0abnd    public String getSignedXMLString(){
0d0ba3a410038e179b695446bb149cce6264e0abnd        return xmlString;
0d0ba3a410038e179b695446bb149cce6264e0abnd    }
ac082aefa89416cbdc9a1836eaf3bed9698201c8humbedooh
0d0ba3a410038e179b695446bb149cce6264e0abnd    /**
0d0ba3a410038e179b695446bb149cce6264e0abnd     * Returns the signed <code>NameRegistrationResponse</code> string.
0d0ba3a410038e179b695446bb149cce6264e0abnd     *
727872d18412fc021f03969b8641810d8896820bhumbedooh     * @return signatureString the signed <code>NameRegistrationResponse</code>
0d0ba3a410038e179b695446bb149cce6264e0abnd     *         string.
0d0ba3a410038e179b695446bb149cce6264e0abnd     */
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh    public String getSignatureString(){
205f749042ed530040a4f0080dbcb47ceae8a374rjung        return signatureString;
af33a4994ae2ff15bc67d19ff1a7feb906745bf8rbowen    }
0d0ba3a410038e179b695446bb149cce6264e0abnd
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd    /**
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd     * Constructor creates the <code>FSNameRegistrationResponse</code> object.
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd     *
a78048ccbdb6256da15e6b0e7e95355e480c2301nd     * @param responseID the value of <code>ResponseID</code> attribute.
     * @param inResponseTo the value of <code>InResponseTo</code> attribute.
     * @param status the <code>Status</code> object.
     * @param providerId the value of <code>ProviderID</code> attribute.
     * @param relayState the value of <code>RelayState</code> attribute.
     * @throws FSMsgException if there is an error creating this object.
     */
    public FSNameRegistrationResponse(String responseID, String inResponseTo,
            Status status, String providerId,
            String relayState) throws FSMsgException {
        if ((responseID == null) || (responseID.length() == 0)) {
            this.responseID = FSUtils.generateID();
            if (this.responseID == null) {
                throw new FSMsgException("errorGenerateID",null);
            }
        } else {
            this.responseID = responseID;
        }
        if (inResponseTo == null) {
            FSUtils.debug.message("Response: inResponseTo is null.");
            throw new FSMsgException("nullInput",null);
        }
        this.inResponseTo = inResponseTo;
        if (status == null) {
            FSUtils.debug.message("Response: missing <Status>.");
            throw new FSMsgException("missingElement",null);
        }
        this.status = status;
        this.providerId = providerId;
        this.relayState = relayState;
        setIssueInstant(newDate());
    }

    /**
     * Constructor creates the <code>FSNameRegistrationResponse</code> object
     * from Document Element.
     *
     * @param root the Document Element objec.t
     * @throws FSMsgException if there is an error creating this object.
     * @throws SAMLException if there is an error creating this object.
     */
    public FSNameRegistrationResponse(Element root) throws
            FSMsgException, SAMLException {
        if (root == null) {
            FSUtils.debug.message("FSNameRegistrationResponse.parseXML:" +
                    " null input.");
            throw new FSMsgException("nullInput",null);
        }
        String tag = null;
        if (((tag = root.getLocalName()) == null) ||
                (!tag.equals("RegisterNameIdentifierResponse"))) {
            FSUtils.debug.error("FSNameRegistrationResponse.parseXML: wrong"+
                    " input.");
            throw new FSMsgException("wrongInput",null);
        }

        id = root.getAttribute("id");

        // Attribute ResponseID
        responseID = root.getAttribute("ResponseID");
        if ((responseID == null) || (responseID.length() == 0)) {
            FSUtils.debug.error("FSNameRegistrationResponse.parseXML: "
                    + "Reponse doesn't have ResponseID.");
            String[] args = { IFSConstants.RESPONSE_ID };
            throw new FSMsgException("missingAttribute",args);
        }

        parseMajorVersion(root.getAttribute("MajorVersion"));
        parseMinorVersion(root.getAttribute("MinorVersion"));

        // Attribute InResponseTo
        inResponseTo = root.getAttribute("InResponseTo");
        if (inResponseTo == null) {
            FSUtils.debug.error("FSNameRegistrationResponse.parseXML: "
                    + "Response doesn't have InResponseTo.");
            String[] args = { IFSConstants.IN_RESPONSE_TO };
            throw new FSMsgException("missingAttribute",args);
        }
        // Attribute IssueInstant
        String instantString = root.getAttribute("IssueInstant");
        if ((instantString == null) || (instantString.length() == 0)) {
            FSUtils.debug.error("FSNameRegistrationResponse(Element): " +
                    "missing IssueInstant");
            String[] args = { IFSConstants.ISSUE_INSTANT };
            throw new FSMsgException("missingAttribute",args);
        } else {
            try {
                issueInstant = DateUtils.stringToDate(instantString);
            } catch (ParseException e) {
                FSUtils.debug.error(
                        "FSNameRegistrationResponse(Element):" +
                        " could not parse IssueInstant:" , e);
                throw new FSMsgException("wrongInput",null);
            }
        }

        NodeList nl = root.getChildNodes();
        Node child;
        String childName;
        int length = nl.getLength();
        for (int i = 0; i < length; i++) {
            child = nl.item(i);
            if ((childName = child.getLocalName()) != null) {
                if (childName.equals("Status")) {
                    if (status != null) {
                        FSUtils.debug.error("FSNameRegistrationResponse: " +
                                "included more than one <Status>");
                        throw new FSMsgException("moreElement",null);
                    }
                    status = new Status((Element) child);
                } else if (childName.equals(IFSConstants.SIGNATURE)) {
                } else if (childName.equals("ProviderID")) {
                    if (providerId != null) {
                        FSUtils.debug.error("FSNameRegistrationResponse:" +
                                " included more than one providerId");
                        throw new FSMsgException("moreElement",null);
                    }
                    providerId = XMLUtils.getElementValue((Element) child);
                } else if (childName.equals("RelayState")) {
                    relayState = XMLUtils.getElementValue((Element) child);
                }else {
                    FSUtils.debug.error("FSNameRegistrationResponse: " +
                            "included wrong element:" + childName);
                    throw new FSMsgException("wrongInput",null);
                }
            } // end if childName != null
        } // end for loop

        if (status == null) {
            FSUtils.debug.message(
                    "FSNameRegistrationResponse: missing element <Status>.");
            throw new FSMsgException("oneElement",null);
        }

        if (providerId == null) {
            FSUtils.debug.message(
                    "FSNameRegistrationResponse: missing element providerId.");
            throw new FSMsgException("oneElement",null);
        }

        //check for signature
        List signs = XMLUtils.getElementsByTagNameNS1(root,
                SAMLConstants.XMLSIG_NAMESPACE_URI,
                SAMLConstants.XMLSIG_ELEMENT_NAME);
        int signsSize = signs.size();
        if (signsSize == 1) {
            Element elem = (Element)signs.get(0);
            setSignature(elem);
            xmlString = XMLUtils.print(root);
            signed = true;
        } else if (signsSize != 0) {
            FSUtils.debug.error("FSNameRegistrationResponse(Element): " +
                    "included more than one Signature element.");
            throw new FSMsgException("moreElement",null);
        }
    }

    /**
     * Returns the <code>MinorVersion</code>.
     *
     * @return the <code>MinorVersion</code>.
     * @see #setMinorVersion(int)
     */
    public int getMinorVersion() {
        return minorVersion;
    }

    /**
     * Sets the <code>MinorVersion</code>.
     *
     * @param version the <code>MinorVersion</code>.
     * @see #getMinorVersion()
     */

    public void setMinorVersion(int version) {
        minorVersion = version;
    }

    /**
     * Returns the Response <code>Status</code>.
     *
     * @return the Response <code>Status</code>.
     * @see #setStatus(Status)
     */
    public Status getStatus() {
        return status;
    }


    /**
     * Sets the Response <code>Status</code>.
     *
     * @param status the Response <code>Status</code object.
     * @see #getStatus
     */
    public void setStatus(Status status) {
        this.status=status;
    }

    /**
     * Sets the <code>MajorVersion</code> by parsing the version string.
     *
     * @param majorVer a String representing the <code>MajorVersion</code> to
     *        be set.
     * @throws FSMsgException on error.
     * @throws SAMLException when the version mismatchs.
     */
    private void parseMajorVersion(
            String majorVer
            ) throws FSMsgException, SAMLException {
        try {
            majorVersion = Integer.parseInt(majorVer);
        } catch (NumberFormatException e) {
            FSUtils.debug.error("Response(Element): invalid MajorVersion", e);
            throw new FSMsgException("wrongInput",null);
        }

        if (majorVersion != SAMLConstants.PROTOCOL_MAJOR_VERSION) {
            if (majorVersion > SAMLConstants.PROTOCOL_MAJOR_VERSION) {
                if (FSUtils.debug.messageEnabled()) {
                    FSUtils.debug.message("Response(Element):MajorVersion of"
                            + " the Response is too high.");
                }
                throw new SAMLVersionMismatchException(FSUtils.BUNDLE_NAME,
                        "responseVersionTooHigh",null);
            } else {
                if (FSUtils.debug.messageEnabled()) {
                    FSUtils.debug.message("Response(Element):MajorVersion of"
                            + " the Response is too low.");
                }
                throw new SAMLVersionMismatchException(FSUtils.BUNDLE_NAME,
                        "responseVersionTooLow",null);
            }
        }
    }

    /**
     * Sets the <code>MinorVersion</code> by parsing the version string.
     *
     * @param minorVer a String representing the <code>MinorVersion</code> to
     *        be set.
     * @throws SAMLException when the version mismatchs.
     */
    private void parseMinorVersion(String minorVer) throws FSMsgException {
        try {
            minorVersion = Integer.parseInt(minorVer);
        } catch (NumberFormatException e) {
            if (FSUtils.debug.messageEnabled()) {
                FSUtils.debug.message(
                        "FSRegisResp(Element): "
                        + "invalid MinorVersion", e);
            }
            throw new FSMsgException("wrongInput",null);
        }

        if (minorVersion > IFSConstants.FF_12_PROTOCOL_MINOR_VERSION) {
            FSUtils.debug.error("FSRegisResp(Element):MinorVersion of"
                    + " the Response is too high.");
            throw new FSMsgException("responseVersionTooHigh",null);
        } else if (minorVersion < IFSConstants.FF_11_PROTOCOL_MINOR_VERSION) {
            FSUtils.debug.error("FSRegisResp(Element):MinorVersion of"
                    + " the Response is too low.");
            throw new FSMsgException("responseVersionTooLow",null);
        }

    }

    /**
     * Returns the <code>FSNameRegistrationResponse</code> object.
     *
     * @param xml the XML string to be parsed.
     * @return <code>FSNameRegistrationResponsee</code> object created from
     *         the XML string.
     * @throws FSMsgException if there is error creating the object.
     */
    public static FSNameRegistrationResponse parseXML(String xml)
    throws FSMsgException {
        try{
            Document doc = XMLUtils.toDOMDocument(xml, FSUtils.debug);
            Element root = doc.getDocumentElement();
            return new FSNameRegistrationResponse(root);
        }catch(SAMLException ex){
            if (FSUtils.debug.messageEnabled()) {
                FSUtils.debug.message("FSNameRegistrationResponse.parseXML: "
                        + "Error while parsing input xml string");
            }
            throw new FSMsgException("parseError", null, ex);
        }

    }

    /**
     * Returns the string representation of this object.
     * This method translates the response to an XML string.
     *
     * @return An XML String representing the Response.
     * @throws FSMsgException on error.
     */
    public String toXMLString()  throws FSMsgException {
        return this.toXMLString(true, true);
    }

    /**
     * Returns a String representation of the Logout Response.
     *
     * @param includeNS : Determines whether or not 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 string containing the valid XML for this element
     * @throws FSMsgException if there is an error converting
     *         this object to a string.
     */
    public String toXMLString(boolean includeNS, boolean declareNS)
    throws FSMsgException {
        return toXMLString(includeNS, declareNS, false);
    }

    /**
     * Returns a String representation of the Logout Response.
     *
     * @param includeNS Determines whether or not the namespace qualifier
     *        is prepended to the Element when converted
     * @param declareNS Determines whether or not the namespace is declared
     *        within the Element.
     * @param includeHeader Determines whether the output include the xml
     *        declaration header.
     * @return a string containing the valid XML for this element
     * @throws FSMsgException if there is an error converting
     *         this object to a string.
     */
    public String toXMLString(boolean includeNS, boolean declareNS,
            boolean includeHeader) throws FSMsgException {
        StringBuffer xml = new StringBuffer(300);
        if (includeHeader) {
            xml.append("<?xml version=\"1.0\" encoding=\"").
                    append(SAMLConstants.DEFAULT_ENCODING).append("\" ?>\n");
        }
        String prefixLIB = "";
        String uriLIB = "";
        if (includeNS) {
            prefixLIB = IFSConstants.LIB_PREFIX;
        }

        if (declareNS) {
            if (minorVersion == IFSConstants.FF_12_PROTOCOL_MINOR_VERSION) {
                uriLIB = IFSConstants.LIB_12_NAMESPACE_STRING;
            } else {
                uriLIB = IFSConstants.LIB_NAMESPACE_STRING;
            }
        }

        String instantString = DateUtils.toUTCDateFormat(issueInstant);

        if ((providerId == null) || (providerId.length() == 0)){
            FSUtils.debug.error("FSNameRegistrationResponse.toXMLString: "
                    + "providerId is null in the response with responseId:"
                    + responseID);
            throw new FSMsgException("nullProviderID",null);
        }

        if ((responseID != null) && (inResponseTo != null)){
            xml.append("<").append(prefixLIB).
                    append("RegisterNameIdentifierResponse").append(uriLIB);
            if (minorVersion == IFSConstants.FF_11_PROTOCOL_MINOR_VERSION &&
                    id != null && !(id.length() == 0)) {
                xml.append(" id=\"").append(id).append("\" ");
            }
            xml.append(" ResponseID=\"").append(responseID).append("\" ").
                    append(" InResponseTo=\"").append(inResponseTo).
                    append("\" ").
                    append(" MajorVersion=\"").append(majorVersion).
                    append("\" ").
                    append(" MinorVersion=\"").append(minorVersion).
                    append("\" ").
                    append(" IssueInstant=\"").append(instantString).
                    append("\" ").
                    append(">");
        }

        if (signed) {
            if (signatureString != null) {
                xml.append(signatureString);
            } else if (signature != null) {
                signatureString = XMLUtils.print(signature);
                xml.append(signatureString);
            }
        }

        if (providerId != null) {
            xml.append("<").append(prefixLIB).append("ProviderID").append(">").
                    append(providerId).
                    append("</").append(prefixLIB).append("ProviderID").
                    append(">");
        }

        if (status != null) {
            xml.append(status.toString(includeNS, true));
        }

        if (relayState != null) {
            xml.append("<").append(prefixLIB).append("RelayState").
                    append(">").append(relayState).
                    append("</").append(prefixLIB).
                    append("RelayState").append(">");
        }

        xml.append("</").append(prefixLIB).
                append("RegisterNameIdentifierResponse>");
        return xml.toString();
    }

    /**
     * Returns <code>FSNameRegistrationResponse</code> object. The object
     * is created by parsing an Base64 encode Name Registration Response
     * string.
     *
     * @param encodedRes the encoded response string
     * @throws FSMsgException if there is an error
     *         creating this object.
     * @throws SAMLException if there is an error
     *         creating this object.
     */
    public static FSNameRegistrationResponse parseBASE64EncodedString(
            String encodedRes) throws FSMsgException, SAMLException {
        if (encodedRes != null){
            String decodedNameRegRes = new String(Base64.decode(encodedRes));
            if (FSUtils.debug.messageEnabled()) {
                FSUtils.debug.message("FSNameRegistrationResponse."
                        + "parseBASE64EncodedString: decoded input string: "
                        + decodedNameRegRes);
            }
            return parseXML(decodedNameRegRes);
        } else{
            if (FSUtils.debug.messageEnabled()) {
                FSUtils.debug.message(
                        "FSNameRegistrationResponse.parseBASE64EncodedString"
                        + ": null String passed in as argument.");
            }
            throw new FSMsgException("nullInput",null);
        }
    }

    /**
     * Returns a Base64 Encoded String.
     *
     * @return a Base64 Encoded String.
     * @throws FSMsgException if there is an error encoding
     *         the string.
     */
    public String toBASE64EncodedString() throws FSMsgException {
        if ((responseID == null) || (responseID.length() == 0)){
            responseID = FSUtils.generateID();
            if (responseID == null) {
                FSUtils.debug.error(
                        "FSNameRegistrationResponse.toBASE64EncodedString: "
                        + "couldn't generate ResponseID.");
                throw new FSMsgException("errorGenerateID",null);
            }
        }
        return Base64.encode(this.toXMLString().getBytes());
    }

    /**
     * Signs the Name Registration Response.
     *
     * @param certAlias the Certificate Alias.
     * @throws SAMLException if this object cannot be signed.
     */
    public void signXML(String certAlias) throws SAMLException {
        FSUtils.debug.message("FSNameRegistrationResponse.signXML: Called");
        if (signed) {
            if (FSUtils.debug.messageEnabled()) {
                FSUtils.debug.message("FSNameRegistrationResponse.signXML: "
                        + "the assertion is already signed.");
            }
            throw new SAMLResponderException(FSUtils.BUNDLE_NAME,
                    "alreadySigned",null);
        }
        if (certAlias == null || certAlias.length() == 0) {
            throw new SAMLResponderException(FSUtils.BUNDLE_NAME,
                    "cannotFindCertAlias",null);
        }
        try{
            XMLSignatureManager manager = XMLSignatureManager.getInstance();
            if (minorVersion == IFSConstants.FF_11_PROTOCOL_MINOR_VERSION) {
                signatureString = manager.signXML(this.toXMLString(true, true),
                        certAlias, IFSConstants.DEF_SIG_ALGO, IFSConstants.ID,
                        this.id, false);
            } else if (minorVersion ==
                    IFSConstants.FF_12_PROTOCOL_MINOR_VERSION) {
                signatureString = manager.signXML(this.toXMLString(true, true),
                        certAlias, IFSConstants.DEF_SIG_ALGO,
                        IFSConstants.RESPONSE_ID,
                        this.getResponseID(), false);
            } else {
                if (FSUtils.debug.messageEnabled()) {
                    FSUtils.debug.message("invalid minor version.");
                }
            }
            signature =
                    XMLUtils.toDOMDocument(signatureString, FSUtils.debug)
                    .getDocumentElement();

            signed = true;
            xmlString = this.toXMLString(true, true);
        }catch(Exception e){
            throw new SAMLResponderException(FSUtils.BUNDLE_NAME,
                                             "signError",null);
        }
    }

    /**
     * Unsupported operation.
     */
    public void signXML() throws SAMLException {
        throw new SAMLException(FSUtils.BUNDLE_NAME,
                               "unsupportedOperation",null);
    }

    /**
     * Sets the Signature.
     *
     * @param elem the Document Element.
     * @return true if success otherwise false.
     */
    public boolean setSignature(Element elem) {
        signatureString = XMLUtils.print(elem);
        return super.setSignature(elem);
    }

    /**
     * Returns an URL Encoded String.
     *
     * @return a url encoded query string.
     * @throws FSMsgException if there is an error.
     */
    public String toURLEncodedQueryString() throws FSMsgException {
        if ((providerId == null) || (providerId.length() == 0)){
            FSUtils.debug.error("FSNameRegistrationResponse."
                    + "toURLEncodedQueryString: providerId is null in "
                    + "the response ");
            throw new FSMsgException("nullProviderIdInRequest",null);
        }
        if ((responseID == null) || (responseID.length() == 0)){
            responseID = FSUtils.generateID();
            if (responseID == null) {
                FSUtils.debug.error("FSNameRegistrationRequest."
                        + "toURLEncodedQueryString: couldn't generate "
                        + "responseID.");
                throw new FSMsgException("errorGenerateID",null);
            }
        }
        StringBuffer urlEncodedAuthnReq = new StringBuffer(300);
        urlEncodedAuthnReq.append("ResponseID=").
                append(URLEncDec.encode(responseID)).
                append(IFSConstants.AMPERSAND);
        urlEncodedAuthnReq.append("MajorVersion=").
                append(majorVersion).append(IFSConstants.AMPERSAND);
        urlEncodedAuthnReq.append("MinorVersion=").
                append(minorVersion).append(IFSConstants.AMPERSAND);
        urlEncodedAuthnReq.append("InResponseTo=").
                append(URLEncDec.encode(inResponseTo)).
                append(IFSConstants.AMPERSAND);

        if (issueInstant != null){
            urlEncodedAuthnReq.append("IssueInstant=")
            .append(URLEncDec.encode(
                    DateUtils.toUTCDateFormat(issueInstant)))
                    .append(IFSConstants.AMPERSAND);
        } else {
            FSUtils.debug.error("FSNameRegistrationRequest."
                    + "toURLEncodedQueryString: issueInstant missing");
            String[] args = { IFSConstants.ISSUE_INSTANT };
            throw new FSMsgException("missingAttribute",args);
        }
        if (providerId != null && !providerId.equals("")) {
            urlEncodedAuthnReq.append("ProviderID=").
                    append(URLEncDec.encode(providerId)).
                    append(IFSConstants.AMPERSAND);
        }

        if (relayState != null && relayState.length() > 0) {
            urlEncodedAuthnReq.append("RelayState=").
                    append(URLEncDec.encode(relayState)).
                    append(IFSConstants.AMPERSAND);
        }

        if (status != null) {
            urlEncodedAuthnReq.append("Value=");
            urlEncodedAuthnReq.append(
                    URLEncDec.encode(status.getStatusCode().getValue())).
                    append(IFSConstants.AMPERSAND);
        }

        return urlEncodedAuthnReq.toString();
    }


    /**
     * Returns <code>FSNameRegistrationLogoutResponse</code> object. The
     * object is creating by parsing the <code>HttpServletRequest</code>
     * object.
     *
     * @param request the <code>HttpServletRequest</code> object.
     * @throws FSMsgException if there is an error
     *         creating this object.
     */
    public static FSNameRegistrationResponse parseURLEncodedRequest(
            HttpServletRequest request) throws FSMsgException, SAMLException {
        FSNameRegistrationResponse retNameRegistrationResponse =
                new FSNameRegistrationResponse();
        try {
            FSUtils.debug.message("checking minor version");
            retNameRegistrationResponse.majorVersion =
                    Integer.parseInt(request.getParameter("MajorVersion"));
            retNameRegistrationResponse.minorVersion =
                    Integer.parseInt(request.getParameter("MinorVersion"));
        } catch(NumberFormatException ex){
            FSUtils.debug.error("FSNameRegistrationResponse.parseURL" +
                    "EncodedRequest: version parsing error:" + ex);
            throw new FSMsgException("invalidNumber",null);
        }

        if (request.getParameter("ResponseID")!= null) {
            retNameRegistrationResponse.responseID =
                    request.getParameter("ResponseID");
        } else {
            FSUtils.debug.error("FSNameRegistrationResponse.parseURL" +
                    "EncodedRequest: Response ID is null" );
            String[] args = { IFSConstants.RESPONSE_ID };
            throw new FSMsgException("missingAttribute",args);
        }

        String instantString = request.getParameter("IssueInstant");
        if (instantString == null || instantString.length() == 0) {
            FSUtils.debug.error("FSNameRegistrationResponse.parseURL" +
                    "EncodedRequest: Issue Instant is null" );
            String[] args = { IFSConstants.ISSUE_INSTANT };
            throw new FSMsgException("missingAttribute",args);
        }
        try{
            retNameRegistrationResponse.issueInstant =
                    DateUtils.stringToDate(instantString);
        } catch (ParseException e){
            FSUtils.debug.error("FSNameRegistrationResponse.parseURL" +
                    "EncodedRequest: Can not parse Issue Instant", e);
            throw new FSMsgException("parseError",null);
        }
        if (request.getParameter("ProviderID")!= null){
            retNameRegistrationResponse.providerId =
                    request.getParameter("ProviderID");
        } else {
            FSUtils.debug.error("FSNameRegistrationResponse.parseURL" +
                    "EncodedRequest: Provider ID is null " );
            throw new FSMsgException("missingElement",null);
        }

        if (request.getParameter("RelayState")!= null){
            retNameRegistrationResponse.relayState =
                    request.getParameter("RelayState");
        }
        if (request.getParameter("InResponseTo")!= null){
            retNameRegistrationResponse.inResponseTo =
                    request.getParameter("InResponseTo");
        }

        if (request.getParameter("Value") != null){
            FSUtils.debug.message("Status : " + request.getParameter("Value"));
            StatusCode statusCode =
                    new StatusCode(request.getParameter("Value"));
            retNameRegistrationResponse.status = new Status(statusCode);
        } else {
            FSUtils.debug.error("FSNameRegistrationResponse.parseURL" +
                    "EncodedRequest: Status Value is  null " );
            throw new FSMsgException("missingElement",null);
        }

        FSUtils.debug.message("Returning registration response Object");
        return retNameRegistrationResponse;
    }
}