com.consol.citrus.validation.xml.XmlMessageValidationContext Maven / Gradle / Ivy
/*
* Copyright 2006-2010 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.HashSet;
import java.util.Map;
import java.util.Set;
import com.consol.citrus.validation.context.DefaultValidationContext;
import com.consol.citrus.validation.context.SchemaValidationContext;
import com.consol.citrus.validation.context.ValidationContext;
import org.springframework.core.io.Resource;
/**
* XML validation context holding validation specific information needed for XML
* message validation.
*
* @author Christoph Deppisch
*/
public class XmlMessageValidationContext extends DefaultValidationContext implements SchemaValidationContext {
/** Map holding xpath expressions to identify the ignored message elements */
private final Set ignoreExpressions;
/** Namespace definitions resolving namespaces in XML message validation */
private final Map namespaces;
/** dtdResource for DTD validation */
private final Resource dtdResource;
/** Map holding control namespaces for validation */
private final Map controlNamespaces;
/** Should message be validated with its schema definition */
private final boolean schemaValidation;
/** Explicit schema repository to use for this validation */
private final String schemaRepository;
/** Explicit schema instance to use for this validation */
private final String schema;
/**
* Default constructor.
*/
public XmlMessageValidationContext() {
this(new Builder());
}
/**
* Constructor using fluent builder.
* @param builder
*/
public XmlMessageValidationContext(XmlValidationContextBuilder builder) {
this.ignoreExpressions = builder.ignoreExpressions;
this.namespaces = builder.namespaces;
this.controlNamespaces = builder.controlNamespaces;
this.dtdResource = builder.dtdResource;
this.schemaValidation = builder.schemaValidation;
this.schemaRepository = builder.schemaRepository;
this.schema = builder.schema;
}
/**
* Fluent builder.
*/
public static final class Builder extends XmlValidationContextBuilder {
/**
* Static entry method for fluent builder API.
* @return
*/
public static Builder xml() {
return new Builder();
}
/**
* Convert to Xpath message validation context builder.
* @return
*/
public XpathMessageValidationContext.Builder xpath() {
return new XpathMessageValidationContext.Builder()
.namespaceContext(namespaces)
.namespaces(controlNamespaces)
.schemaValidation(schemaValidation)
.schemaRepository(schemaRepository)
.schema(schema)
.dtd(dtdResource)
.ignore(ignoreExpressions);
}
@Override
public XmlMessageValidationContext build() {
return new XmlMessageValidationContext(this);
}
}
/**
* Base fluent builder for XML validation contexts.
*/
public static abstract class XmlValidationContextBuilder>
implements ValidationContext.Builder>, XmlNamespaceAware, SchemaValidationContext.Builder> {
protected final S self;
protected final Set ignoreExpressions = new HashSet<>();
protected Map namespaces = new HashMap<>();
protected Resource dtdResource;
protected final Map controlNamespaces = new HashMap<>();
protected boolean schemaValidation = true;
protected String schemaRepository;
protected String schema;
protected XmlValidationContextBuilder() {
this.self = (S) this;
}
/**
* Sets schema validation enabled/disabled for this message.
*
* @param enabled
* @return
*/
public S schemaValidation(final boolean enabled) {
this.schemaValidation = enabled;
return self;
}
/**
* Validates XML namespace with prefix and uri.
*
* @param prefix
* @param namespaceUri
* @return
*/
public S namespace(final String prefix, final String namespaceUri) {
this.controlNamespaces.put(prefix, namespaceUri);
return self;
}
/**
* Validates XML namespace with prefix and uri.
*
* @param namespaces
* @return
*/
public S namespaces(final Map namespaces) {
this.controlNamespaces.putAll(namespaces);
return self;
}
/**
* Add namespaces as context to the expression evaluation. Keys are prefixes and values are namespace URIs.
*
* @param prefix
* @param namespaceUri
* @return
*/
public S namespaceContext(final String prefix, final String namespaceUri) {
this.namespaces.put(prefix, namespaceUri);
return self;
}
/**
* Add namespaces as context to the expression evaluation. Keys are prefixes and values are namespace URIs.
*
* @param namespaces
* @return
*/
public S namespaceContext(final Map namespaces) {
this.namespaces.putAll(namespaces);
return self;
}
/**
* Sets explicit schema instance name to use for schema validation.
*
* @param schemaName
* @return
*/
public S schema(final String schemaName) {
this.schema = schemaName;
return self;
}
/**
* Sets explicit xsd schema repository instance to use for validation.
*
* @param schemaRepository
* @return
*/
public S schemaRepository(final String schemaRepository) {
this.schemaRepository = schemaRepository;
return self;
}
/**
* Sets explicit DTD resource to use for validation.
*
* @param dtdResource
* @return
*/
public S dtd(final Resource dtdResource) {
this.dtdResource = dtdResource;
return self;
}
/**
* Adds ignore path expression for message element.
*
* @param path
* @return
*/
public S ignore(final String path) {
this.ignoreExpressions.add(path);
return self;
}
/**
* Adds a list of ignore path expressions for message element.
*
* @param paths
* @return
*/
public S ignore(final Set paths) {
this.ignoreExpressions.addAll(paths);
return self;
}
@Override
public void setNamespaces(Map namespaces) {
this.namespaces = namespaces;
}
}
/**
* Get ignored message elements.
* @return the ignoreExpressions
*/
public Set getIgnoreExpressions() {
return ignoreExpressions;
}
/**
* Get the namespace definitions for this validator.
* @return the namespaceContext
*/
public Map getNamespaces() {
return namespaces;
}
/**
* Get the dtd resource.
* @return the dtdResource
*/
public Resource getDTDResource() {
return dtdResource;
}
/**
* Get control namespace elements.
* @return the controlNamespaces
*/
public Map getControlNamespaces() {
return controlNamespaces;
}
@Override
public boolean isSchemaValidationEnabled() {
return schemaValidation;
}
@Override
public String getSchemaRepository() {
return schemaRepository;
}
@Override
public String getSchema() {
return schema;
}
}