Module jakarta.security

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

Annotation Interface CustomFormAuthenticationMechanismDefinition

@Retention(RUNTIME)
@Target(TYPE)
@Repeatable(CustomFormAuthenticationMechanismDefinition.List.class)
public @interface CustomFormAuthenticationMechanismDefinition

Annotation used to define a container authentication mechanism that implements authentication resembling Servlet FORM authentication (Servlet spec 13.6.3).

Instead of posting back to a predefined action to continue the authentication dialog (Servlet spec 13.6.3 step 3), this variant depends on the application calling SecurityContext.authenticate(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse, jakarta.security.enterprise.authentication.mechanism.http.AuthenticationParameters)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	CustomFormAuthenticationMechanismDefinition.CustomFormAuthenticationMechanism
static @interface	CustomFormAuthenticationMechanismDefinition.List	Enables multiple CustomFormAuthenticationMechanismDefinition annotations on the same type.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
LoginToContinue	loginToContinue

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Class<?>[]	qualifiers	List of qualifier annotations.

Element Details

loginToContinue

LoginToContinue loginToContinue

qualifiers

Class<?>[] qualifiers

List of qualifier annotations.

An HttpAuthenticationMechanism injection point with these qualifier annotations injects a bean that is produced by this CustomFormAuthenticationMechanismDefinition.

The default value is CustomFormAuthenticationMechanism, indicating that this CustomFormAuthenticationMechanismDefinition produces bean instances of type HttpAuthenticationMechanism qualified by CustomFormAuthenticationMechanism.

Returns:

list of qualifiers.

Since:

4.0

Default:

{jakarta.security.enterprise.authentication.mechanism.http.CustomFormAuthenticationMechanismDefinition.CustomFormAuthenticationMechanism.class}