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 AuthenticationException	exception()
static AuthenticationException	exception(AuthenticationFailureReason reason)
static AuthenticationException	exception(String message)
static AuthenticationResponse	failure()
static AuthenticationResponse	failure(AuthenticationFailureReason reason)
static AuthenticationResponse	failure(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 AuthenticationResponse	success(String username)
static AuthenticationResponse	success(String username, Collection<String> roles)
static AuthenticationResponse	success(String username, Collection<String> roles, Map<String,Object> attributes)
static AuthenticationResponse	success(String username, 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 AuthenticationResponse success(@NonNull
 String username)

Parameters:

username - User's name

Returns:

A successful AuthenticationResponse

success

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

Parameters:

username - User's name

roles - Users's roles

Returns:

A successful AuthenticationResponse

success

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

Parameters:

username - User's name

attributes - User's attributes

Returns:

A successful AuthenticationResponse

success

@NonNull
static AuthenticationResponse success(@NonNull
 String username,
 @NonNull
 Collection<String> roles,
 @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 AuthenticationResponse failure(@NonNull
 String message)

failure

@NonNull
static AuthenticationResponse failure(@NonNull
 AuthenticationFailureReason reason)

failure

@NonNull
static AuthenticationResponse failure()

exception

@NonNull
static AuthenticationException exception(@NonNull
 String message)

exception

@NonNull
static AuthenticationException exception(@NonNull
 AuthenticationFailureReason reason)

exception

@NonNull
static AuthenticationException exception()