org.apache.gobblin.util.limiter.broker

Class SharedLimiterFactory<S extends ScopeType<S>>

java.lang.Object

org.apache.gobblin.util.limiter.broker.SharedLimiterFactory<S>

All Implemented Interfaces:

SharedResourceFactory<Limiter,SharedLimiterKey,S>

public class SharedLimiterFactory<S extends ScopeType<S>>
extends Object
implements SharedResourceFactory<Limiter,SharedLimiterKey,S>

A SharedResourceFactory to create shared Limiters using a SharedResourcesBroker.

The factory creates a MultiLimiter combining a Limiter at the indicated scope with the Limiter at all immediate parent scopes (obtained from the broker itself). The factory reads the property LIMITER_CLASS_KEY from the input ConfigView to determine the class of Limiter to create at the indicated scope. If the key is not found, a NoopLimiter is generated instead (to combine with parent Limiters).

Field Summary

Fields

Modifier and Type	Field and Description
static String	FAIL_IF_NO_GLOBAL_LIMITER_KEY
static String	FAIL_ON_UNKNOWN_RESOURCE_ID
static String	LIMITER_CLASS_KEY
static String	NAME
static String	SKIP_GLOBAL_LIMITER_KEY Skip use of global limiter.

Constructor Summary

Constructors

Constructor and Description
SharedLimiterFactory()

Method Summary

Modifier and Type	Method and Description
SharedResourceFactoryResponse<Limiter>	createResource(SharedResourcesBroker<S> broker, ScopedConfigView<S,SharedLimiterKey> configView)
S	getAutoScope(SharedResourcesBroker<S> broker, ConfigView<S,SharedLimiterKey> config)
String	getName()

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

LIMITER_CLASS_KEY

public static final String LIMITER_CLASS_KEY

See Also:

Constant Field Values

FAIL_IF_NO_GLOBAL_LIMITER_KEY

public static final String FAIL_IF_NO_GLOBAL_LIMITER_KEY

See Also:

Constant Field Values

SKIP_GLOBAL_LIMITER_KEY

public static final String SKIP_GLOBAL_LIMITER_KEY

Skip use of global limiter. In general, this should not be used, but it is provided to easily disable global limiters in case of issues with the coordination server.

See Also:

Constant Field Values

FAIL_ON_UNKNOWN_RESOURCE_ID

public static final String FAIL_ON_UNKNOWN_RESOURCE_ID

See Also:

Constant Field Values

Constructor Detail

SharedLimiterFactory

public SharedLimiterFactory()

Method Detail

getName

public String getName()

Specified by:

getName in interface SharedResourceFactory<Limiter,SharedLimiterKey,S extends ScopeType<S>>

createResource

public SharedResourceFactoryResponse<Limiter> createResource(SharedResourcesBroker<S> broker,
                                                             ScopedConfigView<S,SharedLimiterKey> configView)
                                                      throws NotConfiguredException

Specified by:

createResource in interface SharedResourceFactory<Limiter,SharedLimiterKey,S extends ScopeType<S>>

Throws:

NotConfiguredException

getAutoScope

public S getAutoScope(SharedResourcesBroker<S> broker,
                      ConfigView<S,SharedLimiterKey> config)

Specified by:

getAutoScope in interface SharedResourceFactory<Limiter,SharedLimiterKey,S extends ScopeType<S>>

Returns:

brokers self scope.