org.apache.samza.rest

Class SamzaRestConfig

java.lang.Object

org.apache.samza.config.Config

org.apache.samza.config.MapConfig

org.apache.samza.rest.SamzaRestConfig

All Implemented Interfaces:

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

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

The set of configurations required by the core components of the SamzaRestService. Other configurations (e.g. from JobConfig) may also be used by some of the implementation classes.

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_REST_RESOURCE_CLASSES Specifies a comma-delimited list of class names of resources to register with the server.
static java.lang.String	CONFIG_REST_RESOURCE_FACTORIES Specifies a comma-delimited list of class names that implement ResourceFactory.
static java.lang.String	CONFIG_SAMZA_REST_SERVICE_PORT The port number to use for the HTTP server or 0 to dynamically choose a port.

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

SENSITIVE_MASK, SENSITIVE_PREFIX

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	getPort()
java.util.List<java.lang.String>	getResourceClassNames()
java.util.List<java.lang.String>	getResourceFactoryClassNames()

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, 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, replaceAll

Field Detail

CONFIG_REST_RESOURCE_FACTORIES

public static final java.lang.String CONFIG_REST_RESOURCE_FACTORIES

Specifies a comma-delimited list of class names that implement ResourceFactory. These factories will be used to create specific instances of resources, passing the server config.

See Also:

Constant Field Values

CONFIG_REST_RESOURCE_CLASSES

public static final java.lang.String CONFIG_REST_RESOURCE_CLASSES

Specifies a comma-delimited list of class names of resources to register with the server.

See Also:

Constant Field Values

CONFIG_SAMZA_REST_SERVICE_PORT

public static final java.lang.String CONFIG_SAMZA_REST_SERVICE_PORT

The port number to use for the HTTP server or 0 to dynamically choose a port.

See Also:

Constant Field Values

Constructor Detail

SamzaRestConfig

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

Method Detail

getPort

public int getPort()

Returns:

the port number to use for the HTTP server or 0 to dynamically choose a port.

See Also:

CONFIG_SAMZA_REST_SERVICE_PORT

getResourceFactoryClassNames

public java.util.List<java.lang.String> getResourceFactoryClassNames()

Returns:

a list of class names as Strings corresponding to factories that Samza REST should use to instantiate and register resources or an empty list if none were configured.

See Also:

CONFIG_REST_RESOURCE_FACTORIES

getResourceClassNames

public java.util.List<java.lang.String> getResourceClassNames()

Returns:

a list of class names as Strings corresponding to resource classes that Samza REST should register or an empty list if none were configured.

See Also:

CONFIG_REST_RESOURCE_CLASSES