Package org.apache.flink.cdc.common.factories

Class FactoryHelper

java.lang.Object

org.apache.flink.cdc.common.factories.FactoryHelper

@PublicEvolving
public class FactoryHelper
extends Object

A helper for working with Factory.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FactoryHelper.DefaultContext	Default implementation of Factory.Context.

Method Summary

Modifier and Type	Method	Description
static FactoryHelper	createFactoryHelper(Factory factory, Factory.Context context)
org.apache.flink.configuration.ReadableConfig	getFormatConfig(String formatPrefix)
void	validate()	Validates the options of the factory.
void	validateExcept(String... prefixesToSkip)	Validates the options of the factory.
static void	validateFactoryOptions(Set<ConfigOption<?>> requiredOptions, Set<ConfigOption<?>> optionalOptions, Configuration configuration)	Validates the required options and optional options.
static void	validateFactoryOptions(Factory factory, Configuration configuration)	Validates the required and optional ConfigOptions of a factory.
static void	validateUnconsumedKeys(String factoryIdentifier, Set<String> allOptionKeys, Set<String> consumedOptionKeys)	Validates unconsumed option keys.

Methods inherited from class java.lang.Object

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

Method Detail

createFactoryHelper

public static FactoryHelper createFactoryHelper(Factory factory,
                                                Factory.Context context)

validateFactoryOptions

public static void validateFactoryOptions(Factory factory,
                                          Configuration configuration)

Validates the required and optional ConfigOptions of a factory.

Note: It does not check for left-over options.

validateFactoryOptions

public static void validateFactoryOptions(Set<ConfigOption<?>> requiredOptions,
                                          Set<ConfigOption<?>> optionalOptions,
                                          Configuration configuration)

Validates the required options and optional options.

Note: It does not check for left-over options.

validateUnconsumedKeys

public static void validateUnconsumedKeys(String factoryIdentifier,
                                          Set<String> allOptionKeys,
                                          Set<String> consumedOptionKeys)

Validates unconsumed option keys.

validate

public void validate()

Validates the options of the factory. It checks for unconsumed option keys.

validateExcept

public void validateExcept(String... prefixesToSkip)

Validates the options of the factory. It checks for unconsumed option keys while ignoring the options with given prefixes.

The option keys that have given prefix prefixToSkip would just be skipped for validation.

Parameters:

prefixesToSkip - Set of option key prefixes to skip validation

getFormatConfig

public org.apache.flink.configuration.ReadableConfig getFormatConfig(String formatPrefix)