Index (flash-ext-oidc 2.1.0-d3fe740 API)

A B C D E F G H I J K M N O P R S T U V
All Classes and Interfaces|All Packages|Serialized Form

A

accessToken() - Method in class dev.relism.flash.ext.oidc.OidcSession
accessTokenExpiresAt() - Method in class dev.relism.flash.ext.oidc.OidcSession
algorithm() - Method in class dev.relism.flash.ext.oidc.OidcConfig
algorithm(String) - Method in class dev.relism.flash.ext.oidc.OidcConfig.Builder: JWS algorithm (default: RS256).
ALL - Enum constant in enum class dev.relism.flash.ext.oidc.ScopesAllowed.Match: All required scopes must be present.
ANY - Enum constant in enum class dev.relism.flash.ext.oidc.ScopesAllowed.Match: Any one required scope is sufficient.
Authenticated - Annotation Interface in dev.relism.flash.ext.oidc: Marks a handler as requiring a valid JWT.
authorizationEndpoint() - Method in record class dev.relism.flash.ext.oidc.OidcProviderMetadata: Returns the value of the authorizationEndpoint record component.
authorize(OidcAuthPolicy) - Method in class dev.relism.flash.ext.oidc.OidcMiddleware: Compiled authorization policy path used by annotation-driven mounting.

B

BASIC - Enum constant in enum class dev.relism.flash.ext.oidc.ClientAuthMethod: client_secret_basic — credentials in the Authorization header.
build() - Method in class dev.relism.flash.ext.oidc.OidcConfig.Builder
builder(String, String, String, String) - Static method in class dev.relism.flash.ext.oidc.OidcConfig

C

claim(String) - Static method in class dev.relism.flash.ext.oidc.ClaimsHolder: Returns the value of a single claim as a String, or null if the claim is absent or the request is not authenticated.
claim(String) - Method in class dev.relism.flash.ext.oidc.OidcUser: Returns the raw claim value, or null if absent.
claim(String, Class<T>) - Method in class dev.relism.flash.ext.oidc.OidcUser: Returns the value of any claim, cast to T.
claims() - Method in class dev.relism.flash.ext.oidc.OidcSession
claims() - Method in class dev.relism.flash.ext.oidc.OidcUser: Escape hatch — returns the full unmodified claims map.
ClaimsHolder - Class in dev.relism.flash.ext.oidc: Thread-local store for JWT claims, populated by the OIDC middleware before the handler runs and cleared in the finally block afterward.
clientAuthMethod() - Method in class dev.relism.flash.ext.oidc.OidcConfig
clientAuthMethod(ClientAuthMethod) - Method in class dev.relism.flash.ext.oidc.OidcConfig.Builder: Token endpoint client authentication method (default: ClientAuthMethod.POST).
ClientAuthMethod - Enum Class in dev.relism.flash.ext.oidc: OAuth2 client authentication method for the token endpoint (RFC 6749 §2.3).
clientId() - Method in class dev.relism.flash.ext.oidc.OidcConfig
clientSecret() - Method in class dev.relism.flash.ext.oidc.OidcConfig
configure(FlashRegistrar<?>, FlashContext) - Method in class dev.relism.flash.ext.oidc.OidcExtension

D

delete(String) - Method in class dev.relism.flash.ext.oidc.InMemoryOidcSessionStore
delete(String) - Method in interface dev.relism.flash.ext.oidc.OidcSessionStore
dev.relism.flash.ext.oidc - package dev.relism.flash.ext.oidc

E

email() - Method in class dev.relism.flash.ext.oidc.OidcUser: User's email address (email claim).
endSessionEndpoint() - Method in record class dev.relism.flash.ext.oidc.OidcProviderMetadata: Returns the value of the endSessionEndpoint record component.
equals(Object) - Method in record class dev.relism.flash.ext.oidc.OidcProviderMetadata: Indicates whether some other object is "equal to" this one.

F

find(String) - Method in class dev.relism.flash.ext.oidc.InMemoryOidcSessionStore
find(String) - Method in interface dev.relism.flash.ext.oidc.OidcSessionStore
fromEnv() - Static method in class dev.relism.flash.ext.oidc.OidcConfig: Reads configuration from environment variables:

