com.consol.citrus.validation

Interface MessageValidator<T extends ValidationContext>

All Known Implementing Classes:

AbstractMessageValidator, DefaultMessageValidator, DomXmlMessageValidator, GroovyJsonMessageValidator, GroovyScriptMessageValidator, GroovyXmlMessageValidator, JsonPathMessageValidator, JsonTextMessageValidator, PlainTextMessageValidator, XhtmlMessageValidator, XpathMessageValidator

public interface MessageValidator<T extends ValidationContext>

Message validator interface. Message validation need specific information like control messages or validation scripts. These validation specific information is stored in a validation context, which is passed to the validation method.

Author:

Christoph Deppisch

Method Summary

Modifier and Type	Method and Description
boolean	supportsMessageType(String messageType, Message message) Checks if this message validator is capable of this message type.
void	validateMessage(Message receivedMessage, Message controlMessage, TestContext context, List<ValidationContext> validationContexts) Validates a message with given test context and validation context.

Method Detail

validateMessage

void validateMessage(Message receivedMessage,
                     Message controlMessage,
                     TestContext context,
                     List<ValidationContext> validationContexts)
              throws ValidationException

Validates a message with given test context and validation context.

Parameters:

receivedMessage - the message to validate.

controlMessage - the expected control message.

context - the current test context.

validationContexts - list of available validation contexts.

Throws:

ValidationException

supportsMessageType

boolean supportsMessageType(String messageType,
                            Message message)

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.

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.