Top Description Inners Methods
jakarta.security.enterprise.authentication.mechanism.http

public @Interface BasicAuthenticationMechanismDefinition

extends Annotation
Annotations
@Retention:RUNTIME
@Target:TYPE
@Repeatable:List
Static Imports
java.lang.annotation.ElementType.FIELD, .ElementType.METHOD, .ElementType.PARAMETER, .ElementType.TYPE, .RetentionPolicy.RUNTIME

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 and Inner Type Summary

Modifier and TypeClass and Description
public static @interface
public static @interface
BasicAuthenticationMechanismDefinition.List

Enables multiple BasicAuthenticationMechanismDefinition annotations on the same type.

Method Summary

Modifier and TypeMethod and Description
public Class<?>[]

Returns:

list of qualifiers.
qualifiers
()

List of qualifier annotations.

public String

Returns:

Name of realm
realmName
()

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

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

qualifiersback to summary
public 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:Class<?>[]

list of qualifiers.

Since
4.0
realmNameback to summary
public 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:String

Name of realm

jakarta.security.enterprise.authentication.mechanism.http back to summary

public @Interface BasicAuthenticationMechanismDefinition.BasicAuthenticationMechanism

extends Annotation
Known Direct Implementers
jakarta.security.enterprise.authentication.mechanism.http.BasicAuthenticationMechanismDefinition.BasicAuthenticationMechanism.Literal
Annotations
@Qualifier
@Retention:RUNTIME
@Target:FIELD, METHOD, TYPE, PARAMETER

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Method Summary

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString
jakarta.security.enterprise.authentication.mechanism.http back to summary

public final Class BasicAuthenticationMechanismDefinition.BasicAuthenticationMechanism.Literal

extends AnnotationLiteral<BasicAuthenticationMechanismDefinition.BasicAuthenticationMechanism>
implements BasicAuthenticationMechanism
Class Inheritance
All Implemented Interfaces
jakarta.security.enterprise.authentication.mechanism.http.BasicAuthenticationMechanismDefinition.BasicAuthenticationMechanism, java.lang.annotation.Annotation

Supports inline instantiation of the BasicAuthenticationMechanism qualifier.
Since
4.0

Field Summary

Modifier and TypeField and Description
public static final BasicAuthenticationMechanismDefinition.BasicAuthenticationMechanism.Literal
INSTANCE

Instance of the BasicAuthenticationMechanism qualifier.

private static final long

Constructor Summary

AccessConstructor and Description
public

Field Detail

INSTANCEback to summary
public static final BasicAuthenticationMechanismDefinition.BasicAuthenticationMechanism.Literal INSTANCE

Instance of the BasicAuthenticationMechanism qualifier.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides jakarta.enterprise.util.AnnotationLiteral.serialVersionUID.

Constructor Detail

Literalback to summary
public Literal()
jakarta.security.enterprise.authentication.mechanism.http back to summary

public @Interface BasicAuthenticationMechanismDefinition.List

extends Annotation
Annotations
@Retention:RUNTIME
@Target:TYPE

Enables multiple BasicAuthenticationMechanismDefinition annotations on the same type.

Method Summary

Modifier and TypeMethod and Description
public BasicAuthenticationMechanismDefinition[]
Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

valueback to summary
public BasicAuthenticationMechanismDefinition[] value()