AuthenticationContext (vaadin-spring 23.3.0 API)

java.lang.Object
- com.vaadin.flow.spring.security.AuthenticationContext

All Implemented Interfaces:

Serializable
```
public class AuthenticationContext
extends Object
implements Serializable
```
The authentication context of the application.
An instance of this class is available for injection as bean in view and layout classes. It allows to access authenticated user information and to initiate the logout process.

Since:

23.3

Author:

Vaadin Ltd

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

AuthenticationContext()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`<U> Optional<U>`	`getAuthenticatedUser(Class<U> userType)`	Gets an `Optional` with an instance of the current user if it has been authenticated, or empty if the user is not authenticated.
`boolean`	`isAuthenticated()`	Indicates whether a user is currently authenticated.
`void`	`logout()`	Initiates the logout process of the current authenticated user by invalidating the local session and then notifying `LogoutHandler`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AuthenticationContext
```
public AuthenticationContext()
```
- Method Detail
  - getAuthenticatedUser
```
public <U> Optional<U> getAuthenticatedUser(Class<U> userType)
```
    Gets an Optional with an instance of the current user if it has been authenticated, or empty if the user is not authenticated. Anonymous users are considered not authenticated.
    
    Type Parameters:
    
    U - the type parameter of the expected user instance
    
    Parameters:
    
    userType - the type of the expected user instance
    
    Returns:
    
    an Optional with the current authenticated user, or empty if none available
    
    Throws:
    
    ClassCastException - if the current user instance does not match the given userType.
  - isAuthenticated
```
public boolean isAuthenticated()
```
    Indicates whether a user is currently authenticated. Anonymous users are considered not authenticated.
    
    Returns:
    
    true if a user is currently authenticated, otherwise false
  - logout
```
public void logout()
```
    Initiates the logout process of the current authenticated user by invalidating the local session and then notifying LogoutHandler.