Module jakarta.security

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

Annotation Interface BasicAuthenticationMechanismDefinition

@Retention(RUNTIME)
@Target(TYPE)
@Repeatable(BasicAuthenticationMechanismDefinition.List.class)
public @interface 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.

Nested Class Summary

Nested Classes

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

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Class<?>[]	qualifiers	List of qualifier annotations.
String	realmName	Name of realm that will be sent via the WWW-Authenticate header.

Element Details

realmName

String realmName

Name of realm that will be sent via the WWW-Authenticate header.

Note that this realm name does not couple a named identity store configuration to the authentication mechanism.

Returns:

Name of realm

Default:

""

qualifiers

Class<?>[] qualifiers

List of qualifier annotations.

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

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

Returns:

list of qualifiers.

Since:

4.0

Default:

{jakarta.security.enterprise.authentication.mechanism.http.BasicAuthenticationMechanismDefinition.BasicAuthenticationMechanism.class}