Top Description Methods
org.eclipse.microprofile.auth

public @Interface LoginConfig

extends Annotation
Annotations
@Inherited
@Documented
@Target:TYPE
@Retention:RUNTIME
Imports
java.lang.annotation.Documented, .ElementType, .Inherited, .Retention, .RetentionPolicy, .Target
A security annotation describing the authentication method and the associated realm name that should be used for this application.

Note

this annotation may be removed in the future versions of the MP JWT specification.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the configured auth-method
authMethod()

The 'authMethod' is used to configure the "MP-JWT" authentication mechanism for the JAX-RS application.

public String

Returns:

the realm name which may be empty
realmName()

The realm name

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

authMethodback to summary
public String authMethod()

The 'authMethod' is used to configure the "MP-JWT" authentication mechanism for the JAX-RS application. As a prerequisite to gaining access to any web resources which are protected by an authorization constraint, a user must have authenticated using the configured mechanism. Support for the other authentication mechanisms is optional.

Returns:String

the configured auth-method

realmNameback to summary
public String realmName()

The realm name

Returns:String

the realm name which may be empty