Package io.micronaut.security.authentication

Interface AuthenticationResponse

All Superinterfaces:

java.io.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 java.io.Serializable

The response of an authentication attempt.

Since:

1.0

Method Summary

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

Method Detail

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

java.util.Optional<Authentication> getAuthentication()

Returns:

The user details if the response is authenticated

getMessage

default java.util.Optional<java.lang.String> getMessage()

Returns:

A message if the response chose to include one

success

@NonNull
static AuthenticationResponse success(@NonNull
                                      java.lang.String username)

Parameters:

username - User's name

Returns:

A successful AuthenticationResponse

success

@NonNull
static AuthenticationResponse success(@NonNull
                                      java.lang.String username,
                                      @NonNull
                                      java.util.Collection<java.lang.String> roles)

Parameters:

username - User's name

roles - Users's roles

Returns:

A successful AuthenticationResponse

success

@NonNull
static AuthenticationResponse success(@NonNull
                                      java.lang.String username,
                                      @NonNull
                                      java.util.Map<java.lang.String,java.lang.Object> attributes)

Parameters:

username - User's name

attributes - User's attributes

Returns:

A successful AuthenticationResponse

success

@NonNull
static AuthenticationResponse success(@NonNull
                                      java.lang.String username,
                                      @NonNull
                                      java.util.Collection<java.lang.String> roles,
                                      @NonNull
                                      java.util.Map<java.lang.String,java.lang.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
                                      java.lang.String message)

failure

@NonNull
static AuthenticationResponse failure(@NonNull
                                      AuthenticationFailureReason reason)

failure

@NonNull
static AuthenticationResponse failure()

exception

@NonNull
static AuthenticationException exception(@NonNull
                                         java.lang.String message)

exception

@NonNull
static AuthenticationException exception(@NonNull
                                         AuthenticationFailureReason reason)

exception

@NonNull
static AuthenticationException exception()