Struct yup_oauth2::Authenticator

pub struct Authenticator<T: GetToken, S: TokenStorage, AD: AuthenticatorDelegate, C: Connect> { /* fields omitted */ }

Authenticator abstracts different GetToken implementations behind one type and handles caching received tokens. It's important to use it (instead of the flows directly) because otherwise the user needs to be asked for new authorization every time a token is generated.

ServiceAccountAccess does not need (and does not work) with Authenticator, given that it does not require interaction and implements its own caching. Use it directly.

NOTE: It is recommended to use a client constructed like this in order to prevent functions like hyper::run() from hanging: let client = hyper::Client::builder().keep_alive(false);. Due to token requests being rare, this should not result in a too bad performance problem.

Methods

impl<T: GetToken, AD: AuthenticatorDelegate, C: Connect> Authenticator<T, MemoryStorage, AD, C>

pub fn new(
    client: Client<C>,
    inner: T,
    delegate: AD
) -> Authenticator<T, MemoryStorage, AD, C>

Create an Authenticator caching tokens for the duration of this authenticator.

impl<T: GetToken, AD: AuthenticatorDelegate, C: Connect> Authenticator<T, DiskTokenStorage, AD, C>

pub fn new_disk<P: AsRef<str>>(
    client: Client<C>,
    inner: T,
    delegate: AD,
    token_storage_path: P
) -> Result<Authenticator<T, DiskTokenStorage, AD, C>>

Create an Authenticator using the store at path.

Trait Implementations

impl<GT: 'static + GetToken + Send, S: 'static + TokenStorage + Send, AD: 'static + AuthenticatorDelegate + Send, C: 'static + Connect + Clone + Send> GetToken for Authenticator<GT, S, AD, C>

fn api_key(&mut self) -> Option<String>

Returns the API Key of the inner flow.

fn application_secret(&self) -> ApplicationSecret

Returns the application secret of the inner flow.

fn token<I, T>(
    &mut self,
    scopes: I
) -> Box<dyn Future<Item = Token, Error = RequestError> + Send> where
    T: Into<String>,
    I: IntoIterator<Item = T>,