G

get() - Static method in class dev.relism.flash.ext.oidc.ClaimsHolder: Returns the raw claims map for the current request, or null if the route is not protected by OIDC middleware.

H

hashCode() - Method in record class dev.relism.flash.ext.oidc.OidcProviderMetadata: Returns a hash code value for this object.
hasRole(String, String) - Method in class dev.relism.flash.ext.oidc.OidcUser: Returns true if the user holds role at the given claim path.
hasScope(String) - Method in class dev.relism.flash.ext.oidc.OidcUser: Returns true if the user has scope, searching default claim paths scope,scp.
hasScope(String, String) - Method in class dev.relism.flash.ext.oidc.OidcUser: Returns true if the user has scope in any of claimPaths.
https() - Method in class dev.relism.flash.ext.oidc.OidcConfig.Builder: Shorthand for selfScheme("https").

I

id() - Method in class dev.relism.flash.ext.oidc.OidcSession
idToken() - Method in class dev.relism.flash.ext.oidc.OidcSession
InMemoryOidcSessionStore - Class in dev.relism.flash.ext.oidc: Thread-safe in-memory OidcSessionStore.
InMemoryOidcSessionStore() - Constructor for class dev.relism.flash.ext.oidc.InMemoryOidcSessionStore
insecureTls() - Method in class dev.relism.flash.ext.oidc.OidcConfig.Builder: Disables TLS certificate verification for all HTTP calls made by this extension.
insecureTls() - Method in class dev.relism.flash.ext.oidc.OidcConfig: If true, TLS certificate validation is skipped.
isAccessTokenExpired() - Method in class dev.relism.flash.ext.oidc.OidcSession: Returns true if the access token has expired or will expire within the next 30 seconds (eager refresh to avoid mid-request expiry).
isJwt(String) - Static method in class dev.relism.flash.ext.oidc.JwtValidator: Returns true if token is a signed JWT (three dot-separated Base64URL parts).
issuer() - Method in class dev.relism.flash.ext.oidc.OidcConfig
issuer() - Method in class dev.relism.flash.ext.oidc.OidcMiddleware: OIDC issuer this middleware validates tokens against — the iss claim it enforces.

J

jwksUri() - Method in record class dev.relism.flash.ext.oidc.OidcProviderMetadata: Returns the value of the jwksUri record component.
JwtValidator - Class in dev.relism.flash.ext.oidc: Validates JWTs against a remote JWKS endpoint using Nimbus JOSE+JWT.
JwtValidator(String, String, String, String, HttpClient) - Constructor for class dev.relism.flash.ext.oidc.JwtValidator

K

keycloak(String, String, String, String, String) - Static method in class dev.relism.flash.ext.oidc.OidcConfig: Convenience factory for Keycloak: constructs the issuer as {serverUrl}/realms/{realm} automatically.

M

match() - Element in annotation interface dev.relism.flash.ext.oidc.ScopesAllowed: Matching mode for ScopesAllowed.value().

N

name() - Method in class dev.relism.flash.ext.oidc.OidcUser: Full display name (name claim).

O

