es.moki.ratelimij.dropwizard.filter

Enum KeyPart

java.lang.Object

java.lang.Enum<KeyPart>

es.moki.ratelimij.dropwizard.filter.KeyPart

All Implemented Interfaces:

KeyProvider, java.io.Serializable, java.lang.Comparable<KeyPart>

@ParametersAreNonnullByDefault
public enum KeyPart
extends java.lang.Enum<KeyPart>
implements KeyProvider

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY The 'any' key will be the first of: authenticated principle (Dropwizard auth) X-Forwarded-For Header IP address servlet remote address IP
AUTHENTICATED The 'authenticated' key will be the authenticated principle (Dropwizard auth).
IP The 'ip' key will be the IP (X-Forwarded-For Header or servlet remote address).
RESOURCE_NAME The 'resource' key will be the of the resource name.

Method Summary

Modifier and Type	Method and Description
static java.util.Optional<java.lang.CharSequence>	combineKeysParts(java.lang.CharSequence groupKeyPrefix, java.util.List<KeyProvider> keyParts, javax.servlet.http.HttpServletRequest request, javax.ws.rs.container.ResourceInfo resource, javax.ws.rs.core.SecurityContext securityContext)
static KeyPart	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static KeyPart[]	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

Methods inherited from interface es.moki.ratelimij.dropwizard.filter.KeyProvider

create

Enum Constant Detail

ANY

public static final KeyPart ANY

The 'any' key will be the first of:

• authenticated principle (Dropwizard auth)
• X-Forwarded-For Header IP address
• servlet remote address IP

AUTHENTICATED

public static final KeyPart AUTHENTICATED

The 'authenticated' key will be the authenticated principle (Dropwizard auth).

IP

public static final KeyPart IP

The 'ip' key will be the IP (X-Forwarded-For Header or servlet remote address).

RESOURCE_NAME

public static final KeyPart RESOURCE_NAME

The 'resource' key will be the of the resource name.

Method Detail

values

public static KeyPart[] 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 (KeyPart c : KeyPart.values())
    System.out.println(c);

Returns:

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

valueOf

public static KeyPart valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

combineKeysParts

public static java.util.Optional<java.lang.CharSequence> combineKeysParts(java.lang.CharSequence groupKeyPrefix,
                                                                          java.util.List<KeyProvider> keyParts,
                                                                          javax.servlet.http.HttpServletRequest request,
                                                                          javax.ws.rs.container.ResourceInfo resource,
                                                                          javax.ws.rs.core.SecurityContext securityContext)