Interface OAuthObserver
- All Superinterfaces:
JoseObserver
- All Known Subinterfaces:
AccessTokenObserver, OidcObserver
Receives synchronous, caller-thread OAuth events. Endpoint URIs contain only scheme, host, port and path;
callbacks and request bodies are never passed. Implementations must be thread-safe and fast. A hook failure is
contained by the caller except for
VirtualMachineError.- Since:
- 1.0.0
- Author:
- Mark Allen
-
Method Summary
Modifier and TypeMethodDescriptiondefault voiddidBeginAuthorization(@NonNull URI endpoint) Called after a browser authorization URL is prepared.default voidCalled once after a client successfully enables endpoint-audience assertion compatibility.default voiddidFailClientAssertionPreparation(@NonNull OAuthEndpoint endpoint, @NonNull OAuthException exception) Called once for assertion preparation failure before any endpoint will event.default voiddidFailEndpoint(@NonNull OAuthEndpoint endpoint, @NonNull URI uri, @NonNull OAuthException exception, @NonNull Duration elapsed) Called when an endpoint request fails.default voiddidRejectCallback(@NonNull OAuthValidationException exception) Called when a callback fails a local validation check.default voiddidRequestEndpoint(@NonNull OAuthEndpoint endpoint, @NonNull URI uri, @NonNull Integer status, @NonNull Duration elapsed) Called after a completed endpoint request.default voidCalled when endpoint-audience compatibility is selected for an actual assertion operation, including failure.default voidCalled when the explicit unencoded Basic interoperability mode is configured and on every request using it.static @NonNull OAuthObserverReturns an observer whose hooks do nothing.default voidwillRequestEndpoint(@NonNull OAuthEndpoint endpoint, @NonNull URI uri) Called before an OAuth endpoint request.Methods inherited from interface JoseObserver
didAcceptAnyAudience, didFailToFetchJwks, didFailToValidateJwt, didFetchJwks, didSkipJwk, didSuppressJwksFetch, didUseUnpatchedRuntime, didValidateJwt, willFetchJwksModifier and TypeMethodDescriptiondefault voiddidAcceptAnyAudience(@NonNull String issuer) Called when a validator configured to accept any audience is built, and on each of its validations, because accepting any audience lets a token issued for another application through.default voiddidFailToFetchJwks(@NonNull URI jwksUri, @NonNull JwksUnavailableException exception, @NonNull Boolean servingStaleKeys, @NonNull Duration elapsed) Called when a key set fetch failed, by the one caller that fetched it.default voiddidFailToValidateJwt(@NonNull RevetsecException exception, @NonNull Duration elapsed) Called whenJwtValidator.validateResult(String)rejects a token or cannot get its keys, before returning the rejection or propagating the key-source failure.default voiddidFetchJwks(@NonNull URI jwksUri, @NonNull Integer usableKeyCount, @NonNull Integer skippedKeyCount, @NonNull Duration timeToLive, @NonNull Duration elapsed) Called when a key set fetch succeeded, by the one caller that fetched it.default voiddidSkipJwk(@NonNull URI jwksUri, @NonNull Integer keyIndex, @NonNull JwkSkipReason reason) Called for each key a fetched key set holds but Revetsec does not use, on every fetch.default voiddidSuppressJwksFetch(@NonNull URI jwksUri, @NonNull Duration untilNextAttempt) Called on every call that needed a key set fetch but sent no request, because a recent failure, the unknown-key cooldown or the limit on attempts per cooldown held it back.default voiddidUseUnpatchedRuntime(@NonNull String runtimeVersion) Called when a component that acknowledged running below Revetsec's minimum Java runtime version is built, and on each of its fetches.default voiddidValidateJwt(@NonNull JwsAlgorithm algorithm, @NonNull Duration elapsed) Called whenJwtValidator.validateResult(String)accepted a token.default voidwillFetchJwks(@NonNull URI jwksUri) Called just before aRemoteJwksSourcesends a request for its key set, by the one caller that fetches it.
-
Method Details
-
disabledInstance
Returns an observer whose hooks do nothing.- Returns:
- the disabled observer
- Since:
- 1.0.0
-
didBeginAuthorization
Called after a browser authorization URL is prepared.- Parameters:
endpoint- its reduced endpoint URI- Since:
- 1.0.0
-
willRequestEndpoint
Called before an OAuth endpoint request.- Parameters:
endpoint- endpoint kinduri- its reduced URI- Since:
- 1.0.0
-
didRequestEndpoint
default void didRequestEndpoint(@NonNull OAuthEndpoint endpoint, @NonNull URI uri, @NonNull Integer status, @NonNull Duration elapsed) Called after a completed endpoint request.- Parameters:
endpoint- endpoint kinduri- its reduced URIstatus- HTTP statuselapsed- elapsed duration- Since:
- 1.0.0
-
didFailEndpoint
default void didFailEndpoint(@NonNull OAuthEndpoint endpoint, @NonNull URI uri, @NonNull OAuthException exception, @NonNull Duration elapsed) Called when an endpoint request fails. The exception is the same instance the caller receives.- Parameters:
endpoint- endpoint kinduri- its reduced URIexception- fixed-message exceptionelapsed- elapsed duration- Since:
- 1.0.0
-
didRejectCallback
Called when a callback fails a local validation check.- Parameters:
exception- fixed-message exception- Since:
- 1.0.0
-
didUseUnencodedBasic
Called when the explicit unencoded Basic interoperability mode is configured and on every request using it. No credential value is passed.- Since:
- 1.0.0
-
didEnableClientAssertionAudience
Called once after a client successfully enables endpoint-audience assertion compatibility.- Parameters:
audience- TOKEN_ENDPOINT compatibility selection- Since:
- 1.0.0
-
didUseClientAssertionAudience
Called when endpoint-audience compatibility is selected for an actual assertion operation, including failure.- Parameters:
audience- TOKEN_ENDPOINT compatibility selection- Since:
- 1.0.0
-
didFailClientAssertionPreparation
default void didFailClientAssertionPreparation(@NonNull OAuthEndpoint endpoint, @NonNull OAuthException exception) Called once for assertion preparation failure before any endpoint will event. The same fixed-message exception is received by the caller; no assertion or key is passed.- Parameters:
endpoint- selected POST roleexception- preparation failure- Since:
- 1.0.0
-