Package com.marcosbarbero.cloud.autoconfigure.zuul.ratelimit.config.properties

Enum RateLimitType

java.lang.Object

java.lang.Enum<RateLimitType>

com.marcosbarbero.cloud.autoconfigure.zuul.ratelimit.config.properties.RateLimitType

All Implemented Interfaces:

Serializable, Comparable<RateLimitType>

public enum RateLimitType
extends Enum<RateLimitType>

Enum Constant Summary

Enum Constants

Enum Constant	Description
HTTP_METHOD	Rate limit policy considering the HTTP request method.
HTTPMETHOD	Deprecated. See HTTP_METHOD
ORIGIN	Rate limit policy considering the user's origin.
ROLE	Rate limit policy considering the authenticated user's role.
URL	Rate limit policy considering the request path to the downstream service.
URL_PATTERN	Rate limit policy considering an URL Pattern
USER	Rate limit policy considering the authenticated user.

Method Summary

Modifier and Type	Method	Description
abstract boolean	apply(javax.servlet.http.HttpServletRequest request, org.springframework.cloud.netflix.zuul.filters.Route route, RateLimitUtils rateLimitUtils, String matcher)
boolean	isValid(String matcher)	Helper method to validate specific cases per type.
abstract String	key(javax.servlet.http.HttpServletRequest request, org.springframework.cloud.netflix.zuul.filters.Route route, RateLimitUtils rateLimitUtils, String matcher)
static RateLimitType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RateLimitType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ORIGIN

public static final RateLimitType ORIGIN

Rate limit policy considering the user's origin.

USER

public static final RateLimitType USER

Rate limit policy considering the authenticated user.

URL

public static final RateLimitType URL

Rate limit policy considering the request path to the downstream service.

ROLE

public static final RateLimitType ROLE

Rate limit policy considering the authenticated user's role.

HTTPMETHOD

@Deprecated
public static final RateLimitType HTTPMETHOD

Deprecated. See HTTP_METHOD

HTTP_METHOD

public static final RateLimitType HTTP_METHOD

Rate limit policy considering the HTTP request method.

URL_PATTERN

public static final RateLimitType URL_PATTERN

Rate limit policy considering an URL Pattern

Method Detail

values

public static RateLimitType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RateLimitType c : RateLimitType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RateLimitType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

apply

public abstract boolean apply(javax.servlet.http.HttpServletRequest request,
                              org.springframework.cloud.netflix.zuul.filters.Route route,
                              RateLimitUtils rateLimitUtils,
                              String matcher)

key

public abstract String key(javax.servlet.http.HttpServletRequest request,
                           org.springframework.cloud.netflix.zuul.filters.Route route,
                           RateLimitUtils rateLimitUtils,
                           String matcher)

isValid

public boolean isValid(String matcher)

Helper method to validate specific cases per type.

Parameters:

matcher - The type matcher

Returns:

The default behavior will always return true.