org.apache.samza.rest.resources

Class BaseResourceConfig

java.lang.Object

org.apache.samza.config.Config

org.apache.samza.config.MapConfig

org.apache.samza.rest.resources.BaseResourceConfig

All Implemented Interfaces:

java.io.Serializable, java.util.Map<java.lang.String,java.lang.String>

Direct Known Subclasses:

JobsResourceConfig, TaskResourceConfig

public class BaseResourceConfig
extends org.apache.samza.config.MapConfig

This class contains the common configurations that are shared between different samza-rest resources.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIG_JOB_CONFIG_FACTORY Specifies the canonical name of the ConfigFactory to read the job configs.
static java.lang.String	CONFIG_JOB_INSTALLATIONS_PATH The path where all the Samza jobs are installed (unzipped).

Fields inherited from class org.apache.samza.config.Config

SENSITIVE_MASK, SENSITIVE_PREFIX

Constructor Summary

Constructors

Constructor and Description
BaseResourceConfig(org.apache.samza.config.Config config)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getInstallationsPath()
java.lang.String	getJobConfigFactory()

Methods inherited from class org.apache.samza.config.MapConfig

containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, sanitize, size, toString, values

Methods inherited from class org.apache.samza.config.Config

clear, get, getBoolean, getBoolean, getClass, getDate, getDate, getDate, getDate, getDate, getDate, getDouble, getDouble, getInt, getInt, getList, getList, getLong, getLong, getNewInstance, getShort, getShort, put, putAll, regexSubset, remove, replaceAll, subset, subset

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace

Field Detail

CONFIG_JOB_CONFIG_FACTORY

public static final java.lang.String CONFIG_JOB_CONFIG_FACTORY

Specifies the canonical name of the ConfigFactory to read the job configs.

See Also:

Constant Field Values

CONFIG_JOB_INSTALLATIONS_PATH

public static final java.lang.String CONFIG_JOB_INSTALLATIONS_PATH

The path where all the Samza jobs are installed (unzipped). Each subdirectory of this path is expected to be a Samza job installation and corresponds to one InstallationRecord.

See Also:

Constant Field Values

Constructor Detail

BaseResourceConfig

public BaseResourceConfig(org.apache.samza.config.Config config)

Method Detail

getInstallationsPath

public java.lang.String getInstallationsPath()

Returns:

the path where all the Samza jobs are installed (unzipped).

See Also:

CONFIG_JOB_INSTALLATIONS_PATH

getJobConfigFactory

public java.lang.String getJobConfigFactory()

Returns:

the config factory class that has to be used to parse job configurations. If the config key CONFIG_JOB_INSTALLATIONS_PATH is not defined, then returns the PropertiesConfigFactory class name.

See Also:

CONFIG_JOB_INSTALLATIONS_PATH