com.github.jcustenborder.kafka.connect.utils.config

Class ConfigUtils

java.lang.Object

com.github.jcustenborder.kafka.connect.utils.config.ConfigUtils

public class ConfigUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
ConfigUtils()

Method Summary

Modifier and Type	Method and Description
static Charset	charset(org.apache.kafka.common.config.AbstractConfig config, String key) Method is used to return a charset for a string key.
static List<Charset>	charsets(org.apache.kafka.common.config.AbstractConfig config, String key) Method is used to return a charset(s) for a list key.
static <T extends Enum<T>> String	enumDescription(Class<T> enumClass, T... excludes)
static <T extends Enum<T>> String	enumDescription(Map<T,String> descriptions)
static String	enumValues(Class<?> enumClass) Method is used to return the values for an enum.
static File	getAbsoluteFile(org.apache.kafka.common.config.AbstractConfig config, String key) Method is used to return a File checking to ensure that it is an absolute path.
static <T extends Enum<T>> T	getEnum(Class<T> enumClass, org.apache.kafka.common.config.AbstractConfig config, String key) Method is used to return an enum value from a given string.
static <T extends Enum<T>> List<T>	getEnums(Class<T> enumClass, org.apache.kafka.common.config.AbstractConfig config, String key) Method is used to return enums from a list.
static Set<String>	getSet(org.apache.kafka.common.config.AbstractConfig config, String key) Method is used to retrieve a list and convert it to an immutable set.
static com.google.common.net.HostAndPort	hostAndPort(org.apache.kafka.common.config.AbstractConfig config, String key) Method is used to parse a string ConfigDef item to a HostAndPort
static com.google.common.net.HostAndPort	hostAndPort(org.apache.kafka.common.config.AbstractConfig config, String key, Integer defaultPort) Method is used to parse a string ConfigDef item to a HostAndPort
static List<com.google.common.net.HostAndPort>	hostAndPorts(org.apache.kafka.common.config.AbstractConfig config, String key) Method is used to parse hosts and ports
static List<com.google.common.net.HostAndPort>	hostAndPorts(org.apache.kafka.common.config.AbstractConfig config, String key, Integer defaultPort) Method is used to parse a list ConfigDef item to a list of HostAndPort
static InetSocketAddress	inetSocketAddress(org.apache.kafka.common.config.AbstractConfig config, String key) Method is used to return an InetSocketAddress from a hostname:port string.
static List<InetSocketAddress>	inetSocketAddresses(org.apache.kafka.common.config.AbstractConfig config, String key) Method is used to return a list of InetSocketAddress from a config list of hostname:port strings.
static KeyManagerFactory	keyManagerFactory(org.apache.kafka.common.config.AbstractConfig config, String key) Method will create a KeyManagerFactory based on the Algorithm type specified in the config.
static KeyStore	keyStore(org.apache.kafka.common.config.AbstractConfig config, String key) Method will create a KeyStore based on the KeyStore type specified in the config.
static byte[]	passwordBytes(org.apache.kafka.common.config.AbstractConfig config, String key) Method is used to return an array of bytes representing the password stored in the config.
static byte[]	passwordBytes(org.apache.kafka.common.config.AbstractConfig config, String key, Charset charset) Method is used to return an array of bytes representing the password stored in the config.
static byte[]	passwordBytes(org.apache.kafka.common.config.AbstractConfig config, String key, String charset) Method is used to return an array of bytes representing the password stored in the config.
static char[]	passwordCharArray(org.apache.kafka.common.config.AbstractConfig config, String key) Method is used to return an array of characters representing the password stored in the config.
static Pattern	pattern(org.apache.kafka.common.config.AbstractConfig config, String key) Method is used to create a pattern based on the config element.
static SSLContext	sslContext(org.apache.kafka.common.config.AbstractConfig config, String key) Method will create a SSLContext based on the Algorithm type specified in the config.
static TrustManagerFactory	trustManagerFactory(org.apache.kafka.common.config.AbstractConfig config, String key) Method will create a TrustManagerFactory based on the Algorithm type specified in the config.
static URI	uri(org.apache.kafka.common.config.AbstractConfig config, String key) Method is used to retrieve a URI from a configuration key.
static List<URI>	uris(org.apache.kafka.common.config.AbstractConfig config, String key) Method is used to retrieve a list of URI(s) from a configuration key.
static URL	url(org.apache.kafka.common.config.AbstractConfig config, String key) Method is used to retrieve a URL from a configuration key.
static List<URL>	urls(org.apache.kafka.common.config.AbstractConfig config, String key) Method is used to retrieve a list of URL(s) from a configuration key.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigUtils

public ConfigUtils()

Method Detail

getEnum

public static <T extends Enum<T>> T getEnum(Class<T> enumClass,
                                            org.apache.kafka.common.config.AbstractConfig config,
                                            String key)

Method is used to return an enum value from a given string.

Type Parameters:

T - Enum class to return type for.

Parameters:

enumClass - Class for the resulting enum value

config - config to read the value from

key - key for the value

Returns:

enum value for the given key.

See Also:

Validators.validEnum(Class, Enum[])

getEnums

public static <T extends Enum<T>> List<T> getEnums(Class<T> enumClass,
                                                   org.apache.kafka.common.config.AbstractConfig config,
                                                   String key)

Method is used to return enums from a list.

Type Parameters:

T -

Parameters:

enumClass -

config -

key -

Returns:

See Also:

Validators.validEnum(Class, Enum[])

enumDescription

public static <T extends Enum<T>> String enumDescription(Class<T> enumClass,
                                                         T... excludes)

enumDescription

public static <T extends Enum<T>> String enumDescription(Map<T,String> descriptions)

enumValues

public static String enumValues(Class<?> enumClass)

Method is used to return the values for an enum.

Parameters:

enumClass - Enum class to return the constants for.

Returns:

Returns a comma separated string of all of the values in the enum.

getAbsoluteFile

public static File getAbsoluteFile(org.apache.kafka.common.config.AbstractConfig config,
                                   String key)

Method is used to return a File checking to ensure that it is an absolute path.

Parameters:

config - config to read the value from

key - key for the value

Returns:

File for the config value.

inetSocketAddress

public static InetSocketAddress inetSocketAddress(org.apache.kafka.common.config.AbstractConfig config,
                                                  String key)

Method is used to return an InetSocketAddress from a hostname:port string.

Parameters:

config - config to read the value from

key - key for the value

Returns:

InetSocketAddress for the supplied string.

inetSocketAddresses

public static List<InetSocketAddress> inetSocketAddresses(org.apache.kafka.common.config.AbstractConfig config,
                                                          String key)

Method is used to return a list of InetSocketAddress from a config list of hostname:port strings.

Parameters:

config - config to read the value from

key - key for the value

Returns:

List of InetSocketAddress for the supplied strings.

hostAndPort

public static com.google.common.net.HostAndPort hostAndPort(org.apache.kafka.common.config.AbstractConfig config,
                                                            String key,
                                                            Integer defaultPort)

Method is used to parse a string ConfigDef item to a HostAndPort

Parameters:

config - Config to read from

key - ConfigItem to get the host string from.

defaultPort - The default port to use if a port was not specified. Can be null.

Returns:

HostAndPort based on the ConfigItem.

hostAndPort

public static com.google.common.net.HostAndPort hostAndPort(org.apache.kafka.common.config.AbstractConfig config,
                                                            String key)

Method is used to parse a string ConfigDef item to a HostAndPort

Parameters:

config - Config to read from

key - ConfigItem to get the host string from.

Returns:

HostAndPort based on the ConfigItem.

hostAndPorts

public static List<com.google.common.net.HostAndPort> hostAndPorts(org.apache.kafka.common.config.AbstractConfig config,
                                                                   String key,
                                                                   Integer defaultPort)

Method is used to parse a list ConfigDef item to a list of HostAndPort

Parameters:

config - Config to read from

key - ConfigItem to get the host string from.

defaultPort - The default port to use if a port was not specified. Can be null.

Returns:

hostAndPorts

public static List<com.google.common.net.HostAndPort> hostAndPorts(org.apache.kafka.common.config.AbstractConfig config,
                                                                   String key)

Method is used to parse hosts and ports

Parameters:

config -

key -

Returns:

url

public static URL url(org.apache.kafka.common.config.AbstractConfig config,
                      String key)

Method is used to retrieve a URL from a configuration key.

