A B C D E F G H I J L N O P R S T U

A

Auth - Annotation Type in io.dropwizard.auth

AuthDynamicFeature - Class in io.dropwizard.auth

A DynamicFeature that registers the provided auth filter to resource methods annotated with the RolesAllowed, PermitAll and DenyAll annotations.

AuthDynamicFeature(ContainerRequestFilter) - Constructor for class io.dropwizard.auth.AuthDynamicFeature

AuthDynamicFeature(Class<? extends ContainerRequestFilter>) - Constructor for class io.dropwizard.auth.AuthDynamicFeature

authenticate(C) - Method in interface io.dropwizard.auth.Authenticator

Given a set of user-provided credentials, return an optional principal.

authenticate(ContainerRequestContext, C, String) - Method in class io.dropwizard.auth.AuthFilter

Authenticates a request with user credentials and setup the security context.

authenticate(C) - Method in class io.dropwizard.auth.CachingAuthenticator

AuthenticationException - Exception in io.dropwizard.auth

An exception thrown to indicate that an Authenticator is unable to check the validity of the given credentials.

AuthenticationException(String) - Constructor for exception io.dropwizard.auth.AuthenticationException

AuthenticationException(String, Throwable) - Constructor for exception io.dropwizard.auth.AuthenticationException

AuthenticationException(Throwable) - Constructor for exception io.dropwizard.auth.AuthenticationException

Authenticator<C,P extends Principal> - Interface in io.dropwizard.auth

An interface for classes which authenticate user-provided credentials and return principal objects.

authenticator - Variable in class io.dropwizard.auth.AuthFilter

AuthFilter<C,P extends Principal> - Class in io.dropwizard.auth

AuthFilter() - Constructor for class io.dropwizard.auth.AuthFilter

AuthFilter.AuthFilterBuilder<C,P extends Principal,T extends AuthFilter<C,P>> - Class in io.dropwizard.auth

Abstract builder for auth filters.

AuthFilterBuilder() - Constructor for class io.dropwizard.auth.AuthFilter.AuthFilterBuilder

AuthorizationContext<P extends Principal> - Class in io.dropwizard.auth

AuthorizationContext(P, String, ContainerRequestContext) - Constructor for class io.dropwizard.auth.AuthorizationContext

authorize(P, String) - Method in interface io.dropwizard.auth.Authorizer

Deprecated.

Use Authorizer.authorize(Principal, String, ContainerRequestContext) instead

authorize(P, String, ContainerRequestContext) - Method in interface io.dropwizard.auth.Authorizer

Decides if access is granted for the given principal in the given role.

authorize(P, String) - Method in class io.dropwizard.auth.CachingAuthorizer

authorize(P, String, ContainerRequestContext) - Method in class io.dropwizard.auth.CachingAuthorizer

authorize(P, String) - Method in class io.dropwizard.auth.PermitAllAuthorizer

authorizer - Variable in class io.dropwizard.auth.AuthFilter

Authorizer<P extends Principal> - Interface in io.dropwizard.auth

An interface for classes which authorize principal objects.

AuthValueFactoryProvider<T extends Principal> - Class in io.dropwizard.auth

Value factory provider supporting Principal injection by the Auth annotation.

AuthValueFactoryProvider(MultivaluedParameterExtractorProvider, AuthValueFactoryProvider.PrincipalClassProvider<T>) - Constructor for class io.dropwizard.auth.AuthValueFactoryProvider

Principal value factory provider injection constructor.

AuthValueFactoryProvider.Binder<T extends Principal> - Class in io.dropwizard.auth

Injection binder for AuthValueFactoryProvider.

B

BasicCredentialAuthFilter<P extends Principal> - Class in io.dropwizard.auth.basic

BasicCredentialAuthFilter.Builder<P extends Principal> - Class in io.dropwizard.auth.basic

Builder for BasicCredentialAuthFilter.

BasicCredentials - Class in io.dropwizard.auth.basic

A set of user-provided Basic Authentication credentials, consisting of a username and a password.

BasicCredentials(String, String) - Constructor for class io.dropwizard.auth.basic.BasicCredentials

Creates a new BasicCredentials with the given username and password.

