Package com.linecorp.armeria.server.auth

Interface AuthorizationStatus

@UnstableApi
public interface AuthorizationStatus

Provides a status of the request authorization operation, optionally combined with AuthSuccessHandler and AuthFailureHandler to facilitate custom status handling.

Method Summary

Modifier and Type	Method	Description
@Nullable AuthFailureHandler	failureHandler()	Returns the AuthFailureHandler to handle unauthorized requests.
boolean	isAuthorized()	A status of the request authorization operation.
static AuthorizationStatus	of(boolean isAuthorized)	Creates AuthorizationStatus based on the given boolean status, with neither AuthFailureHandler nor AuthSuccessHandler defined.
static AuthorizationStatus	ofFailure(@Nullable AuthFailureHandler failureHandler)	Creates AuthorizationStatus success status with optional AuthFailureHandler.
static AuthorizationStatus	ofSuccess()	Default Authorization Success status with no AuthSuccessHandler defined.
static AuthorizationStatus	ofSuccess(@Nullable AuthSuccessHandler successHandler)	Creates AuthorizationStatus success status with optional AuthSuccessHandler.
@Nullable AuthSuccessHandler	successHandler()	Returns the AuthSuccessHandler to handle successfully authorized requests.

Method Details

of

static AuthorizationStatus of(boolean isAuthorized)

Creates AuthorizationStatus based on the given boolean status, with neither AuthFailureHandler nor AuthSuccessHandler defined.

Parameters:

isAuthorized - Whether the request was authorized or not.

ofSuccess

static AuthorizationStatus ofSuccess()

Default Authorization Success status with no AuthSuccessHandler defined.

ofSuccess

static AuthorizationStatus ofSuccess(@Nullable
 @Nullable AuthSuccessHandler successHandler)

Creates AuthorizationStatus success status with optional AuthSuccessHandler.

ofFailure

static AuthorizationStatus ofFailure(@Nullable
 @Nullable AuthFailureHandler failureHandler)

Creates AuthorizationStatus success status with optional AuthFailureHandler.

isAuthorized

boolean isAuthorized()

A status of the request authorization operation.

Returns:

true if the request is authorized, or false otherwise.

successHandler

@Nullable
@Nullable AuthSuccessHandler successHandler()

Returns the AuthSuccessHandler to handle successfully authorized requests. It may return null, which indicates to use AuthService's default handling.

Returns:

An instance of AuthSuccessHandler to handle successfully authorized requests or null to rely on the default handling.

failureHandler

@Nullable
@Nullable AuthFailureHandler failureHandler()

Returns the AuthFailureHandler to handle unauthorized requests. It may return null, which indicates to use AuthService's default handling.

Returns:

An instance of AuthFailureHandler to handle unauthorized requests or null to rely on the default handling.