com.consol.citrus.validation.xml.XpathMessageValidationContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of citrus-base Show documentation
Citrus base and default implementation
There is a newer version: 3.4.1
/*
 * Copyright 2006-2015 the original author or authors.
 *
 * Licensed 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 com.consol.citrus.validation.xml;

import java.util.HashMap;
import java.util.Map;

import com.consol.citrus.builder.WithExpressions;
import org.springframework.util.StringUtils;

/**
 * Specialised Xml validation context adds XPath expression evaluation.
 * @author Christoph Deppisch
 * @since 2.3
 */
public class XpathMessageValidationContext extends XmlMessageValidationContext {

    /** Map holding xpath expressions as key and expected values as values */
    private final Map xPathExpressions;

    /**
     * Default constructor.
     */
    public XpathMessageValidationContext() {
        this(new Builder());
    }

    /**
     * Constructor using fluent builder.
     * @param builder
     */
    public XpathMessageValidationContext(Builder builder) {
        super(builder);
        this.xPathExpressions = builder.expressions;
    }

    /**
     * Fluent builder.
     */
    public static final class Builder extends XmlValidationContextBuilder
            implements WithExpressions {

        private final Map expressions = new HashMap<>();

        /**
         * Static entry method for fluent builder API.
         * @return
         */
        public static Builder xpath() {
            return new Builder();
        }

        @Override
        public Builder expressions(Map expressions) {
            this.expressions.putAll(expressions);
            return this;
        }

        @Override
        public Builder expression(final String expression, final Object value) {
            this.expressions.put(expression, value);
            return this;
        }

        @Override
        public XpathMessageValidationContext build() {
            return new XpathMessageValidationContext(this);
        }
    }

    /**
     * Get the control message elements that have to be present in
     * the received message. Message element values are compared as well.
     * @return the xPathExpressions
     */
    public Map getXpathExpressions() {
        return xPathExpressions;
    }

    /**
     * Check whether given path expression is a JSONPath expression.
     * @param pathExpression
     * @return
     */
    public static boolean isXpathExpression(String pathExpression) {
        return StringUtils.hasText(pathExpression) && (pathExpression.startsWith("/"));
    }
}