OidcConfig - Class in dev.relism.flash.ext.oidc: Full OIDC client configuration.
OidcConfig.Builder - Class in dev.relism.flash.ext.oidc
OidcExtension - Class in dev.relism.flash.ext.oidc: Full OIDC Authorization Code + PKCE flow for Flash.
OidcExtension(OidcConfig) - Constructor for class dev.relism.flash.ext.oidc.OidcExtension
OidcMiddleware - Class in dev.relism.flash.ext.oidc: Request-level OIDC middleware.
OidcProviderMetadata - Record Class in dev.relism.flash.ext.oidc: OIDC provider endpoints discovered from {issuer}/.well-known/openid-configuration.
OidcProviderMetadata(String, String, String, String, String) - Constructor for record class dev.relism.flash.ext.oidc.OidcProviderMetadata: Creates an instance of a OidcProviderMetadata record class.
OidcSession - Class in dev.relism.flash.ext.oidc: An authenticated user's OIDC session — persisted in OidcSessionStore and looked up via the oidc_session cookie on every request.
OidcSession(String, String, String, String, Instant, Map<String, Object>) - Constructor for class dev.relism.flash.ext.oidc.OidcSession
OidcSessionStore - Interface in dev.relism.flash.ext.oidc: Backing store for OidcSession objects.
OidcUser - Class in dev.relism.flash.ext.oidc: Type-safe view over the JWT claims stored in ClaimsHolder.
OidcValidationException - Exception Class in dev.relism.flash.ext.oidc: Thrown when OIDC token validation fails (signature, claims, nonce, expiry, etc.).
OidcValidationException(String, Throwable) - Constructor for exception class dev.relism.flash.ext.oidc.OidcValidationException
optional() - Element in annotation interface dev.relism.flash.ext.oidc.Authenticated: When true the middleware never rejects unauthenticated requests — it only populates ClaimsHolder when valid credentials are present.
optional() - Method in class dev.relism.flash.ext.oidc.OidcMiddleware: Silently populates ClaimsHolder if a valid bearer token or session cookie is present, but never rejects or redirects unauthenticated requests.

P

POST - Enum constant in enum class dev.relism.flash.ext.oidc.ClientAuthMethod: client_secret_post — credentials in the request body.
postLogoutRedirectUri() - Method in class dev.relism.flash.ext.oidc.OidcConfig
postLogoutRedirectUri(String) - Method in class dev.relism.flash.ext.oidc.OidcConfig.Builder: Where to redirect after logout (default: /).
protect() - Method in class dev.relism.flash.ext.oidc.OidcMiddleware: Validates the bearer token or session cookie.
protect(String) - Method in class dev.relism.flash.ext.oidc.OidcMiddleware: Like protect(), but a 401 challenge also carries resource_metadata (RFC 9728 §5.1), resolved against this request's own scheme/host exactly like OidcExtension's redirect URIs.

R

redirectUri() - Method in class dev.relism.flash.ext.oidc.OidcConfig
refreshToken() - Method in class dev.relism.flash.ext.oidc.OidcSession
requireAnyScope(String...) - Method in class dev.relism.flash.ext.oidc.OidcMiddleware: Requires at least one of the listed scopes to be present in the token.
requireRole(String...) - Method in class dev.relism.flash.ext.oidc.OidcMiddleware: Like protect() but also enforces that the caller holds at least one of the given roles (OR semantics).
requireScopes(String...) - Method in class dev.relism.flash.ext.oidc.OidcMiddleware: Requires all listed scopes to be present in the token.
roles(String) - Method in class dev.relism.flash.ext.oidc.OidcUser: Extracts the roles list by traversing a dot-separated claim path.
RolesAllowed - Annotation Interface in dev.relism.flash.ext.oidc: Restricts a handler to callers whose JWT contains at least one of the specified roles.
rolesClaimPath() - Method in class dev.relism.flash.ext.oidc.OidcConfig
rolesClaimPath() - Method in class dev.relism.flash.ext.oidc.OidcMiddleware: The single configured claim path used by every transport for role checks.
rolesClaimPath(String) - Method in class dev.relism.flash.ext.oidc.OidcConfig.Builder: Dot-separated path to the roles array in JWT claims (default: realm_access.roles).
routePrefix() - Method in class dev.relism.flash.ext.oidc.OidcConfig
routePrefix(String) - Method in class dev.relism.flash.ext.oidc.OidcConfig.Builder: Route prefix for login/callback/logout (default: /auth).

S

