com.mesosphere.sdk.config.validate

Class TaskEnvCannotChange

java.lang.Object

com.mesosphere.sdk.config.validate.TaskEnvCannotChange

All Implemented Interfaces:

ConfigValidator<ServiceSpec>

public class TaskEnvCannotChange
extends java.lang.Object
implements ConfigValidator<ServiceSpec>

Customizable configuration validator which requires that a specified task environment variable cannot be changed after initial deployment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TaskEnvCannotChange.Rule Variances to how enforcement should be performed.

Constructor Summary

Constructors

Constructor and Description
TaskEnvCannotChange(java.lang.String podType, java.lang.String taskName, java.lang.String envName, TaskEnvCannotChange.Rule... rules) Creates a new validator restricting changes to an environment value.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<ConfigValidationError>	validate(java.util.Optional<ServiceSpec> oldConfig, ServiceSpec newConfig) Returns List of ConfigurationValidationErrors for the newly supplied Configuration object.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskEnvCannotChange

public TaskEnvCannotChange(java.lang.String podType,
                           java.lang.String taskName,
                           java.lang.String envName,
                           TaskEnvCannotChange.Rule... rules)

Creates a new validator restricting changes to an environment value.

Parameters:

podType - The type of the pod to enforce (see PodSpec.getType())

taskName - The name of the task to enforce (see TaskSpec.getName())

envName - The environment variable to restrict within the above pod/task

rules - A list of any allowances to be made in the enforcement

Method Detail

validate

public java.util.Collection<ConfigValidationError> validate(java.util.Optional<ServiceSpec> oldConfig,
                                                            ServiceSpec newConfig)

Description copied from interface: ConfigValidator

Returns List of ConfigurationValidationErrors for the newly supplied Configuration object. A validation can validate a newConfig in following ways: 1. Validate newConfig parameters against the oldConfig paramater. Ex: If DiskType was ROOT in oldConfig, then it cannot be changed to, ex: MOUNT, in the newConfig. 2. Validate just newConfig parameter(s). Ex: CPU value > 0

Specified by:

validate in interface ConfigValidator<ServiceSpec>

Parameters:

oldConfig - Currently persisted Configuration, or an empty Optional if none is available (first launch of service)

newConfig - Proposed new Configuration

Returns:

List of errors, or an empty list if validation passed