Skip to main content

AuthplaneClientBuilder

Struct AuthplaneClientBuilder 

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

Builder for AuthplaneClient.

Every knob defaults to the value AuthplaneClient::create uses, so a builder built without further configuration produces a client identical to one obtained from that constructor.

Implementations§

Source§

impl AuthplaneClientBuilder

Source

pub const DEFAULT_JWKS_REFRESH_SECONDS: u64 = 300

Default JWKS refresh interval.

Source

pub const DEFAULT_METADATA_REFRESH_SECONDS: u64 = 3600

Default AS-metadata refresh interval.

Source

pub fn new(issuer: impl Into<String>) -> Self

Build a builder seeded with SDK defaults.

Source

pub fn with_fetch_settings(self, fetch_settings: FetchSettings) -> Self

Outbound HTTP / SSRF policy. Applied to both AS metadata and JWKS document fetches — RFC 8414 / RFC 7517 share the same threat profile, so a single setting governs both.

Source

pub fn with_jwks_refresh_seconds(self, seconds: u64) -> Self

Override the JWKS refresh interval (seconds).

Source

pub fn with_metadata_refresh_seconds(self, seconds: u64) -> Self

Override the AS-metadata refresh interval (seconds).

Source

pub fn with_token_cache_ttl_buffer_seconds(self, buffer_seconds: f64) -> Self

Override the token-cache TTL buffer.

Source

pub fn with_default_token_ttl_seconds(self, seconds: f64) -> Self

Override the fallback token TTL used when the AS does not return one.

Source

pub fn with_circuit_breaker_threshold(self, threshold: u32) -> Self

Override the circuit-breaker threshold.

Source

pub fn with_circuit_breaker_cooldown_seconds( self, cooldown_seconds: f64, ) -> Self

Override the circuit-breaker cooldown (seconds).

Source

pub fn with_auth(self, provider: Arc<dyn AuthProvider>) -> Self

Store a default auth provider (e.g., ClientCredentialsProvider) so callers can use methods without passing credentials each time.

Source

pub fn with_dpop_provider(self, provider: Arc<DpopProvider>) -> Self

Wire an outbound DPoP provider so client_credentials / exchange_token / introspect / revoke use a shared signing key + nonce store when callers pass Some(&proof_options).

Source

pub fn with_metadata_change_callback( self, callback: MetadataChangeCallback, ) -> Self

Register an async callback fired when AS metadata changes (e.g. jwks_uri rotation).

Source

pub async fn build(self) -> Result<AuthplaneClient, AuthplaneError>

Build and initialize the AuthplaneClient.

Performs AS metadata discovery, validates the issuer, primes the JWKS cache, and returns a fully wired client ready to use.

Trait Implementations§

Source§

impl Clone for AuthplaneClientBuilder

Source§

fn clone(&self) -> Self

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

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: Sized + 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: Sized + 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 = !

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

fn try_from(value: U) -> Result<T, !>

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