Package io.dropwizard.auth

Class AuthFilter<C,P extends Principal>

java.lang.Object

io.dropwizard.auth.AuthFilter<C,P>

All Implemented Interfaces:

jakarta.ws.rs.container.ContainerRequestFilter

Direct Known Subclasses:

BasicCredentialAuthFilter, ChainedAuthFilter, OAuthCredentialAuthFilter

@Priority(1000)
public abstract class AuthFilter<C,P extends Principal>
extends Object
implements jakarta.ws.rs.container.ContainerRequestFilter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthFilter.AuthFilterBuilder<C,P extends Principal,T extends AuthFilter<C,P>>	Abstract builder for auth filters.

Field Summary

Fields

Modifier and Type	Field	Description
protected Authenticator<C,P>	authenticator
protected Authorizer<P>	authorizer
protected final org.slf4j.Logger	logger
protected String	prefix
protected String	realm
protected UnauthorizedHandler	unauthorizedHandler

Constructor Summary

Constructors

Constructor	Description
AuthFilter()

Method Summary

Modifier and Type	Method	Description
protected boolean	authenticate(jakarta.ws.rs.container.ContainerRequestContext requestContext, @Nullable C credentials, String scheme)	Authenticates a request with user credentials and set up the security context.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.ws.rs.container.ContainerRequestFilter

filter

Field Details

logger

protected final org.slf4j.Logger logger

prefix

protected String prefix

realm

protected String realm

authenticator

protected Authenticator<C,P extends Principal> authenticator

authorizer

protected Authorizer<P extends Principal> authorizer

unauthorizedHandler

protected UnauthorizedHandler unauthorizedHandler

Constructor Details

AuthFilter

public AuthFilter()

Method Details

authenticate

protected boolean authenticate(jakarta.ws.rs.container.ContainerRequestContext requestContext,
 @Nullable C credentials,
 String scheme)

Authenticates a request with user credentials and set up the security context.

Parameters:

requestContext - the context of the request

credentials - the user credentials

scheme - the authentication scheme; one of BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH. See SecurityContext

Returns:

true, if the request is authenticated, otherwise false