org.apache.gobblin.util.limiter

Class DefaultLimiterFactory

java.lang.Object

org.apache.gobblin.util.limiter.DefaultLimiterFactory

public class DefaultLimiterFactory
extends Object

A default factory class for Limiters.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTRACT_LIMIT_COUNT_LIMIT_KEY
static String	EXTRACT_LIMIT_POOL_SIZE_KEY
static String	EXTRACT_LIMIT_RATE_LIMIT_KEY
static String	EXTRACT_LIMIT_RATE_LIMIT_KEY_DEP Deprecated.
static String	EXTRACT_LIMIT_RATE_LIMIT_TIMEUNIT_KEY
static String	EXTRACT_LIMIT_RATE_LIMIT_TIMEUNIT_KEY_DEP Deprecated.
static String	EXTRACT_LIMIT_TIME_LIMIT_KEY
static String	EXTRACT_LIMIT_TIME_LIMIT_KEY_DEP Deprecated.
static String	EXTRACT_LIMIT_TIME_LIMIT_TIMEUNIT_KEY
static String	EXTRACT_LIMIT_TIME_LIMIT_TIMEUNIT_KEY_DEP Deprecated.
static String	EXTRACT_LIMIT_TYPE_KEY

Constructor Summary

Constructors

Constructor and Description
DefaultLimiterFactory()

Method Summary

Modifier and Type	Method and Description
static Limiter	newLimiter(State state) Create a new Limiter instance of one of the types in BaseLimiterType.

Methods inherited from class java.lang.Object

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

Field Detail

EXTRACT_LIMIT_TYPE_KEY

public static final String EXTRACT_LIMIT_TYPE_KEY

See Also:

Constant Field Values

EXTRACT_LIMIT_RATE_LIMIT_KEY

public static final String EXTRACT_LIMIT_RATE_LIMIT_KEY

See Also:

Constant Field Values

EXTRACT_LIMIT_RATE_LIMIT_TIMEUNIT_KEY

public static final String EXTRACT_LIMIT_RATE_LIMIT_TIMEUNIT_KEY

See Also:

Constant Field Values

EXTRACT_LIMIT_TIME_LIMIT_KEY

public static final String EXTRACT_LIMIT_TIME_LIMIT_KEY

See Also:

Constant Field Values

EXTRACT_LIMIT_TIME_LIMIT_TIMEUNIT_KEY

public static final String EXTRACT_LIMIT_TIME_LIMIT_TIMEUNIT_KEY

See Also:

Constant Field Values

EXTRACT_LIMIT_COUNT_LIMIT_KEY

public static final String EXTRACT_LIMIT_COUNT_LIMIT_KEY

See Also:

Constant Field Values

EXTRACT_LIMIT_POOL_SIZE_KEY

public static final String EXTRACT_LIMIT_POOL_SIZE_KEY

See Also:

Constant Field Values

EXTRACT_LIMIT_RATE_LIMIT_KEY_DEP

@Deprecated
public static final String EXTRACT_LIMIT_RATE_LIMIT_KEY_DEP

Deprecated.

See Also:

Constant Field Values

EXTRACT_LIMIT_RATE_LIMIT_TIMEUNIT_KEY_DEP

@Deprecated
public static final String EXTRACT_LIMIT_RATE_LIMIT_TIMEUNIT_KEY_DEP

Deprecated.

See Also:

Constant Field Values

EXTRACT_LIMIT_TIME_LIMIT_KEY_DEP

@Deprecated
public static final String EXTRACT_LIMIT_TIME_LIMIT_KEY_DEP

Deprecated.

See Also:

Constant Field Values

EXTRACT_LIMIT_TIME_LIMIT_TIMEUNIT_KEY_DEP

@Deprecated
public static final String EXTRACT_LIMIT_TIME_LIMIT_TIMEUNIT_KEY_DEP

Deprecated.

See Also:

Constant Field Values

Constructor Detail

DefaultLimiterFactory

public DefaultLimiterFactory()

Method Detail

newLimiter

public static Limiter newLimiter(State state)

Create a new Limiter instance of one of the types in BaseLimiterType.

Note this method will always return a new Limiter instance of one of the supported types defined in BaseLimiterType as long as the input configuration specifies a supported BaseLimiterType. It will throw an IllegalArgumentException if none of the supported BaseLimiterTypes is specified or if any of the required configuration properties for the specified BaseLimiterType is not present.

This method will return a functional Limiter if the configuration is correct. If instead, a Limiter is optional or the caller is fine with a Limiter that is not really limiting any events, then the caller should first make sure that the Limiter should indeed be created using this method, or handle the exception (if any is thrown) appropriately.

Parameters:

state - a State instance carrying configuration properties

Returns:

a new Limiter instance

Throws:

IllegalArgumentException - if the input configuration does not specify a valid supported