Module io.inverno.mod.security.http

Package io.inverno.mod.security.http.basic

Class BasicAuthenticationErrorInterceptor<A extends ExchangeContext,B extends ErrorExchange<A>>

java.lang.Object

io.inverno.mod.security.http.AuthenticationErrorInterceptor<A,B>

io.inverno.mod.security.http.HttpAuthenticationErrorInterceptor<A,B>

io.inverno.mod.security.http.basic.BasicAuthenticationErrorInterceptor<A,B>

Type Parameters:

A - the context type

B - the error exchange type

All Implemented Interfaces:

ExchangeInterceptor<A,B>

public class BasicAuthenticationErrorInterceptor<A extends ExchangeContext,B extends ErrorExchange<A>>
extends HttpAuthenticationErrorInterceptor<A,B>

An HTTP authentication error interceptor that implements RFC 7617 The 'Basic' HTTP Authentication Scheme.

As per RFC 7617, a basic challenge with the realm parameter is sent to the requester to initiate basic HTTP authentication.

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

Fields inherited from class io.inverno.mod.security.http.AuthenticationErrorInterceptor

terminal

Constructor Summary

Constructors

Constructor	Description
BasicAuthenticationErrorInterceptor(String realm)	Creates a basic authentication error interceptor.

Method Summary

Modifier and Type	Method	Description
protected String	createChallenge(SecurityException cause)	Creates the challenge to send to the requester.
String	getRealm()	Returns the realm.

Methods inherited from class io.inverno.mod.security.http.HttpAuthenticationErrorInterceptor

interceptUnauthorized

Methods inherited from class io.inverno.mod.security.http.AuthenticationErrorInterceptor

intercept

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.inverno.mod.http.server.ExchangeInterceptor

andThen, compose

Constructor Details

BasicAuthenticationErrorInterceptor

public BasicAuthenticationErrorInterceptor(String realm)

Creates a basic authentication error interceptor.

Parameters:

realm - the realm

Method Details

getRealm

public String getRealm()

Returns the realm.

Returns:

the realm

createChallenge

protected String createChallenge(SecurityException cause)

Description copied from class: HttpAuthenticationErrorInterceptor

Creates the challenge to send to the requester.

Specified by:

createChallenge in class HttpAuthenticationErrorInterceptor<A extends ExchangeContext,B extends ErrorExchange<A>>

Parameters:

cause - the cause of the error (can be null)

Returns:

a challenge