com.consol.citrus.validation.json

Class JsonTextMessageValidator

java.lang.Object

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

com.consol.citrus.validation.json.JsonTextMessageValidator

All Implemented Interfaces:

MessageValidator<JsonMessageValidationContext>

public class JsonTextMessageValidator
extends AbstractMessageValidator<JsonMessageValidationContext>

This message validator implementation is able to validate two JSON text objects. The order of JSON entries can differ as specified in JSON protocol. Tester defines an expected control JSON text with optional ignored entries. JSONArray as well as nested JSONObjects are supported, too. Validator offers two different modes to operate. By default strict mode is set and the validator will also check the exact amount of control object fields to match. No additional fields in received JSON data structure will be accepted. In soft mode validator allows additional fields in received JSON data structure so the control JSON object can be a partial subset.

Author:

Christoph Deppisch

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
JsonTextMessageValidator()

Method Summary

Modifier and Type	Method and Description
protected Class<JsonMessageValidationContext>	getRequiredValidationContextType() Provides class type of most appropriate validation context.
boolean	isIgnored(Map.Entry controlJsonEntry, Object receivedJson, Set<String> ignoreExpressions, com.jayway.jsonpath.ReadContext readContext) Checks if given element node is either on ignore list or contains @ignore@ tag inside control message
void	setStrict(boolean strict) Set the validator strict mode.
JsonTextMessageValidator	strict(boolean strict) Set the validator strict mode.
boolean	supportsMessageType(String messageType, Message message) Checks if this message validator is capable of this message type.
void	validateJson(net.minidev.json.JSONObject receivedJson, net.minidev.json.JSONObject controlJson, JsonMessageValidationContext validationContext, TestContext context, com.jayway.jsonpath.ReadContext readContext) Validates JSON text with comparison to expected control JSON object.
void	validateMessagePayload(Message receivedMessage, Message controlMessage, JsonMessageValidationContext validationContext, TestContext context) Validates the message payload with comparison to the control message payload located in validation context.

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

JsonTextMessageValidator

public JsonTextMessageValidator()

Method Detail

validateMessagePayload

public void validateMessagePayload(Message receivedMessage,
                                   Message controlMessage,
                                   JsonMessageValidationContext 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<JsonMessageValidationContext>

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

validateJson

public void validateJson(net.minidev.json.JSONObject receivedJson,
                         net.minidev.json.JSONObject controlJson,
                         JsonMessageValidationContext validationContext,
                         TestContext context,
                         com.jayway.jsonpath.ReadContext readContext)

Validates JSON text with comparison to expected control JSON object. JSON entries can be ignored with ignore placeholder.

Parameters:

receivedJson - the received JSON text object.

controlJson - the expected control JSON text.

validationContext - the JSON message validation context.

context - the current test context.

readContext - the JSONPath read context.

isIgnored

public boolean isIgnored(Map.Entry controlJsonEntry,
                         Object receivedJson,
                         Set<String> ignoreExpressions,
                         com.jayway.jsonpath.ReadContext readContext)

Checks if given element node is either on ignore list or contains @ignore@ tag inside control message

Parameters:

controlJsonEntry -

receivedJson -

ignoreExpressions -

readContext -

Returns:

getRequiredValidationContextType

protected Class<JsonMessageValidationContext> getRequiredValidationContextType()

Description copied from class: AbstractMessageValidator

Provides class type of most appropriate validation context.

Specified by:

getRequiredValidationContextType in class AbstractMessageValidator<JsonMessageValidationContext>

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.

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.

setStrict

public void setStrict(boolean strict)

Set the validator strict mode.

Parameters:

strict -

strict

public JsonTextMessageValidator strict(boolean strict)

Set the validator strict mode.

Parameters:

strict -

Returns:

this object for chaining