Package io.apiman.gateway.engine.policies.config

Class RateLimitingConfig

java.lang.Object

io.apiman.gateway.engine.policies.config.RateLimitingConfig

Direct Known Subclasses:

TransferQuotaConfig

public class RateLimitingConfig
extends Object

Configuration object for the rate limiting policy.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor	Description
RateLimitingConfig()	Constructor.

Method Summary

Modifier and Type	Method	Description
RateLimitingGranularity	getGranularity()
String	getHeaderLimit()
String	getHeaderRemaining()
String	getHeaderReset()
long	getLimit()
RateLimitingPeriod	getPeriod()
String	getUserHeader()
void	setGranularity(RateLimitingGranularity granularity)
void	setHeaderLimit(String headerLimit)
void	setHeaderRemaining(String headerRemaining)
void	setHeaderReset(String headerReset)
void	setLimit(long limit)
void	setPeriod(RateLimitingPeriod period)
void	setUserHeader(String userHeader)

Methods inherited from class java.lang.Object

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

Constructor Detail

RateLimitingConfig

public RateLimitingConfig()

Constructor.

Method Detail

getGranularity

public RateLimitingGranularity getGranularity()

Returns:

the granularity

setGranularity

public void setGranularity(RateLimitingGranularity granularity)

Parameters:

granularity - the granularity to set

getPeriod

public RateLimitingPeriod getPeriod()

Returns:

the period

setPeriod

public void setPeriod(RateLimitingPeriod period)

Parameters:

period - the period to set

getUserHeader

public String getUserHeader()

Returns:

the userHeader

setUserHeader

public void setUserHeader(String userHeader)

Parameters:

userHeader - the userHeader to set

getLimit

public long getLimit()

Returns:

the limit

setLimit

public void setLimit(long limit)

Parameters:

limit - the limit to set

getHeaderRemaining

public String getHeaderRemaining()

Returns:

the headerRemaining

setHeaderRemaining

public void setHeaderRemaining(String headerRemaining)

Parameters:

headerRemaining - the headerRemaining to set

getHeaderLimit

public String getHeaderLimit()

Returns:

the headerLimit

setHeaderLimit

public void setHeaderLimit(String headerLimit)

Parameters:

headerLimit - the headerLimit to set

getHeaderReset

public String getHeaderReset()

Returns:

the headerReset

setHeaderReset

public void setHeaderReset(String headerReset)

Parameters:

headerReset - the headerReset to set