Package jakarta.security.enterprise.authentication.mechanism.http

The HTTP authentication mechanism API package. This package contains classes and interfaces associated with authentication mechanisms that specifically target HTTP as environment to interact with a caller (challenge/response, obtain credentials).

Version:

1.0

Interface Summary

Interface	Description
HttpAuthenticationMechanism	HttpAuthenticationMechanism is a mechanism for obtaining a caller's credentials in some way, using the HTTP protocol where necessary.
HttpMessageContext	HttpMessageContext contains all of the per-request state information and encapsulates the client request, server response, container handler for authentication callbacks, and the subject representing the caller.

Class Summary

Class	Description
AuthenticationParameters	Parameters that are provided along with an authentication request.
AutoApplySession.Literal	Supports inline instantiation of the AutoApplySession annotation.
HttpAuthenticationMechanismWrapper	This class is an implementation of the HttpAuthenticationMechanism interface that can be subclassed by developers wishing to provide extra or different functionality.
HttpMessageContextWrapper	This class is an implementation of the HttpMessageContext interface that can be subclassed by developers wishing to provide extra or different functionality.
LoginToContinue.Literal	Supports inline instantiation of the LoginToContinue annotation.
RememberMe.Literal	Supports inline instantiation of the RememberMe annotation.

Annotation Types Summary

Annotation Type	Description
AutoApplySession	The AutoApplySession annotation provides an application the ability to declaratively designate that an authentication mechanism uses the jakarta.servlet.http.registerSession and auto applies this for every request.
BasicAuthenticationMechanismDefinition	Annotation used to define a container authentication mechanism that implements the HTTP basic access authentication protocol as defined by the Servlet spec (13.6.1) and make that implementation available as an enabled CDI bean.
CustomFormAuthenticationMechanismDefinition	Annotation used to define a container authentication mechanism that implements authentication resembling Servlet FORM authentication (Servlet spec 13.6.3).
FormAuthenticationMechanismDefinition	Annotation used to define a container authentication mechanism that implements FORM authentication as defined by the Servlet spec (13.6.3) and make that implementation available as an enabled CDI bean.
LoginToContinue	The LoginToContinue annotation provides an application the ability to declaratively add login to continue functionality to an authentication mechanism.
OpenIdAuthenticationMechanismDefinition	Annotation used to define a container authentication mechanism that implements the Authorization Code flow and Refresh tokens as defined by the OpenId Connect specification and make that implementation available as an enabled CDI bean.
RememberMe	The RememberMe annotation provides an application the ability to declaratively designate that an authentication mechanism effectively "remembers" the authentication and auto applies this with every request.