com.consol.citrus.validation.xml

Class DomXmlMessageValidator

java.lang.Object

com.consol.citrus.validation.AbstractMessageValidator<XmlMessageValidationContext>

com.consol.citrus.validation.xml.DomXmlMessageValidator

All Implemented Interfaces:

MessageValidator<XmlMessageValidationContext>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

XhtmlMessageValidator

public class DomXmlMessageValidator
extends AbstractMessageValidator<XmlMessageValidationContext>
implements org.springframework.context.ApplicationContextAware

Default message validator implementation. Working on XML messages providing message payload, header and namespace validation.

Since:

2007

Author:

Christoph Deppisch

Constructor Summary

Constructors

Constructor and Description
DomXmlMessageValidator()

Method Summary

Modifier and Type	Method and Description
void	addSchemaRepository(XsdSchemaRepository schemaRepository) Set the schema repository holding all known schema definition files.
protected Class<XmlMessageValidationContext>	getRequiredValidationContextType() Provides class type of most appropriate validation context.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
boolean	supportsMessageType(String messageType, Message message) Checks if this message validator is capable of this message type.
protected void	validateDTD(org.springframework.core.io.Resource dtdResource, Message receivedMessage) Validate message with a DTD.
protected void	validateMessageContent(Message receivedMessage, Message controlMessage, XmlMessageValidationContext validationContext, TestContext context) Validate message payloads by comparing to a control message.
void	validateMessagePayload(Message receivedMessage, Message controlMessage, XmlMessageValidationContext validationContext, TestContext context) Validates the message payload with comparison to the control message payload located in validation context.
protected void	validateNamespaces(Map<String,String> expectedNamespaces, Message receivedMessage) Validate namespaces in message.
protected void	validateXMLSchema(Message receivedMessage, XmlMessageValidationContext validationContext) Validate message with a XML schema.

Methods inherited from class com.consol.citrus.validation.AbstractMessageValidator

findValidationContext, validateMessage, validateMessage, validateMessageHeader

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DomXmlMessageValidator

public DomXmlMessageValidator()

Method Detail

validateMessagePayload

public void validateMessagePayload(Message receivedMessage,
                                   Message controlMessage,
                                   XmlMessageValidationContext validationContext,
                                   TestContext context)
                            throws ValidationException

Description copied from class: AbstractMessageValidator

Validates the message payload with comparison to the control message payload located in validation context.

Overrides:

validateMessagePayload in class AbstractMessageValidator<XmlMessageValidationContext>

Parameters:

receivedMessage - the received message to check.

controlMessage - the expected control message.

validationContext - the current validation context

context - the current test context with all variables.

Throws:

ValidationException

validateDTD

protected void validateDTD(org.springframework.core.io.Resource dtdResource,
                           Message receivedMessage)

Validate message with a DTD.

Parameters:

dtdResource -

receivedMessage -

validateXMLSchema

protected void validateXMLSchema(Message receivedMessage,
                                 XmlMessageValidationContext validationContext)

Validate message with a XML schema.

Parameters:

receivedMessage -

validationContext -

validateNamespaces

protected void validateNamespaces(Map<String,String> expectedNamespaces,
                                  Message receivedMessage)

Validate namespaces in message. The method compares namespace declarations in the root element of the received message to expected namespaces. Prefixes are important too, so differing namespace prefixes will fail the validation.

Parameters:

expectedNamespaces -

receivedMessage -

validateMessageContent

protected void validateMessageContent(Message receivedMessage,
                                      Message controlMessage,
                                      XmlMessageValidationContext validationContext,
                                      TestContext context)

Validate message payloads by comparing to a control message.

Parameters:

receivedMessage -

validationContext -

context -

getRequiredValidationContextType

protected Class<XmlMessageValidationContext> getRequiredValidationContextType()

Description copied from class: AbstractMessageValidator

Provides class type of most appropriate validation context.

Specified by:

getRequiredValidationContextType in class AbstractMessageValidator<XmlMessageValidationContext>

Returns:

supportsMessageType

public boolean supportsMessageType(String messageType,
                                   Message message)

Description copied from interface: MessageValidator

Checks if this message validator is capable of this message type. XML message validators may only apply to this message type while JSON message validator implementations do not and vice versa. This check is called by the MessageValidatorRegistry in order to find a proper message validator for a message.

Specified by:

supportsMessageType in interface MessageValidator<XmlMessageValidationContext>

Parameters:

messageType - the message type representation as String (e.g. xml, json, csv, plaintext).

message - the message object

Returns:

true if this message validator is capable of validating the message type.

addSchemaRepository

public void addSchemaRepository(XsdSchemaRepository schemaRepository)

Set the schema repository holding all known schema definition files.

Parameters:

schemaRepository - the schemaRepository to set

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException