Package io.dropwizard.auth

Class AuthFilter.AuthFilterBuilder<C,P extends Principal,T extends AuthFilter<C,P>>

java.lang.Object

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

Type Parameters:

C - the type of credentials that the filter accepts

P - the type of the principal that the filter accepts

Direct Known Subclasses:

BasicCredentialAuthFilter.Builder, OAuthCredentialAuthFilter.Builder

Enclosing class:

AuthFilter<C,P extends Principal>

public abstract static class AuthFilter.AuthFilterBuilder<C,P extends Principal,T extends AuthFilter<C,P>>
extends Object

Abstract builder for auth filters.

Constructor Summary

Constructors

Constructor	Description
AuthFilterBuilder()

Method Summary

Modifier and Type	Method	Description
T	buildAuthFilter()	Builds an instance of the filter with a provided authenticator, an authorizer, a prefix, and a realm.
protected abstract T	newInstance()
AuthFilter.AuthFilterBuilder<C,P,T>	setAuthenticator(Authenticator<C,P> authenticator)	Sets the given authenticator
AuthFilter.AuthFilterBuilder<C,P,T>	setAuthorizer(Authorizer<P> authorizer)	Sets the given authorizer
AuthFilter.AuthFilterBuilder<C,P,T>	setPrefix(String prefix)	Sets the given prefix
AuthFilter.AuthFilterBuilder<C,P,T>	setRealm(String realm)	Sets the given realm
AuthFilter.AuthFilterBuilder<C,P,T>	setUnauthorizedHandler(UnauthorizedHandler unauthorizedHandler)	Sets the given unauthorized handler

Methods inherited from class java.lang.Object

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

Constructor Details

AuthFilterBuilder

public AuthFilterBuilder()

Method Details

setRealm

public AuthFilter.AuthFilterBuilder<C,P,T> setRealm(String realm)

Sets the given realm

Parameters:

realm - a realm

Returns:

the current builder

setPrefix

public AuthFilter.AuthFilterBuilder<C,P,T> setPrefix(String prefix)

Sets the given prefix

Parameters:

prefix - a prefix

Returns:

the current builder

setAuthorizer

public AuthFilter.AuthFilterBuilder<C,P,T> setAuthorizer(Authorizer<P> authorizer)

Sets the given authorizer

Parameters:

authorizer - an Authorizer

Returns:

the current builder

setAuthenticator

public AuthFilter.AuthFilterBuilder<C,P,T> setAuthenticator(Authenticator<C,P> authenticator)

Sets the given authenticator

Parameters:

authenticator - an Authenticator

Returns:

the current builder

setUnauthorizedHandler

public AuthFilter.AuthFilterBuilder<C,P,T> setUnauthorizedHandler(UnauthorizedHandler unauthorizedHandler)

Sets the given unauthorized handler

Parameters:

unauthorizedHandler - an UnauthorizedHandler

Returns:

the current builder

buildAuthFilter

public T buildAuthFilter()

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

Returns:

a new instance of the filter

newInstance

protected abstract T newInstance()