Package com.yahoo.config.application.api
Class ValidationOverrides
java.lang.Object
com.yahoo.config.application.api.ValidationOverrides
A set of allows which suppresses specific validations in limited time periods.
This is useful to be able to complete a deployment in cases where the application
owner believes that the changes to be deployed have acceptable consequences.
Immutable.
- Author:
- bratseth
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
A validation override which allows a particular change.static class
A deployment validation exception. -
Field Summary
-
Constructor Summary
ConstructorDescriptionValidationOverrides
(List<ValidationOverrides.Allow> overrides) Creates a validation overrides which does not have an xml form -
Method Summary
Modifier and TypeMethodDescriptionboolean
allows
(ValidationId validationId, Instant now) Returns whether the given (assumed invalid) change is allowed by this at the momentboolean
static ValidationOverrides
Returns a ValidationOverrides instance with the content of the given Reader.static ValidationOverrides
Returns a ValidationOverrides instance with the content of the given XML string.void
invalid
(ValidationId validationId, String message, Instant now) Throws a ValidationException unless this validation is overridden at this timevoid
invalid
(Map<ValidationId, ? extends Collection<String>> messagesByValidationId, Instant now) Throws a ValidationException unless all given validation is overridden at this timestatic String
boolean
Validates overrides (checks 'until' date')xmlForm()
Returns the XML form of this, or null if it was not created by fromXml, nor is empty
-
Field Details
-
empty
-
-
Constructor Details
-
ValidationOverrides
Creates a validation overrides which does not have an xml form
-
-
Method Details
-
invalid
public void invalid(Map<ValidationId, ? extends Collection<String>> messagesByValidationId, Instant now) Throws a ValidationException unless all given validation is overridden at this time -
invalid
Throws a ValidationException unless this validation is overridden at this time -
allows
-
allows
Returns whether the given (assumed invalid) change is allowed by this at the moment -
validate
Validates overrides (checks 'until' date') -
xmlForm
Returns the XML form of this, or null if it was not created by fromXml, nor is empty -
toAllowMessage
-
fromXml
Returns a ValidationOverrides instance with the content of the given Reader.- Parameters:
reader
- the reader containing a validation-overrides XML structure- Returns:
- a ValidationOverrides from the argument
- Throws:
IllegalArgumentException
- if the validation-allows.xml file exists but is invalid
-
fromXml
Returns a ValidationOverrides instance with the content of the given XML string. An empty ValidationOverrides is returned if the argument is empty.- Parameters:
xmlForm
- the string which optionally contains a validation-overrides XML structure- Returns:
- a ValidationOverrides from the argument
- Throws:
IllegalArgumentException
- if the validation-allows.xml file exists but is invalid
-