save(OidcSession) - Method in class dev.relism.flash.ext.oidc.InMemoryOidcSessionStore
save(OidcSession) - Method in interface dev.relism.flash.ext.oidc.OidcSessionStore
schemeName() - Method in class dev.relism.flash.ext.oidc.OidcConfig: OpenAPI security scheme name (derived from issuer if not set explicitly).
schemeName(String) - Method in class dev.relism.flash.ext.oidc.OidcConfig.Builder: Override the OpenAPI security scheme name (default: derived from the issuer URI).
scopeClaimPaths() - Method in class dev.relism.flash.ext.oidc.OidcConfig: Comma-separated claim paths used to read OAuth2 scopes (default: "scope,scp").
scopeClaimPaths(String) - Method in class dev.relism.flash.ext.oidc.OidcConfig.Builder: Comma-separated claim paths used to resolve OAuth2 scopes (default: scope,scp).
scopes() - Method in class dev.relism.flash.ext.oidc.OidcConfig
scopes() - Method in class dev.relism.flash.ext.oidc.OidcUser: Resolves OAuth2 scopes from standard OIDC/OAuth claims using fallback order: scope then scp.
scopes(String) - Method in class dev.relism.flash.ext.oidc.OidcConfig.Builder: Override requested scopes (default: openid profile email).
scopes(String) - Method in class dev.relism.flash.ext.oidc.OidcUser: Resolves scopes from comma-separated claim paths (example: "scope,scp,permissions.scopes").
ScopesAllowed - Annotation Interface in dev.relism.flash.ext.oidc: Restricts a handler to callers whose token carries the required OAuth2 scopes.
ScopesAllowed.Match - Enum Class in dev.relism.flash.ext.oidc
selfOrigin(Request, String) - Static method in class dev.relism.flash.ext.oidc.OidcMiddleware: scheme://host clients actually reach this app on — the basis for every absolute URL it publishes about itself (OAuth2 redirect_uri, the RFC 9728 resource identifier and the resource_metadata challenge).
selfScheme() - Method in class dev.relism.flash.ext.oidc.OidcConfig
selfScheme() - Method in class dev.relism.flash.ext.oidc.OidcMiddleware: Scheme used to build this app's own absolute URLs — see OidcConfig.selfScheme().
selfScheme(String) - Method in class dev.relism.flash.ext.oidc.OidcConfig.Builder: Scheme used when resolving self-relative redirect URIs (default: http).
sessionStore() - Method in class dev.relism.flash.ext.oidc.OidcConfig
sessionStore(OidcSessionStore) - Method in class dev.relism.flash.ext.oidc.OidcConfig.Builder: Custom session store (default: InMemoryOidcSessionStore).
sub() - Method in class dev.relism.flash.ext.oidc.OidcUser: Subject identifier — unique, stable user ID issued by the provider.

T

tokenEndpoint() - Method in record class dev.relism.flash.ext.oidc.OidcProviderMetadata: Returns the value of the tokenEndpoint record component.
toString() - Method in record class dev.relism.flash.ext.oidc.OidcProviderMetadata: Returns a string representation of this record class.

U

user() - Static method in class dev.relism.flash.ext.oidc.ClaimsHolder: Returns a type-safe OidcUser view of the current request's claims, or null if the route is not protected by OIDC middleware.
userinfoEndpoint() - Method in record class dev.relism.flash.ext.oidc.OidcProviderMetadata: Returns the value of the userinfoEndpoint record component.
username() - Method in class dev.relism.flash.ext.oidc.OidcUser: Human-readable username (preferred_username claim).

V

validate(String) - Method in class dev.relism.flash.ext.oidc.JwtValidator: Validates a JWT access token (bearer on incoming request).
validateIdToken(String, String) - Method in class dev.relism.flash.ext.oidc.JwtValidator: Validates an ID token received directly from the token endpoint.
value() - Element in annotation interface dev.relism.flash.ext.oidc.RolesAllowed: One or more role names.
value() - Element in annotation interface dev.relism.flash.ext.oidc.ScopesAllowed: Required scopes.
valueOf(String) - Static method in enum class dev.relism.flash.ext.oidc.ClientAuthMethod: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class dev.relism.flash.ext.oidc.ScopesAllowed.Match: Returns the enum constant of this class with the specified name.
values() - Static method in enum class dev.relism.flash.ext.oidc.ClientAuthMethod: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class dev.relism.flash.ext.oidc.ScopesAllowed.Match: Returns an array containing the constants of this enum class, in the order they are declared.

A B C D E F G H I J K M N O P R S T U V
All Classes and Interfaces|All Packages|Serialized Form