Parameters:

config - Config to read

key - Key to read

Returns:

URL for the value.

urls

public static List<URL> urls(org.apache.kafka.common.config.AbstractConfig config,
                             String key)

Method is used to retrieve a list of URL(s) from a configuration key.

Parameters:

config - Config to read

key - Key to read

Returns:

URL for the value.

uri

public static URI uri(org.apache.kafka.common.config.AbstractConfig config,
                      String key)

Method is used to retrieve a URI from a configuration key.

Parameters:

config - Config to read

key - Key to read

Returns:

URI for the value.

uris

public static List<URI> uris(org.apache.kafka.common.config.AbstractConfig config,
                             String key)

Method is used to retrieve a list of URI(s) from a configuration key.

Parameters:

config - Config to read

key - Key to read

Returns:

URI for the value.

getSet

public static Set<String> getSet(org.apache.kafka.common.config.AbstractConfig config,
                                 String key)

Method is used to retrieve a list and convert it to an immutable set.

Parameters:

config - Config to read

key - Key to read

Returns:

ImmutableSet with the contents of the config key.

See Also:

ImmutableSet

pattern

public static Pattern pattern(org.apache.kafka.common.config.AbstractConfig config,
                              String key)

Method is used to create a pattern based on the config element.

Parameters:

config -

key -

Returns:

passwordBytes

public static byte[] passwordBytes(org.apache.kafka.common.config.AbstractConfig config,
                                   String key)

Method is used to return an array of bytes representing the password stored in the config.

Parameters:

config - Config to read from

key - Key to read from

Returns:

byte array containing the password

passwordBytes

public static byte[] passwordBytes(org.apache.kafka.common.config.AbstractConfig config,
                                   String key,
                                   String charset)

Method is used to return an array of bytes representing the password stored in the config.

Parameters:

config - Config to read from

key - Key to read from

charset - Charset to use

Returns:

byte array containing the password

passwordBytes

public static byte[] passwordBytes(org.apache.kafka.common.config.AbstractConfig config,
                                   String key,
                                   Charset charset)

Method is used to return an array of bytes representing the password stored in the config.

Parameters:

config - Config to read from

key - Key to read from

charset - Charset to use

Returns:

byte array containing the password

passwordCharArray

public static char[] passwordCharArray(org.apache.kafka.common.config.AbstractConfig config,
                                       String key)

Method is used to return an array of characters representing the password stored in the config.

Parameters:

config - Config to read from

key - Key to read from

Returns:

char array containing the password

keyStore

public static KeyStore keyStore(org.apache.kafka.common.config.AbstractConfig config,
                                String key)

Method will create a KeyStore based on the KeyStore type specified in the config.

Parameters:

config - Config to read from.

key - Key to read from

Returns:

KeyStore based on the type specified in the config.

keyManagerFactory

public static KeyManagerFactory keyManagerFactory(org.apache.kafka.common.config.AbstractConfig config,
                                                  String key)

Method will create a KeyManagerFactory based on the Algorithm type specified in the config.

Parameters:

config - Config to read from.

key - Key to read from

Returns:

KeyManagerFactory based on the type specified in the config.

trustManagerFactory

public static TrustManagerFactory trustManagerFactory(org.apache.kafka.common.config.AbstractConfig config,
                                                      String key)

Method will create a TrustManagerFactory based on the Algorithm type specified in the config.

Parameters:

config - Config to read from.

key - Key to read from

Returns:

TrustManagerFactory based on the type specified in the config.

sslContext

public static SSLContext sslContext(org.apache.kafka.common.config.AbstractConfig config,
                                    String key)

Method will create a SSLContext based on the Algorithm type specified in the config.

Parameters:

config - Config to read from.

key - Key to read from

Returns:

SSLContext based on the type specified in the config.

charset

public static Charset charset(org.apache.kafka.common.config.AbstractConfig config,
                              String key)

Method is used to return a charset for a string key.

Parameters:

config - Config to read from.

key - Key to read from

Returns:

charsets

public static List<Charset> charsets(org.apache.kafka.common.config.AbstractConfig config,
                                     String key)

Method is used to return a charset(s) for a list key.

Parameters:

config - Config to read from.

key - Key to read from

Returns: