Package net.ltgt.oidc.servlet

Interface UserPrincipalFactory

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 UserPrincipalFactory

Creates instances of UserPrincipal to be exposed as requests' principal.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTEXT_ATTRIBUTE_NAME

Method Summary

Modifier and Type	Method	Description
UserPrincipal	createUserPrincipal(SessionInfo sessionInfo, HttpSession session)	Called on each request by the UserFilter to create the UserPrincipal for the authenticated user; that will be exposed downward the filter chain as the request's principal.
default void	userAuthenticated(SessionInfo sessionInfo, HttpSession session)	Called by the CallbackServlet when the user is successfully authenticated.

Field Details

CONTEXT_ATTRIBUTE_NAME

static final String CONTEXT_ATTRIBUTE_NAME

Method Details

createUserPrincipal

UserPrincipal createUserPrincipal(SessionInfo sessionInfo,
 HttpSession session)

Called on each request by the UserFilter to create the UserPrincipal for the authenticated user; that will be exposed downward the filter chain as the request's principal.

This method can use data put in the session by userAuthenticated(net.ltgt.oidc.servlet.SessionInfo, jakarta.servlet.http.HttpSession) to expose in a custom UserPrincipal implementation.

userAuthenticated

default void userAuthenticated(SessionInfo sessionInfo,
 HttpSession session)

Called by the CallbackServlet when the user is successfully authenticated.

This can be used to load additional user data into the session, that can be used by createUserPrincipal(net.ltgt.oidc.servlet.SessionInfo, jakarta.servlet.http.HttpSession) when creating the principal, and/or to synchronize user information from the SessionInfo into a local database.