Struct OAuth2RefreshProvider 

pub struct OAuth2RefreshProvider { /* private fields */ }

Available on crate feature auth only.

OAuth2 refresh_token grant provider with refresh-token rotation capture.

When a durable StateStore is attached (via persist: config, #499), the rotated refresh_token is written back after every refresh and re-read on startup — so a second scheduled run authenticates with the current token instead of the now-invalidated config seed.

Implementations

impl OAuth2RefreshProvider

pub fn from_config(config: &Value) -> Result<OAuth2RefreshProvider, FaucetError>

Build from a config object with token_url, client_id, client_secret, refresh_token, and optional scope / expiry_ratio / persist.

pub fn with_store( self, store: Arc<dyn StateStore>, key: impl Into<String>, ) -> OAuth2RefreshProvider

Attach a durable store for the rotated refresh token (used by tests and library callers that supply their own StateStore). key must be stable across runs for the same logical provider.

Trait Implementations

impl AuthProvider for OAuth2RefreshProvider

fn credential<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Credential, FaucetError>> + Send + 'async_trait>>

where 'life0: 'async_trait, OAuth2RefreshProvider: 'async_trait,

Return a currently-valid credential, refreshing if needed.

fn invalidate<'life0, 'life1, 'async_trait>( &'life0 self, stale: &'life1 Credential, ) -> Pin<Box<dyn Future<Output = Result<Credential, FaucetError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, OAuth2RefreshProvider: 'async_trait,

Force a refresh iff the cached credential still equals stale (compare-and-swap). Multiple connectors that hit a 401 with the same token collapse into a single refresh; callers holding an already-rotated token get the new one without triggering another fetch.

fn provider_name(&self) -> &'static str

Stable, non-empty name for diagnostics and metrics.

fn sign_request<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _method: &'life1 str, _url: &'life2 str, _query: &'life3 BTreeMap<String, String>, ) -> Pin<Box<dyn Future<Output = Result<Option<Credential>, FaucetError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, Self: 'async_trait,

Per-request signing hook (OAuth1 and similar, #496).

fn request_auth<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _method: &'life1 str, _url: &'life2 str, _query: &'life3 BTreeMap<String, String>, ) -> Pin<Box<dyn Future<Output = Result<RequestAuth, FaucetError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, Self: 'async_trait,

Richer per-request auth for multi-step flows (#511): credential placements across header / query / cookie / body plus an optional dynamic base-URL override.

fn reauth_statuses(&self) -> &[u16]

HTTP status codes on which the connector should force a re-auth (via invalidate) and retry the request once.

impl Debug for OAuth2RefreshProvider

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.