Package org.microproxy

Interface AuthResult

All Known Implementing Classes:

AuthResult.Accepted, AuthResult.Rejected

public sealed interface AuthResult
permits AuthResult.Accepted, AuthResult.Rejected

What a ProxyAuthenticator decided about a request.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	AuthResult.Accepted	The client may use the proxy.
static final record	AuthResult.Rejected	The client may not use the proxy.

Method Summary

Static Methods

Modifier and Type	Method	Description
static AuthResult	accept(String userName)	Accepts the client with the given user name.
static AuthResult	reject()	Rejects with the proxy's default 407 challenge.
static AuthResult	reject(HttpResponse challenge)	Rejects with challenge; see AuthResult.Rejected.

Method Details

accept

static AuthResult accept(String userName)

Accepts the client with the given user name.

Parameters:

userName - the authenticated user name, or null if unknown

Returns:

an accepted authentication result

reject

static AuthResult reject()

Rejects with the proxy's default 407 challenge.

Returns:

a rejected authentication result

reject

static AuthResult reject(HttpResponse challenge)

Rejects with challenge; see AuthResult.Rejected.

Parameters:

challenge - the response to send when rejecting the client

Returns:

a rejected authentication result