Package org.citrusframework.validation.context

Interface ValidationContext

All Known Subinterfaces:

MessageValidationContext, ScriptValidationContext

All Known Implementing Classes:

DefaultMessageValidationContext, DefaultValidationContext, HeaderValidationContext

public interface ValidationContext

Basic validation context holding validation specific information.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ValidationContext.Builder<T extends ValidationContext,B extends ValidationContext.Builder<T,B>>	Fluent builder

Field Summary

Fields

Modifier and Type	Field	Description
static final org.slf4j.Logger	logger	Logger
static final String	RESOURCE_PATH	Endpoint builder resource lookup path
static final ResourcePathTypeResolver	TYPE_RESOLVER	Default Citrus validation context builders from classpath resource properties

Method Summary

Modifier and Type	Method	Description
default ValidationStatus	getStatus()	Marks the validation result for this context.
static Map<String,ValidationContext.Builder<?,?>>	lookup()	Resolves all available validation context builders from resource path lookup.
static Optional<ValidationContext.Builder<?,?>>	lookup(String builder)	Resolves validation context builder from resource path lookup with given resource name.
default boolean	requiresValidator()	Indicates whether this validation context requires a validator.
void	updateStatus(ValidationStatus status)	Update the validation status if it is allowed.

Field Details

logger

static final org.slf4j.Logger logger

Logger

RESOURCE_PATH

static final String RESOURCE_PATH

Endpoint builder resource lookup path

See Also:

• Constant Field Values

TYPE_RESOLVER

static final ResourcePathTypeResolver TYPE_RESOLVER

Default Citrus validation context builders from classpath resource properties

Method Details

requiresValidator

default boolean requiresValidator()

Indicates whether this validation context requires a validator.

Returns:

true if a validator is required; false otherwise.

updateStatus

void updateStatus(ValidationStatus status)

Update the validation status if it is allowed.

Parameters:

status - the new status.

getStatus

default ValidationStatus getStatus()

Marks the validation result for this context. By default, all validation context do have the status UNKNOWN marking that the validation has not performed yet. Validators must set proper status after the validation to mark the context as being processed.

Returns:

the status indicating the validation result for this context.

lookup

static Map<String,ValidationContext.Builder<?,?>> lookup()

Resolves all available validation context builders from resource path lookup. Scans classpath for validation context builder meta information and instantiates those builders.

lookup

static Optional<ValidationContext.Builder<?,?>> lookup(String builder)

Resolves validation context builder from resource path lookup with given resource name. Scans classpath for validation context builder meta information with given name and returns instance of the builder. Returns optional instead of throwing exception when no validation context builder could be found.

Given builder name is a combination of resource file name and type property separated by '.' character.