/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2017 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
 * or LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.xml.messaging.soap;

import java.util.Iterator;
import javax.xml.soap.*;

public class SOAPProcessorImpl extends SOAPProcessor {

    private String ultimateReceiverURL = 
        "http://schemas.xmlsoap.org/soap/actor/ultimateReceiver";

    /**
     * Implementation for SOAP 1.1
     */
    public SOAPMessage acceptMessage(SOAPMessage message) 
        throws SOAPException {

        SOAPHeader header = message.getSOAPHeader();
        Iterator headerElements = header.getChildElements();
        for (; headerElements.hasNext(); ) {
            SOAPHeaderElement elem = (SOAPHeaderElement)headerElements.next();
            String role = getRoleAttributeValue(elem);        
            boolean elementProcessed = false;
            boolean isTargeted = false;
            for (Iterator itr = recipients.iterator(); itr.hasNext(); ) {
                SOAPRecipient recp = (SOAPRecipient)itr.next();
                if (recp.supportsRole(role)) {
                    isTargeted = true; 
                    if (recp.supportsHeader(elem.getTagName())) {
                        recp.processHeaderElement(elem);
                        elementProcessed = true;
                    }
                }
            }
            if (!elementProcessed && isTargeted && elem.getMustUnderstand()) {
                // Generate FAULT
                generateFault(message, role);
            }
            if (isTargeted && !role.equals(ultimateReceiverURL))
                elem.detachNode();
        }
        message.saveChanges();
        return message;
    }

    public SOAPMessage prepareMessage(SOAPMessage message)
        throws SOAPException {

        SOAPHeader header = message.getSOAPHeader();
        for (Iterator it = annotators.iterator(); it.hasNext();) {
            SOAPAnnotator annotator = (SOAPAnnotator)it.next();    
            annotator.annotateHeader(header);
        }
        message.saveChanges();
        return message;    
    }

    /**
     * Implementation for SOAP 1.1
     * recognize both actor and role attributes ?
     */
    protected String getRoleAttributeValue(SOAPHeaderElement element) {
        String ret = element.getActor();
        // set it to ultimateReceiver ?
        if (ret.equals("") || ret == null)
            ret = ultimateReceiverURL;
        return ret;
    }

    private void generateFault(SOAPMessage message, String role)
        throws SOAPException {
        SOAPBody body = message.getSOAPBody();
        Iterator eachChild = body.getChildElements();
        while (eachChild.hasNext()) {
            SOAPBodyElement bodyElement = (SOAPBodyElement)eachChild.next();
            bodyElement.detachNode();
        }
        
        SOAPFault fault = body.addFault();
        String soapPrefix = body.getPrefix();
        fault.setFaultCode(soapPrefix + ":" + "mustUnderstand");
        fault.setFaultString("One or more mandatory SOAPHeader blocks " +
                             "not understood");
        fault.setFaultActor(role);
    }
}
