/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */

package org.apache.synapse.config.xml;

import org.apache.axiom.om.OMComment;
import org.apache.axiom.om.OMElement;
import org.apache.axiom.om.OMNode;
import org.apache.synapse.Mediator;
import org.apache.synapse.SynapseConstants;
import org.apache.synapse.SynapseException;
import org.apache.synapse.config.SynapseConfiguration;
import org.apache.synapse.mediators.ListMediator;
import org.apache.synapse.mediators.builtin.CommentMediator;

import java.util.Iterator;
import java.util.Properties;

/**
 * This implements the basic logic to build a list mediator from a given XML
 * configuration. It recursively builds the child mediators of the list.
 */
public abstract class AbstractListMediatorFactory extends AbstractMediatorFactory {

    protected static void addChildren(OMElement el, ListMediator m, Properties properties) {
        Iterator it = el.getChildren();
        StringBuilder blockedMediators = null;

        while (it.hasNext()) {
            OMNode child = (OMNode) it.next();
            if (child instanceof OMElement) {
                if (!DESCRIPTION_Q.equals(((OMElement) child).getQName())) { // neglect the description tag
                    try {
                        SynapseConfiguration configuration = null;
                        if (properties != null) {
                            configuration = properties.get(SynapseConstants.SYNAPSE_CONFIGURATION) != null
                                    ? (SynapseConfiguration) properties.get(SynapseConstants.SYNAPSE_CONFIGURATION)
                                    : null;
                        }
                        Mediator med = MediatorFactoryFinder.getInstance().getMediator((OMElement) child, properties,
                                configuration);
                        if (med != null) {
                            m.addChild(med);
                        } else {
                            String msg = "Unknown mediator : " + ((OMElement) child).getLocalName();
                            log.error(msg);
                            throw new SynapseException(msg);
                        }
                    } catch (MediatorAccessControlException e) {
                        // Collect and continue to report all blocked mediators at once
                        if (blockedMediators == null) {
                            blockedMediators = new StringBuilder(e.getMediatorName());
                        } else {
                            blockedMediators.append(", ").append(e.getMediatorName());
                        }
                    }
                }
            } else if (child instanceof OMComment) {
                CommentMediator commendMediator = new CommentMediator();
                commendMediator.setCommentText(((OMComment) child).getValue());
                m.addChild(commendMediator);
            }
        }

        if (blockedMediators != null) {
            String msg = "Access control blocked for the following mediators: " + blockedMediators;
            log.error(msg);
            throw new SynapseException(msg);
        }
    }

    /**
     * Find and add all comment nodes to the parent mediator as Comment Mediators
     *
     * @param el OMElement to extract OMComment Nodes
     * @param m  Mediator to be updated with extracted OMComment nodes
     */
    protected static void addAllCommentChildrenToMediator(OMElement el, ListMediator m) {
        Iterator it = el.getChildren();

        while (it.hasNext()) {
            OMNode child = (OMNode) it.next();

            if (child instanceof OMComment) {
                CommentMediator commendMediator = new CommentMediator();
                commendMediator.setCommentText(((OMComment) child).getValue());
                m.addChild(commendMediator);
            }
        }
    }
}
