authtoken

Documentation

Overview

Copyright (c) Microsoft Corporation. Licensed under the MIT license.

Index

• Variables
• func NewWriter(factory func() (io.WriteCloser, error)) interfaces.AuthTokenWriter
• type CreateTickerFuncType
• type Factory
  • func NewFactory(filePath string) Factory
  • func (w Factory) Create() (io.WriteCloser, error)
• type RefreshDurationFuncType
• type Refresher
  • func NewAuthTokenRefresher(tokenProvider interfaces.AuthTokenProvider, writer interfaces.AuthTokenWriter, ...) *Refresher
  • func (at *Refresher) RefreshToken(ctx context.Context) error
• type Writer
  • func (w *Writer) WriteToken(token interfaces.AuthToken) error

Variables

var (
	DefaultRefreshDurationFunc = func(token interfaces.AuthToken) time.Duration {
		return time.Until(token.ExpiresOn) / 2
	}
	DefaultCreateTicker    = time.Tick
	DefaultRefreshDuration = time.Second * 30
)

Functions

func NewWriter

func NewWriter(factory func() (io.WriteCloser, error)) interfaces.AuthTokenWriter

Types

type CreateTickerFuncType

type CreateTickerFuncType func(time.Duration) <-chan time.Time

type Factory

type Factory struct {
	// contains filtered or unexported fields
}

func NewFactory

func NewFactory(filePath string) Factory

func (Factory) Create

func (w Factory) Create() (io.WriteCloser, error)

type RefreshDurationFuncType

type RefreshDurationFuncType func(token interfaces.AuthToken) time.Duration

type Refresher

type Refresher struct {
	// contains filtered or unexported fields
}

func NewAuthTokenRefresher

func NewAuthTokenRefresher(tokenProvider interfaces.AuthTokenProvider,
	writer interfaces.AuthTokenWriter,
	refreshCalculate RefreshDurationFuncType,
	createTicker CreateTickerFuncType) *Refresher

func (*Refresher) RefreshToken

func (at *Refresher) RefreshToken(ctx context.Context) error

type Writer

type Writer struct {
	// contains filtered or unexported fields
}

func (*Writer) WriteToken

func (w *Writer) WriteToken(token interfaces.AuthToken) error