Skip to main content

SharedTokenProvider

Struct SharedTokenProvider 

Source
pub struct SharedTokenProvider { /* private fields */ }
Expand description

Thread-safe wrapper around DataCloudTokenProvider.

Allows sharing the DC JWT provider between multiple tasks/threads while ensuring exclusive access during token operations. All access is protected by a tokio::sync::Mutex.

§Example

use hyperdb_api_salesforce::{SalesforceAuthConfig, AuthMode, SharedTokenProvider};

let provider = SharedTokenProvider::new(config)?;

// Can be cloned and shared between tasks
let provider_clone = provider.clone();

tokio::spawn(async move {
    let dc_jwt = provider_clone.get_token().await.unwrap();
    // use dc_jwt.bearer_token() as the Authorization header
});

Implementations§

Source§

impl SharedTokenProvider

Source

pub fn new(config: SalesforceAuthConfig) -> SalesforceAuthResult<Self>

Creates a new shared DC JWT provider.

§Errors

Propagates any error from DataCloudTokenProvider::new: configuration validation failures or HTTP client construction failures (surfaced as SalesforceAuthError::Http).

Source

pub async fn get_token(&self) -> SalesforceAuthResult<DataCloudToken>

Gets a valid DC JWT.

§Errors

Propagates any error from DataCloudTokenProvider::get_token (HTTP failure, authorization rejection, JWT signing error, or token-parse failure during the refresh cycle).

Source

pub async fn refresh_token(&self) -> SalesforceAuthResult<DataCloudToken>

Forces a DC JWT refresh (reuses OAuth Access Token if still valid).

§Errors

Propagates any error from DataCloudTokenProvider::refresh_token.

Source

pub async fn force_refresh(&self) -> SalesforceAuthResult<DataCloudToken>

Forces a full refresh (both OAuth Access Token and DC JWT).

§Errors

Propagates any error from DataCloudTokenProvider::force_refresh.

Source

pub async fn bearer_token(&self) -> Option<String>

Returns the DC JWT bearer token string if a valid DC JWT is cached.

Source

pub async fn tenant_url(&self) -> Option<String>

Returns the tenant URL if a valid DC JWT is cached.

Source

pub async fn lakehouse_name(&self) -> SalesforceAuthResult<Option<String>>

Returns the lakehouse name for Hyper connection.

§Errors

Propagates SalesforceAuthError::TokenParse from DataCloudTokenProvider::lakehouse_name if the cached DC JWT’s tenant URL cannot be parsed into a valid lakehouse identifier.

Trait Implementations§

Source§

impl Clone for SharedTokenProvider

Source§

fn clone(&self) -> SharedTokenProvider

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SharedTokenProvider

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more