com.consol.citrus.validation.script

Class GroovyScriptMessageValidator

java.lang.Object

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

com.consol.citrus.validation.script.GroovyScriptMessageValidator

All Implemented Interfaces:

MessageValidator<ScriptValidationContext>

Direct Known Subclasses:

GroovyJsonMessageValidator, GroovyXmlMessageValidator

public class GroovyScriptMessageValidator
extends AbstractMessageValidator<ScriptValidationContext>

Groovy script message validator passing the message to a validation script. Tester needs to write validation code in Groovy. Available objects inside groovy script are 'receivedMessage' which is the actual Message object to validate and 'context' the current TestContext.

Author:

Christoph Deppisch

Constructor Summary

Constructors

Constructor and Description
GroovyScriptMessageValidator() Default constructor using default script template.
GroovyScriptMessageValidator(org.springframework.core.io.ClassPathResource scriptTemplateResource) Constructor setting the script template for this validator.

Method Summary

Modifier and Type	Method and Description
protected ScriptValidationContext	findValidationContext(List<ValidationContext> validationContexts) Finds the message validation context that is most appropriate for this validator implementation.
protected Class<ScriptValidationContext>	getRequiredValidationContextType() Provides class type of most appropriate validation context.
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, ScriptValidationContext validationContext) Validates message with most appropriate validation context.

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

validateMessage, validateMessageHeader, validateMessagePayload

Methods inherited from class java.lang.Object

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

Constructor Detail

GroovyScriptMessageValidator

public GroovyScriptMessageValidator()

Default constructor using default script template.

GroovyScriptMessageValidator

public GroovyScriptMessageValidator(org.springframework.core.io.ClassPathResource scriptTemplateResource)

Constructor setting the script template for this validator.

Parameters:

scriptTemplateResource - the script template to use in this validator.

Method Detail

validateMessage

public void validateMessage(Message receivedMessage,
                            Message controlMessage,
                            TestContext context,
                            ScriptValidationContext validationContext)
                     throws ValidationException

Description copied from class: AbstractMessageValidator

Validates message with most appropriate validation context.

Overrides:

validateMessage in class AbstractMessageValidator<ScriptValidationContext>

Throws:

ValidationException

findValidationContext

protected ScriptValidationContext findValidationContext(List<ValidationContext> validationContexts)

Description copied from class: AbstractMessageValidator

Finds the message validation context that is most appropriate for this validator implementation.

Overrides:

findValidationContext in class AbstractMessageValidator<ScriptValidationContext>

Returns:

getRequiredValidationContextType

protected Class<ScriptValidationContext> getRequiredValidationContextType()

Description copied from class: AbstractMessageValidator

Provides class type of most appropriate validation context.

Specified by:

getRequiredValidationContextType in class AbstractMessageValidator<ScriptValidationContext>

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.