Binder(Class<T>) - Constructor for class io.dropwizard.auth.AuthValueFactoryProvider.Binder

Binder(Set<Class<? extends T>>) - Constructor for class io.dropwizard.auth.PolymorphicAuthValueFactoryProvider.Binder

buildAuthFilter() - Method in class io.dropwizard.auth.AuthFilter.AuthFilterBuilder

Builds an instance of the filter with a provided authenticator, an authorizer, a prefix, and a realm.

Builder() - Constructor for class io.dropwizard.auth.basic.BasicCredentialAuthFilter.Builder

Builder() - Constructor for class io.dropwizard.auth.oauth.OAuthCredentialAuthFilter.Builder

buildException(String, String) - Method in interface io.dropwizard.auth.UnauthorizedHandler

This method allows overriding the exception thrown from an AuthFilter instance.

buildResponse(String, String) - Method in class io.dropwizard.auth.DefaultUnauthorizedHandler

buildResponse(String, String) - Method in class io.dropwizard.auth.JSONUnauthorizedHandler

buildResponse(String, String) - Method in interface io.dropwizard.auth.UnauthorizedHandler

C

CachingAuthenticator<C,P extends Principal> - Class in io.dropwizard.auth

An Authenticator decorator which uses a Caffeine cache to temporarily cache credentials and their corresponding principals.

CachingAuthenticator(MetricRegistry, Authenticator<C, P>, CaffeineSpec) - Constructor for class io.dropwizard.auth.CachingAuthenticator

Creates a new cached authenticator.

CachingAuthenticator(MetricRegistry, Authenticator<C, P>, Caffeine<Object, Object>) - Constructor for class io.dropwizard.auth.CachingAuthenticator

Creates a new cached authenticator.

CachingAuthenticator(MetricRegistry, Authenticator<C, P>, Caffeine<Object, Object>, boolean) - Constructor for class io.dropwizard.auth.CachingAuthenticator

Creates a new cached authenticator.

CachingAuthenticator(MetricRegistry, Authenticator<C, P>, Caffeine<Object, Object>, boolean, Supplier<StatsCounter>) - Constructor for class io.dropwizard.auth.CachingAuthenticator

Creates a new cached authenticator.

CachingAuthorizer<P extends Principal> - Class in io.dropwizard.auth

An Authorizer decorator which uses a Caffeine cache to temporarily cache principals' role associations.

CachingAuthorizer(MetricRegistry, Authorizer<P>, CaffeineSpec) - Constructor for class io.dropwizard.auth.CachingAuthorizer

Creates a new cached authorizer.

CachingAuthorizer(MetricRegistry, Authorizer<P>, Caffeine<Object, Object>) - Constructor for class io.dropwizard.auth.CachingAuthorizer

Creates a new cached authorizer.

CachingAuthorizer(MetricRegistry, Authorizer<P>, Caffeine<Object, Object>, Supplier<StatsCounter>) - Constructor for class io.dropwizard.auth.CachingAuthorizer

Creates a new cached authorizer.

ChainedAuthFilter<C,P extends Principal> - Class in io.dropwizard.auth.chained

Chains together authFilters, short circuits when the first filter successfully authenticates N.B.

ChainedAuthFilter(List<AuthFilter>) - Constructor for class io.dropwizard.auth.chained.ChainedAuthFilter

configure(ResourceInfo, FeatureContext) - Method in class io.dropwizard.auth.AuthDynamicFeature

configure(FeatureContext) - Method in class io.dropwizard.auth.AuthDynamicFeature

configure() - Method in class io.dropwizard.auth.AuthValueFactoryProvider.Binder

configure(ResourceInfo, FeatureContext) - Method in class io.dropwizard.auth.PolymorphicAuthDynamicFeature

configure(FeatureContext) - Method in class io.dropwizard.auth.PolymorphicAuthDynamicFeature

configure() - Method in class io.dropwizard.auth.PolymorphicAuthValueFactoryProvider.Binder

createValueProvider(Parameter) - Method in class io.dropwizard.auth.AuthValueFactoryProvider

createValueProvider(Parameter) - Method in class io.dropwizard.auth.PolymorphicAuthValueFactoryProvider

D

DefaultAuthorizationContext<P extends Principal> - Class in io.dropwizard.auth

The default implementation of AuthorizationContext, which uses a Principal, a role and a ContainerRequestContext to temporarily cache principals' role associations.

DefaultUnauthorizedHandler - Class in io.dropwizard.auth

DefaultUnauthorizedHandler() - Constructor for class io.dropwizard.auth.DefaultUnauthorizedHandler

E

equals(Object) - Method in class io.dropwizard.auth.AuthorizationContext

equals(Object) - Method in class io.dropwizard.auth.basic.BasicCredentials

equals(Object) - Method in class io.dropwizard.auth.PrincipalImpl

F

filter(ContainerRequestContext) - Method in class io.dropwizard.auth.basic.BasicCredentialAuthFilter

filter(ContainerRequestContext) - Method in class io.dropwizard.auth.chained.ChainedAuthFilter

filter(ContainerRequestContext) - Method in class io.dropwizard.auth.oauth.OAuthCredentialAuthFilter

G

getAuthorizationContext(P, String, ContainerRequestContext) - Method in interface io.dropwizard.auth.Authorizer

Returns an AuthorizationContext object, to be used in CachingAuthorizer as cache key.

getAuthorizationContext(P, String, ContainerRequestContext) - Method in class io.dropwizard.auth.CachingAuthorizer

getName() - Method in class io.dropwizard.auth.PrincipalImpl

getPassword() - Method in class io.dropwizard.auth.basic.BasicCredentials

Returns the credentials' password.

getPrincipal() - Method in class io.dropwizard.auth.AuthorizationContext

getRequestContext() - Method in class io.dropwizard.auth.AuthorizationContext

getRole() - Method in class io.dropwizard.auth.AuthorizationContext

getUsername() - Method in class io.dropwizard.auth.basic.BasicCredentials

Returns the credentials' username.

H

hashCode() - Method in class io.dropwizard.auth.AuthorizationContext

hashCode() - Method in class io.dropwizard.auth.basic.BasicCredentials

hashCode() - Method in class io.dropwizard.auth.PrincipalImpl

I

invalidate(C) - Method in class io.dropwizard.auth.CachingAuthenticator

Discards any cached principal for the given credentials.

invalidate(P, String, ContainerRequestContext) - Method in class io.dropwizard.auth.CachingAuthorizer

Discards any cached role associations for the given principal and role.

invalidate(P) - Method in class io.dropwizard.auth.CachingAuthorizer

Discards any cached role associations for the given principal.

invalidateAll(Iterable<C>) - Method in class io.dropwizard.auth.CachingAuthenticator

Discards any cached principal for the given collection of credentials.

invalidateAll(Predicate<? super C>) - Method in class io.dropwizard.auth.CachingAuthenticator

Discards any cached principal for the collection of credentials satisfying the given predicate.

invalidateAll() - Method in class io.dropwizard.auth.CachingAuthenticator

Discards all cached principals.

invalidateAll(Iterable<P>) - Method in class io.dropwizard.auth.CachingAuthorizer

Discards any cached role associations for the given collection of principals.

invalidateAll(Predicate<? super P>) - Method in class io.dropwizard.auth.CachingAuthorizer

Discards any cached role associations for principals satisfying the given predicate.

invalidateAll() - Method in class io.dropwizard.auth.CachingAuthorizer

Discards all cached role associations.

io.dropwizard.auth - package io.dropwizard.auth

io.dropwizard.auth.basic - package io.dropwizard.auth.basic

io.dropwizard.auth.chained - package io.dropwizard.auth.chained

io.dropwizard.auth.oauth - package io.dropwizard.auth.oauth

J

JSONUnauthorizedHandler - Class in io.dropwizard.auth

JSONUnauthorizedHandler() - Constructor for class io.dropwizard.auth.JSONUnauthorizedHandler

L

logger - Variable in class io.dropwizard.auth.AuthFilter

N

newInstance() - Method in class io.dropwizard.auth.AuthFilter.AuthFilterBuilder

newInstance() - Method in class io.dropwizard.auth.basic.BasicCredentialAuthFilter.Builder

