Package io.quarkus.oidc.client.filter.runtime

Class AbstractOidcClientRequestFilter

java.lang.Object

io.quarkus.oidc.client.runtime.AbstractTokensProducer

io.quarkus.oidc.client.filter.runtime.AbstractOidcClientRequestFilter

All Implemented Interfaces:

jakarta.ws.rs.client.ClientRequestFilter

Direct Known Subclasses:

OidcClientRequestFilter, OidcClientRequestFilter

public abstract class AbstractOidcClientRequestFilter
extends io.quarkus.oidc.client.runtime.AbstractTokensProducer
implements jakarta.ws.rs.client.ClientRequestFilter

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final String	REQUEST_FILTER_KEY

Fields inherited from class io.quarkus.oidc.client.runtime.AbstractTokensProducer

earlyTokenAcquisition, oidcClientBuildTimeConfig, oidcClientsConfig, oidcClientsInstance

Constructor Summary

Constructors

Constructor	Description
AbstractOidcClientRequestFilter()

Method Summary

Modifier and Type	Method	Description
void	filter(jakarta.ws.rs.client.ClientRequestContext requestContext)
protected io.quarkus.oidc.client.runtime.MethodDescription	getMethodDescription()	This method is overridden by generated filter classes if the filter should only be applied on the REST client method.
protected boolean	isForceNewTokens()
(package private) void	refreshAccessToken()
protected boolean	refreshOnUnauthorized()

Methods inherited from class io.quarkus.oidc.client.runtime.AbstractTokensProducer

additionalParameters, awaitTokens, client, clientId, getTokens, init, initTokens, isClientFeatureDisabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

REQUEST_FILTER_KEY

static final String REQUEST_FILTER_KEY

See Also:

• Constant Field Values

Constructor Details

AbstractOidcClientRequestFilter

public AbstractOidcClientRequestFilter()

Method Details

filter

public void filter(jakarta.ws.rs.client.ClientRequestContext requestContext)
            throws IOException

Specified by:

filter in interface jakarta.ws.rs.client.ClientRequestFilter

Throws:

IOException

isForceNewTokens

protected boolean isForceNewTokens()

Overrides:

isForceNewTokens in class io.quarkus.oidc.client.runtime.AbstractTokensProducer

refreshOnUnauthorized

protected boolean refreshOnUnauthorized()

Returns:

true if token that appears valid should be refreshed the next time this filter is applied

refreshAccessToken

void refreshAccessToken()

getMethodDescription

protected io.quarkus.oidc.client.runtime.MethodDescription getMethodDescription()

This method is overridden by generated filter classes if the filter should only be applied on the REST client method.

Returns:

REST client method description for which this filter should be applied; or null if applies to all methods