Package io.micronaut.security.authentication

Interface AuthenticationResponse

All Superinterfaces:

Serializable

All Known Implementing Classes:

AuthenticationFailed

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface AuthenticationResponse
extends Serializable

The response of an authentication attempt.

Since:

1.0

Author:

Sergio del Amo

Method Summary

Modifier and Type	Method	Description
static @NonNull AuthenticationException	exception()
static @NonNull AuthenticationException	exception(@NonNull AuthenticationFailureReason reason)
static @NonNull AuthenticationException	exception(@NonNull String message)
static @NonNull AuthenticationResponse	failure()
static @NonNull AuthenticationResponse	failure(@NonNull AuthenticationFailureReason reason)
static @NonNull AuthenticationResponse	failure(@NonNull String message)
Optional<Authentication>	getAuthentication()
default Optional<String>	getMessage()
default boolean	isAuthenticated()	If true, it is expected the getAuthentication() method will return a non empty optional.
static @NonNull AuthenticationResponse	success(@NonNull String username)
static @NonNull AuthenticationResponse	success(@NonNull String username, @NonNull Collection<String> roles)
static @NonNull AuthenticationResponse	success(@NonNull String username, @NonNull Collection<String> roles, @NonNull Map<String,Object> attributes)
static @NonNull AuthenticationResponse	success(@NonNull String username, @NonNull Map<String,Object> attributes)

Method Details

isAuthenticated

default boolean isAuthenticated()

If true, it is expected the getAuthentication() method will return a non empty optional.

Returns:

true or false depending on whether the user is authenticated

getAuthentication

Optional<Authentication> getAuthentication()

Returns:

The user details if the response is authenticated

getMessage

default Optional<String> getMessage()

Returns:

A message if the response chose to include one

success

@NonNull
static @NonNull AuthenticationResponse success(@NonNull
 @NonNull String username)

Parameters:

username - User's name

Returns:

A successful AuthenticationResponse

success

@NonNull
static @NonNull AuthenticationResponse success(@NonNull
 @NonNull String username,
 @NonNull
 @NonNull Collection<String> roles)

Parameters:

username - User's name

roles - Users's roles

Returns:

A successful AuthenticationResponse

success

@NonNull
static @NonNull AuthenticationResponse success(@NonNull
 @NonNull String username,
 @NonNull
 @NonNull Map<String,Object> attributes)

Parameters:

username - User's name

attributes - User's attributes

Returns:

A successful AuthenticationResponse

success

@NonNull
static @NonNull AuthenticationResponse success(@NonNull
 @NonNull String username,
 @NonNull
 @NonNull Collection<String> roles,
 @NonNull
 @NonNull Map<String,Object> attributes)

Parameters:

username - User's name

roles - Users's roles

attributes - User's attributes

Returns:

A successful AuthenticationResponse

failure

@NonNull
static @NonNull AuthenticationResponse failure(@NonNull
 @NonNull String message)

failure

@NonNull
static @NonNull AuthenticationResponse failure(@NonNull
 @NonNull AuthenticationFailureReason reason)

failure

@NonNull
static @NonNull AuthenticationResponse failure()

exception

@NonNull
static @NonNull AuthenticationException exception(@NonNull
 @NonNull String message)

exception

@NonNull
static @NonNull AuthenticationException exception(@NonNull
 @NonNull AuthenticationFailureReason reason)

exception

@NonNull
static @NonNull AuthenticationException exception()