org.apache.gobblin.broker.iface

Interface SharedResourceFactory<T,K extends SharedResourceKey,S extends ScopeType<S>>

Type Parameters:

T - type of objects this factory creates.

K - type of SharedResourceKey this factory uses.

public interface SharedResourceFactory<T,K extends SharedResourceKey,S extends ScopeType<S>>

A factory that creates ScopeInstance specific objects.

Method Summary

Modifier and Type	Method and Description
SharedResourceFactoryResponse<T>	createResource(SharedResourcesBroker<S> broker, ScopedConfigView<S,K> config) Requests an object for the provided SharedResourceKey, with the provided configuration.
S	getAutoScope(SharedResourcesBroker<S> broker, ConfigView<S,K> config)
String	getName()

Method Detail

getName

String getName()

Returns:

An identifier for this factory. Users will configure shared resources using this name.

createResource

SharedResourceFactoryResponse<T> createResource(SharedResourcesBroker<S> broker,
                                                ScopedConfigView<S,K> config)
                                         throws NotConfiguredException

Requests an object for the provided SharedResourceKey, with the provided configuration. The factory can return a variety of responses: * ResourceEntry: a newly built resource of type T for the input key and scope. * ResourceCoordinate: the coordinates (factory, key, scope) of another resource of type T that should be used instead (this allows, for example, to use a different factory, or always return a global scoped object.)

Throws:

NotConfiguredException

getAutoScope

S getAutoScope(SharedResourcesBroker<S> broker,
               ConfigView<S,K> config)

Returns:

The ScopeType at which an auto scoped resource should be created. A good default is to return broker.selfScope()