org.apache.gobblin.broker

Class SharedResourcesBrokerFactory

java.lang.Object

org.apache.gobblin.broker.SharedResourcesBrokerFactory

public class SharedResourcesBrokerFactory
extends Object

Used to create a default implementation of SharedResourcesBroker. All SharedResourcesBrokers created by this factory automatically load a set of configurations. In order of preference: * Programmatically supplied configurations in createDefaultTopLevelBroker(Config, ScopeInstance). * Configurations in a broker configuration resource. The default path of the resource is DEFAULT_BROKER_CONF_FILE, but its path can be overriden with BROKER_CONF_FILE_KEY either in programmatically supplied configurations, java properties, or environment variables. * Java properties of the current JVM. * Environment variables of the current shell. * Hadoop configuration obtained via Configuration.Configuration(). This can be disabled setting LOAD_HADOOP_CONFIGURATION to false.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BROKER_CONF_FILE_KEY
static String	DEFAULT_BROKER_CONF_FILE
static String	LOAD_HADOOP_CONFIGURATION

Constructor Summary

Constructors

Constructor and Description
SharedResourcesBrokerFactory()

Method Summary

Modifier and Type	Method and Description
static <S,T> void	addBrokerKeys(Map<String,String> configMap, Iterable<Map.Entry<S,T>> entries)
static <S extends ScopeType<S>> SharedResourcesBrokerImpl<S>	createDefaultTopLevelBroker(com.typesafe.config.Config config, ScopeInstance<S> globalScope) Create a root SharedResourcesBroker.
static SharedResourcesBroker<?>	getImplicitBroker() Get the implicit SharedResourcesBroker in the callers thread.
static void	registerImplicitBroker(SharedResourcesBroker<?> broker) Register a SharedResourcesBroker to be used as the implicit broker for this and all new children threads.

Methods inherited from class java.lang.Object

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

Field Detail

LOAD_HADOOP_CONFIGURATION

public static final String LOAD_HADOOP_CONFIGURATION

See Also:

Constant Field Values

BROKER_CONF_FILE_KEY

public static final String BROKER_CONF_FILE_KEY

See Also:

Constant Field Values

DEFAULT_BROKER_CONF_FILE

public static final String DEFAULT_BROKER_CONF_FILE

See Also:

Constant Field Values

Constructor Detail

SharedResourcesBrokerFactory

public SharedResourcesBrokerFactory()

Method Detail

createDefaultTopLevelBroker

public static <S extends ScopeType<S>> SharedResourcesBrokerImpl<S> createDefaultTopLevelBroker(com.typesafe.config.Config config,
                                                                                                ScopeInstance<S> globalScope)

Create a root SharedResourcesBroker. Subscoped brokers should be built using SharedResourcesBroker.newSubscopedBuilder(ScopeInstance). In general, this method will be called only once per application, and all other brokers will Nbe children of the root application broker.

Type Parameters:

S - The ScopeType DAG used for this broker tree.

Parameters:

config - The global configuration of the broker.

globalScope - The scope of the root broker.

getImplicitBroker

public static SharedResourcesBroker<?> getImplicitBroker()

Get the implicit SharedResourcesBroker in the callers thread. This is either a singleton broker configured from environment variables, java options, and classpath configuration options, or a specific broker injected elsewhere in the application. In general, it is preferable to explicitly pass around SharedResourcesBrokers, as that allows better control over the scoping. However, in cases where it is hard to do so, this method provides an alternative to method of acquiring a configured broker.

registerImplicitBroker

public static void registerImplicitBroker(SharedResourcesBroker<?> broker)

Register a SharedResourcesBroker to be used as the implicit broker for this and all new children threads.

addBrokerKeys

public static <S,T> void addBrokerKeys(Map<String,String> configMap,
                                       Iterable<Map.Entry<S,T>> entries)