Package org.citrusframework.validation.context

Class HeaderValidationContext

java.lang.Object

org.citrusframework.validation.context.HeaderValidationContext

All Implemented Interfaces:

ValidationContext

public class HeaderValidationContext
extends Object
implements ValidationContext

Since:

2.7.6

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HeaderValidationContext.Builder	Fluent builder.

Field Summary

Fields inherited from interface org.citrusframework.validation.context.ValidationContext

logger, RESOURCE_PATH, TYPE_RESOLVER

Constructor Summary

Constructors

Constructor	Description
HeaderValidationContext()
HeaderValidationContext(HeaderValidationContext.Builder builder)

Method Summary

Modifier and Type	Method	Description
void	addHeaderValidator(String validatorName)	Adds header validator reference.
void	addHeaderValidator(HeaderValidator validator)	Adds header validator.
ValidationStatus	getStatus()	Marks the validation result for this context.
List<String>	getValidatorNames()	Gets the validatorNames.
List<HeaderValidator>	getValidators()	Gets the validators.
boolean	isHeaderNameIgnoreCase()	Gets the headerNameIgnoreCase.
void	updateStatus(ValidationStatus status)	Update the validation status if it is allowed.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.citrusframework.validation.context.ValidationContext

requiresValidator

Constructor Details

HeaderValidationContext

public HeaderValidationContext()

HeaderValidationContext

public HeaderValidationContext(HeaderValidationContext.Builder builder)

Method Details

isHeaderNameIgnoreCase

public boolean isHeaderNameIgnoreCase()

Gets the headerNameIgnoreCase.

Returns:

addHeaderValidator

public void addHeaderValidator(HeaderValidator validator)

Adds header validator.

Parameters:

validator -

addHeaderValidator

public void addHeaderValidator(String validatorName)

Adds header validator reference.

Parameters:

validatorName -

getValidators

public List<HeaderValidator> getValidators()

Gets the validators.

Returns:

getValidatorNames

public List<String> getValidatorNames()

Gets the validatorNames.

Returns:

updateStatus

public void updateStatus(ValidationStatus status)

Description copied from interface: ValidationContext

Update the validation status if it is allowed.

Specified by:

updateStatus in interface ValidationContext

Parameters:

status - the new status.

getStatus

public ValidationStatus getStatus()

Description copied from interface: ValidationContext

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.

Specified by:

getStatus in interface ValidationContext

Returns:

the status indicating the validation result for this context.