com.linkedin.feathr.core.configvalidator

Interface ConfigValidator

All Known Implementing Classes:

FeatureConsumerConfValidator, FeatureProducerConfValidator, TypesafeConfigValidator

public interface ConfigValidator

Validates Frame configuration such as FeatureDef config, Join config, etc. Provides capability to perform both syntactic and semantic validations.

Method Summary

Modifier and Type	Method and Description
static ConfigValidator	getInstance() Deprecated. please use {getInstance(ClientType)} instead
static ConfigValidator	getInstance(ClientType clientType) Factory method to get an instance of ConfigValidator
ValidationResult	validate(ConfigType configType, ValidationType validationType, ConfigDataProvider configDataProvider) Validates the configuration.
java.util.Map<ConfigType,ValidationResult>	validate(java.util.Map<ConfigType,ConfigDataProvider> configTypeWithDataProvider, ValidationType validationType) Validates multiple Frame configuration types individually.

Method Detail

validate

ValidationResult validate(ConfigType configType,
                          ValidationType validationType,
                          ConfigDataProvider configDataProvider)

Validates the configuration. Configuration type is provided by ConfigType, the validation to be performed (for example, syntactic) is provided by ValidationType, and the configuration to be validated is provided by ConfigDataProvider. Note that the client is responsible for closing the ConfigDataProvider resource.

Parameters:

configType - ConfigType

validationType - ValidationType

configDataProvider - ConfigDataProvider

Returns:

ValidationResult

Throws:

ConfigValidationException - if validation can't be performed

validate

java.util.Map<ConfigType,ValidationResult> validate(java.util.Map<ConfigType,ConfigDataProvider> configTypeWithDataProvider,
                                                    ValidationType validationType)

Validates multiple Frame configuration types individually. Note that the client is responsible for closing the ConfigDataProvider resources.

Parameters:

configTypeWithDataProvider - Provides a K-V pair of ConfigType and ConfigDataProvider

validationType - The validation to be performed ValidationType

Returns:

Map of ConfigType and the ValidationResult

Throws:

ConfigValidationException - if validation can't be performed

getInstance

@Deprecated
static ConfigValidator getInstance()

Deprecated. please use {getInstance(ClientType)} instead

Factory method to get an instance of ConfigValidator

Returns:

an instance of ConfigValidator

getInstance

static ConfigValidator getInstance(ClientType clientType)

Factory method to get an instance of ConfigValidator

Parameters:

clientType - the Frame client type ClientType

Returns:

an instance of ConfigValidator