org.apache.gobblin.broker

Class SharedResourcesBrokerImpl<S extends ScopeType<S>>

java.lang.Object

org.apache.gobblin.broker.SharedResourcesBrokerImpl<S>

All Implemented Interfaces:

Closeable, AutoCloseable, SharedResourcesBroker<S>

public class SharedResourcesBrokerImpl<S extends ScopeType<S>>
extends Object
implements SharedResourcesBroker<S>

An implementation of SharedResourcesBroker using a DefaultBrokerCache for storing shared objects. Instances of this broker must be created as follows:

  SharedResourcesBrokerImpl rootBroker = SharedResourcesBrokerFactory.createDefaultTopLevelBroker(myConfig);
  SharedResourcesBrokerImpl scopeBroker = topBroker.newSubscopedBuilder(scope, "scopeId").build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SharedResourcesBrokerImpl.SubscopedBrokerBuilder A builder used to create a descendant SharedResourcesBrokerImpl with the same backing DefaultBrokerCache.

Method Summary

Modifier and Type	Method and Description
<T,K extends SharedResourceKey> void	bindSharedResourceAtScope(SharedResourceFactory<T,K,S> factory, K key, S scopeType, T instance)
void	close()
boolean	equals(Object o)
<K extends SharedResourceKey> KeyedScopedConfigViewImpl<S,K>	getConfigView(S scope, K key, String factoryName) Get a ConfigView for the input scope, key, and factory.
ScopeInstance<S>	getScope(S scopeType)
<T,K extends SharedResourceKey> T	getSharedResource(SharedResourceFactory<T,K,S> factory, K key)
<T,K extends SharedResourceKey> T	getSharedResourceAtScope(SharedResourceFactory<T,K,S> factory, K key, S scope)
int	hashCode()
SharedResourcesBrokerImpl.SubscopedBrokerBuilder	newSubscopedBuilder(ScopeInstance<S> subscope) Get a builder to create a descendant SharedResourcesBrokerImpl (i.e.
ScopeInstance<S>	selfScope()

Methods inherited from class java.lang.Object

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

Method Detail

selfScope

public ScopeInstance<S> selfScope()

Specified by:

selfScope in interface SharedResourcesBroker<S extends ScopeType<S>>

getScope

public ScopeInstance<S> getScope(S scopeType)
                          throws NoSuchScopeException

Specified by:

getScope in interface SharedResourcesBroker<S extends ScopeType<S>>

Throws:

NoSuchScopeException

getSharedResource

public <T,K extends SharedResourceKey> T getSharedResource(SharedResourceFactory<T,K,S> factory,
                                                           K key)
                                                    throws NotConfiguredException

Specified by:

getSharedResource in interface SharedResourcesBroker<S extends ScopeType<S>>

Throws:

NotConfiguredException

getSharedResourceAtScope

public <T,K extends SharedResourceKey> T getSharedResourceAtScope(SharedResourceFactory<T,K,S> factory,
                                                                  K key,
                                                                  S scope)
                                                           throws NotConfiguredException,
                                                                  NoSuchScopeException

Specified by:

getSharedResourceAtScope in interface SharedResourcesBroker<S extends ScopeType<S>>

Throws:

NotConfiguredException

NoSuchScopeException

bindSharedResourceAtScope

public <T,K extends SharedResourceKey> void bindSharedResourceAtScope(SharedResourceFactory<T,K,S> factory,
                                                                      K key,
                                                                      S scopeType,
                                                                      T instance)
                                                               throws NoSuchScopeException

Specified by:

bindSharedResourceAtScope in interface SharedResourcesBroker<S extends ScopeType<S>>

Throws:

NoSuchScopeException

getConfigView

public <K extends SharedResourceKey> KeyedScopedConfigViewImpl<S,K> getConfigView(S scope,
                                                                                  K key,
                                                                                  String factoryName)

Get a ConfigView for the input scope, key, and factory.

newSubscopedBuilder

public SharedResourcesBrokerImpl.SubscopedBrokerBuilder newSubscopedBuilder(ScopeInstance<S> subscope)

Get a builder to create a descendant SharedResourcesBrokerImpl (i.e. its leaf scope is a descendant of this broker's leaf scope) and the same backing DefaultBrokerCache.

Specified by:

newSubscopedBuilder in interface SharedResourcesBroker<S extends ScopeType<S>>

Parameters:

subscope - the ScopeInstance of the new SharedResourcesBroker.

Returns:

a SharedResourcesBrokerImpl.SubscopedBrokerBuilder.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SharedResourcesBroker<S extends ScopeType<S>>

Throws:

IOException