Spring Core 6.1.4 · org.springframework.util.ConcurrencyThrottleSupport

Support class for throttling concurrent access to a specific resource.

Designed for use as a base class, with the subclass invoking the beforeAccess() and afterAccess() methods at appropriate points of its workflow. Note that afterAccess should usually be called in a finally block!

The default concurrency limit of this support class is -1 ("unbounded concurrency"). Subclasses may override this default; check the javadoc of the concrete class that you're using.

Field Summary

Modifier and Type	Field and Description
private final Condition	concurrencyCondition
private int	concurrencyCount
private int	concurrencyLimit
private final Lock	concurrencyLock
protected transient Log	logger Transient to optimize serialization.
public static final int	NO_CONCURRENCY Switch concurrency 'off': that is, don't allow any concurrent invocations.
public static final int	UNBOUNDED_CONCURRENCY Permit any number of concurrent invocations: that is, don't throttle concurrency.

Constructor Summary

Access	Constructor and Description
public	ConcurrencyThrottleSupport()

Method Summary

Modifier and Type	Method and Description
protected void	afterAccess() To be invoked after the main execution logic of concrete subclasses.
protected void	beforeAccess() To be invoked before the main execution logic of concrete subclasses.
public int	getConcurrencyLimit() Return the maximum number of concurrent access attempts allowed.
public boolean	Returns: `true` if the concurrency limit for this instance is active isThrottleActive() Return whether this throttle is currently active.
private void	readObject(ObjectInputStream ois)
public void	setConcurrencyLimit(int concurrencyLimit) Set the maximum number of concurrent access attempts allowed.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

concurrencyCondition	back to summary
private final Condition concurrencyCondition

concurrencyCount	back to summary
private int concurrencyCount

concurrencyLimit	back to summary
private int concurrencyLimit

concurrencyLock	back to summary
private final Lock concurrencyLock

logger	back to summary
protected transient Log logger Transient to optimize serialization.

NO_CONCURRENCY	back to summary
public static final int NO_CONCURRENCY Switch concurrency 'off': that is, don't allow any concurrent invocations.

UNBOUNDED_CONCURRENCY	back to summary
public static final int UNBOUNDED_CONCURRENCY Permit any number of concurrent invocations: that is, don't throttle concurrency.

Constructor Detail

ConcurrencyThrottleSupport	back to summary
public ConcurrencyThrottleSupport()

Method Detail

afterAccess back to summary

afterAccess	back to summary
protected void afterAccess() To be invoked after the main execution logic of concrete subclasses. See Also `beforeAccess()`

protected void afterAccess()

To be invoked after the main execution logic of concrete subclasses.

See Also: beforeAccess()

beforeAccess back to summary

beforeAccess	back to summary
protected void beforeAccess() To be invoked before the main execution logic of concrete subclasses. This implementation applies the concurrency throttle. See Also `afterAccess()`

protected void beforeAccess()

To be invoked before the main execution logic of concrete subclasses.

This implementation applies the concurrency throttle.

See Also: afterAccess()

getConcurrencyLimit	back to summary
public int getConcurrencyLimit() Return the maximum number of concurrent access attempts allowed.

isThrottleActive back to summary

isThrottleActive	back to summary
public boolean isThrottleActive() Return whether this throttle is currently active. Returns:boolean `true` if the concurrency limit for this instance is active See Also `getConcurrencyLimit()`

public boolean isThrottleActive()

Return whether this throttle is currently active.

Returns:boolean: true if the concurrency limit for this instance is active
See Also: getConcurrencyLimit()

readObject	back to summary
private void readObject(ObjectInputStream ois) throws IOException, ClassNotFoundException

setConcurrencyLimit	back to summary
public void setConcurrencyLimit(int concurrencyLimit) Set the maximum number of concurrent access attempts allowed. The default of -1 indicates no concurrency limit at all. In principle, this limit can be changed at runtime, although it is generally designed as a config time setting. Note Do not switch between -1 and any concrete limit at runtime, as this will lead to inconsistent concurrency counts: A limit of -1 effectively turns off concurrency counting completely.

setConcurrencyLimit

back to summary

public void setConcurrencyLimit(int concurrencyLimit)

Set the maximum number of concurrent access attempts allowed. The default of -1 indicates no concurrency limit at all.

In principle, this limit can be changed at runtime, although it is generally designed as a config time setting.

Note

Do not switch between -1 and any concrete limit at runtime, as this will lead to inconsistent concurrency counts: A limit of -1 effectively turns off concurrency counting completely.

public abstract Class ConcurrencyThrottleSupport

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail