Top Description Fields Constructors Methods
org.eclipse.microprofile.jwt

public Class ClaimLiteral

extends AnnotationLiteral<Claim>
implements Claim
Class Inheritance
All Implemented Interfaces
org.eclipse.microprofile.jwt.Claim, java.lang.annotation.Annotation
Imports
jakarta.enterprise.util.AnnotationLiteral
Annotation literal for Claim

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides jakarta.enterprise.util.AnnotationLiteral.serialVersionUID.

private Claims
standard

private String
value

Constructor Summary

AccessConstructor and Description
public
ClaimLiteral()

Creates a default value Claim literal

public
ClaimLiteral(String
- the string name for claim
value)

Construct a Claim literal from a string name of a claim

public
ClaimLiteral(Claims
- the claim enum value
standard)

Construct a Claim literal from a standard claim defined in Claims

Method Summary

Modifier and TypeMethod and Description
public Claims
standard()

Implements org.eclipse.microprofile.jwt.Claim.standard.

An alternate way of specifying a claim name using the Claims enum

public String
value()

Implements org.eclipse.microprofile.jwt.Claim.value.

The value specifies the id name the claim to inject

Inherited from jakarta.enterprise.util.AnnotationLiteral:
annotationTypeequalshashCodetoString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides jakarta.enterprise.util.AnnotationLiteral.serialVersionUID.

standardback to summary
private Claims standard
valueback to summary
private String value

Constructor Detail

ClaimLiteralback to summary
public ClaimLiteral()

Creates a default value Claim literal

ClaimLiteralback to summary
public ClaimLiteral(String value)

Construct a Claim literal from a string name of a claim

Parameters
value:String

- the string name for claim

ClaimLiteralback to summary
public ClaimLiteral(Claims standard)

Construct a Claim literal from a standard claim defined in Claims

Parameters
standard:Claims

- the claim enum value

Method Detail

standardback to summary
public Claims standard()

Implements org.eclipse.microprofile.jwt.Claim.standard.

Doc from org.eclipse.microprofile.jwt.Claim.standard.

An alternate way of specifying a claim name using the Claims enum

Returns:Claims

the claim enum

Annotations
@Override
valueback to summary
public String value()

Implements org.eclipse.microprofile.jwt.Claim.value.

Doc from org.eclipse.microprofile.jwt.Claim.value.

The value specifies the id name the claim to inject

Returns:String

the claim name

Annotations
@Override