# XQueryMediatorFactory.java

    /*
     *  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.mediators.xquery;

    import net.sf.saxon.s9api.ItemType;
    import net.sf.saxon.s9api.XdmNodeKind;
    import org.apache.axiom.om.OMAttribute;
    import org.apache.axiom.om.OMElement;
    import org.apache.commons.logging.Log;
    import org.apache.commons.logging.LogFactory;
    import org.apache.synapse.Mediator;
    import org.apache.synapse.util.xpath.SynapseXPath;
    import org.apache.synapse.config.xml.*;
    import org.jaxen.JaxenException;
    import org.apache.synapse.mediators.Value;
    import org.apache.synapse.config.xml.ValueFactory;

    import javax.xml.namespace.QName;
    import java.util.Iterator;
    import java.util.Properties;

    /**
     * Creates a XQuery mediator from the given XML
     * <p/>
     * <pre>
     * &lt;xquery key="string" [target="xpath"]&gt;
     *   &lt;variable name="string" type="string" [key="string"] [expression="xpath"]
     *      [value="string"]/&gt;?
     * &lt;/xquery&gt;
     * </pre>
     */

    public class XQueryMediatorFactory extends AbstractMediatorFactory {

        private static final Log log = LogFactory.getLog(XQueryMediatorFactory.class);

        private static final QName TAG_NAME
                = new QName(XMLConfigConstants.SYNAPSE_NAMESPACE, "xquery");
        public static final QName ATT_NAME_Q = new QName(XMLConfigConstants.NULL_NAMESPACE, "name");
        public static final QName ATT_VALUE_Q = new QName(XMLConfigConstants.NULL_NAMESPACE, "value");
        public static final QName ATT_EXPR_Q = new QName(XMLConfigConstants.NULL_NAMESPACE, "expression");
        public static final QName ATT_KEY_Q = new QName(XMLConfigConstants.NULL_NAMESPACE, "key");
        public static final QName ATT_TYPE_Q = new QName(XMLConfigConstants.NULL_NAMESPACE, "type");

        public Mediator createSpecificMediator(OMElement elem, Properties properties) {

            XQueryMediator xQueryMediator = new XQueryMediator();
            OMAttribute xqueryKey = elem.getAttribute(new QName(XMLConfigConstants.NULL_NAMESPACE,
                    "key"));
            OMAttribute attrTarget = elem.getAttribute(new QName(XMLConfigConstants.NULL_NAMESPACE,
                    "target"));
            if (xqueryKey != null) {
                // KeyFactory for creating dynamic or static Key
                ValueFactory keyFac = new ValueFactory();
                // create dynamic or static key based on OMElement
                Value generatedKey = keyFac.createValue(XMLConfigConstants.KEY, elem);

                if (generatedKey != null) {
                    if (generatedKey.getKeyValue() != null && !generatedKey.hasExprTypeKey()){
                        generatedKey = new Value(
                                FactoryUtils.prependArtifactIdentifierToFileName(xqueryKey.getAttributeValue(), properties));
                    }
                    // set generated key as the Key
                    xQueryMediator.setQueryKey(generatedKey);
                } else {
                    handleException("The 'key' attribute is required for the XQuery mediator");
                }
            } else {
                handleException("The 'key' attribute is required for the XQuery mediator");
            }
            if (attrTarget != null) {
                String targetValue = attrTarget.getAttributeValue();
                if (targetValue != null && !"".equals(targetValue)) {
                    try {
                        xQueryMediator.setTarget(SynapseXPathFactory.getSynapseXPath(elem, ATT_TARGET));
                    } catch (JaxenException e) {
                        handleException("Invalid XPath specified for the target attribute : " +
                                targetValue);
                    }
                }
            }
            // after successfully creating the mediator
            // set its common attributes such as tracing etc
            processAuditStatus(xQueryMediator, elem);
            OMElement dataSource = elem.getFirstChildWithName(
                    new QName(XMLConfigConstants.SYNAPSE_NAMESPACE, "dataSource"));
            if (dataSource != null) {
                xQueryMediator.addAllDataSourceProperties(
                        MediatorPropertyFactory.getMediatorProperties(dataSource));
            }

            Iterator it = elem.getChildrenWithName(new QName(XMLConfigConstants.SYNAPSE_NAMESPACE,
                    "variable"));
            while (it.hasNext()) {
                OMElement variableOM = (OMElement) it.next();
                String name = variableOM.getAttributeValue(ATT_NAME_Q);
                if (name != null && !"".equals(name)) {
                    String type = variableOM.getAttributeValue(ATT_TYPE_Q);
                    if (type != null && !"".equals(type)) {
                        String value = variableOM.getAttributeValue(ATT_VALUE_Q);
                        MediatorVariable variable;
                        if (value != null && !"".equals(value)) {
                            variable = new MediatorBaseVariable(
                                    new QName(name.trim()));
                            variable.setValue(value.trim());
                        } else {
                            String key = variableOM.getAttributeValue(ATT_KEY_Q);
                            String expr = variableOM.getAttributeValue(ATT_EXPR_Q);
                            variable = new MediatorCustomVariable(
                                    new QName(name.trim()));
                            if (key != null) {
                                ((MediatorCustomVariable) variable).setRegKey(
                                        FactoryUtils.prependArtifactIdentifierToFileName(key.trim(), properties));
                            }
                            if (expr != null && !"".equals(expr)) {
                                try {
                                    SynapseXPath xpath = new SynapseXPath(expr);
                                    OMElementUtils.addNameSpaces(xpath, variableOM, log);
                                    ((MediatorCustomVariable) variable).setExpression(xpath);

                                } catch (JaxenException e) {
                                    handleException("Invalid XPath specified for" +
                                            " the expression attribute : " + expr);
                                }
                            }
                        }
                        if ("INT".equals(type.trim())) {
                            variable.setType(ItemType.INT);
                        } else if ("INTEGER".equals(type.trim())) {
                            variable.setType(ItemType.INTEGER);
                        } else if ("BOOLEAN".equals(type.trim())) {
                            variable.setType(ItemType.BOOLEAN);
                        } else if ("BYTE".equals(type.trim())) {
                            variable.setType(ItemType.BYTE);
                        } else if ("DOUBLE".equals(type.trim())) {
                            variable.setType(ItemType.DOUBLE);
                        } else if ("SHORT".equals(type.trim())) {
                            variable.setType(ItemType.SHORT);
                        } else if ("LONG".equals(type.trim())) {
                            variable.setType(ItemType.LONG);
                        } else if ("FLOAT".equals(type.trim())) {
                            variable.setType(ItemType.FLOAT);
                        } else if ("STRING".equals(type.trim())) {
                            variable.setType(ItemType.STRING);
                        } else if ("DOCUMENT".equals(type.trim())) {
                            variable.setNodeKind(XdmNodeKind.DOCUMENT);
                        } else if ("ELEMENT".equals(type.trim())) {
                            variable.setNodeKind(XdmNodeKind.ELEMENT);
                        } else {
                            handleException("Unsupported Type");
                        }
                        xQueryMediator.addVariable(variable);
                    }
                }
            }

            addAllCommentChildrenToList(elem, xQueryMediator.getCommentsList());

            return xQueryMediator;
        }

        public QName getTagQName() {
            return TAG_NAME;
        }

    }