pub struct BearerAuthInterceptor { /* private fields */ }Expand description
A CallInterceptor that injects Authorization: Bearer <token> from a
TokenProvider before every request.
When the agent answers 401, it calls
TokenProvider::invalidate with the token it sent, so a refused token
is not sent again. That catches a 401 surfaced as
ClientError::UnexpectedStatus, which is how every binding reports it:
the gRPC transport maps UNAUTHENTICATED to a 401 for this reason. A
403 (gRPC PERMISSION_DENIED) leaves the token cached, since a caller
who is known and not allowed gains nothing from a new one.
Because the token is fetched per request, a provider that refreshes (like
OAuth2ClientCredentials) keeps long-lived clients authenticated across
token rotations — including on retries, which re-enter the transport below
the interceptor chain with the header this interceptor set for the call.
Like AuthInterceptor, it overwrites any
authorization header set earlier in the interceptor chain.
Implementations§
Source§impl BearerAuthInterceptor
impl BearerAuthInterceptor
Sourcepub fn new(provider: Arc<dyn TokenProvider>) -> Self
pub fn new(provider: Arc<dyn TokenProvider>) -> Self
Creates an interceptor backed by the given provider.
Trait Implementations§
Source§impl CallInterceptor for BearerAuthInterceptor
impl CallInterceptor for BearerAuthInterceptor
Source§fn on_error<'a>(
&'a self,
req: &'a ClientRequest,
err: &'a ClientError,
) -> impl Future<Output = ()> + Send + 'a
fn on_error<'a>( &'a self, req: &'a ClientRequest, err: &'a ClientError, ) -> impl Future<Output = ()> + Send + 'a
A 401 from the agent means the token this interceptor attached was
refused, so the provider is told to stop serving it. The failing call
still fails; the next one gets a fresh token. Other errors say
nothing about the token and leave it cached.
Source§fn before<'a>(
&'a self,
req: &'a mut ClientRequest,
) -> impl Future<Output = ClientResult<()>> + Send + 'a
fn before<'a>( &'a self, req: &'a mut ClientRequest, ) -> impl Future<Output = ClientResult<()>> + Send + 'a
Source§fn after<'a>(
&'a self,
_resp: &'a ClientResponse,
) -> impl Future<Output = ClientResult<()>> + Send + 'a
fn after<'a>( &'a self, _resp: &'a ClientResponse, ) -> impl Future<Output = ClientResult<()>> + Send + 'a
Auto Trait Implementations§
impl !RefUnwindSafe for BearerAuthInterceptor
impl !UnwindSafe for BearerAuthInterceptor
impl Freeze for BearerAuthInterceptor
impl Send for BearerAuthInterceptor
impl Sync for BearerAuthInterceptor
impl Unpin for BearerAuthInterceptor
impl UnsafeUnpin for BearerAuthInterceptor
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::Request