newInstance() - Method in class io.dropwizard.auth.oauth.OAuthCredentialAuthFilter.Builder

O

OAUTH_ACCESS_TOKEN_PARAM - Static variable in class io.dropwizard.auth.oauth.OAuthCredentialAuthFilter

Query parameter used to pass Bearer token

OAuthCredentialAuthFilter<P extends Principal> - Class in io.dropwizard.auth.oauth

OAuthCredentialAuthFilter.Builder<P extends Principal> - Class in io.dropwizard.auth.oauth

Builder for OAuthCredentialAuthFilter.

P

PermitAllAuthorizer<P extends Principal> - Class in io.dropwizard.auth

An Authorizer that grants access for any principal in any role.

PermitAllAuthorizer() - Constructor for class io.dropwizard.auth.PermitAllAuthorizer

PolymorphicAuthDynamicFeature<T extends Principal> - Class in io.dropwizard.auth

A DynamicFeature that registers the provided auth filters to resource methods annotated with the Auth according to the type of the annotated method parameter.

PolymorphicAuthDynamicFeature(Map<Class<? extends T>, ContainerRequestFilter>) - Constructor for class io.dropwizard.auth.PolymorphicAuthDynamicFeature

PolymorphicAuthValueFactoryProvider<T extends Principal> - Class in io.dropwizard.auth

Value factory provider supporting injection of a hierarchy of Principal subclasses by the Auth annotation.

PolymorphicAuthValueFactoryProvider(MultivaluedParameterExtractorProvider, PolymorphicAuthValueFactoryProvider.PrincipalClassSetProvider<T>) - Constructor for class io.dropwizard.auth.PolymorphicAuthValueFactoryProvider

Principal value factory provider injection constructor.

PolymorphicAuthValueFactoryProvider.Binder<T extends Principal> - Class in io.dropwizard.auth

Injection binder for PolymorphicAuthValueFactoryProvider.

PolymorphicAuthValueFactoryProvider.PrincipalClassSetProvider<T extends Principal> - Class in io.dropwizard.auth

prefix - Variable in class io.dropwizard.auth.AuthFilter

principalClassSet - Variable in class io.dropwizard.auth.PolymorphicAuthValueFactoryProvider

Set of provided Principal subclasses.

PrincipalClassSetProvider(Set<Class<? extends T>>) - Constructor for class io.dropwizard.auth.PolymorphicAuthValueFactoryProvider.PrincipalClassSetProvider

PrincipalImpl - Class in io.dropwizard.auth

PrincipalImpl(String) - Constructor for class io.dropwizard.auth.PrincipalImpl

R

realm - Variable in class io.dropwizard.auth.AuthFilter

S

setAuthenticator(Authenticator<C, P>) - Method in class io.dropwizard.auth.AuthFilter.AuthFilterBuilder

Sets the given authenticator

setAuthorizer(Authorizer<P>) - Method in class io.dropwizard.auth.AuthFilter.AuthFilterBuilder

Sets the given authorizer

setPrefix(String) - Method in class io.dropwizard.auth.AuthFilter.AuthFilterBuilder

Sets the given prefix

setRealm(String) - Method in class io.dropwizard.auth.AuthFilter.AuthFilterBuilder

Sets the given realm

setUnauthorizedHandler(UnauthorizedHandler) - Method in class io.dropwizard.auth.AuthFilter.AuthFilterBuilder

Sets the given unauthorized handler

size() - Method in class io.dropwizard.auth.CachingAuthenticator

Returns the number of cached principals.

size() - Method in class io.dropwizard.auth.CachingAuthorizer

Returns the number of principals for which there are cached role associations.

stats() - Method in class io.dropwizard.auth.CachingAuthenticator

Returns a set of statistics about the cache contents and usage.

stats() - Method in class io.dropwizard.auth.CachingAuthorizer

Returns a set of statistics about the cache contents and usage.

T

toString() - Method in class io.dropwizard.auth.basic.BasicCredentials

toString() - Method in class io.dropwizard.auth.PrincipalImpl

U

unauthorizedHandler - Variable in class io.dropwizard.auth.AuthFilter

UnauthorizedHandler - Interface in io.dropwizard.auth

A B C D E F G H I J L N O P R S T U