io.micronaut.security.authentication

Interface AuthenticationResponse

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AuthenticationFailed, UserDetails

public interface AuthenticationResponse
extends java.io.Serializable

The response of an authentication attempt.

Since:

1.0

Author:

Sergio del Amo

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.lang.String>	getMessage()
java.util.Optional<UserDetails>	getUserDetails()
default boolean	isAuthenticated() If true, it is expected the getUserDetails() method will return a non empty optional.

Method Detail

isAuthenticated

default boolean isAuthenticated()

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

Returns:

true or false depending on whether the user is authenticated

getUserDetails

java.util.Optional<UserDetails> getUserDetails()

Returns:

The user details if the response is authenticated

getMessage

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

Returns:

A message if the response chose to include one