Documentation
¶
Index ¶
- Variables
- func AuthInfoWriter(s Session, outerValues [][]string, key string) runtime.ClientAuthInfoWriter
- func Basic(username, password string) runtime.ClientAuthInfoWriter
- func Bearer(token string) runtime.ClientAuthInfoWriter
- func ClientTokenRefresher(s Session)
- func ConfigRepo(s Session) runtime.ClientAuthInfoWriter
- func Cookie(s Session, key string) runtime.ClientAuthInfoWriter
- func CookieValue(key, value string) runtime.ClientAuthInfoWriter
- func Error(err error) runtime.ClientAuthInfoWriter
- func RefreshTokenScheduler(session Session, loginType string)
- func TokenRepo(s Session) runtime.ClientAuthInfoWriter
- func UserTokenRefresher(s Session)
- type ConfigRepositoryImpl
- type OAuth20RefreshService
- type ObservableTokenRepositoryImpl
- func (o *ObservableTokenRepositoryImpl) GetAccessToken() (string, error)
- func (o *ObservableTokenRepositoryImpl) RegisterObserver(observer repository.TokenRepositoryObserver) bool
- func (o *ObservableTokenRepositoryImpl) SetAccessToken(token interface{}) error
- func (o *ObservableTokenRepositoryImpl) UnregisterObserver(observer repository.TokenRepositoryObserver) bool
- type RefreshTokenImpl
- type Session
- type TokenRepositoryImpl
Constants ¶
This section is empty.
Variables ¶
View Source
var Once utils.Once
Functions ¶
func AuthInfoWriter ¶
func AuthInfoWriter(s Session, outerValues [][]string, key string) runtime.ClientAuthInfoWriter
AuthInfoWriter called by the existing security from the wrapper
func Basic ¶
func Basic(username, password string) runtime.ClientAuthInfoWriter
func Bearer ¶
func Bearer(token string) runtime.ClientAuthInfoWriter
func ClientTokenRefresher ¶ added in v0.23.0
func ClientTokenRefresher(s Session)
func ConfigRepo ¶
func ConfigRepo(s Session) runtime.ClientAuthInfoWriter
func CookieValue ¶
func CookieValue(key, value string) runtime.ClientAuthInfoWriter
func Error ¶
func Error(err error) runtime.ClientAuthInfoWriter
func RefreshTokenScheduler ¶ added in v0.23.0
func TokenRepo ¶
func TokenRepo(s Session) runtime.ClientAuthInfoWriter
func UserTokenRefresher ¶ added in v0.23.0
func UserTokenRefresher(s Session)
Types ¶
type ConfigRepositoryImpl ¶ added in v0.26.0
func DefaultConfigRepositoryImpl ¶ added in v0.26.0
func DefaultConfigRepositoryImpl() *ConfigRepositoryImpl
func (*ConfigRepositoryImpl) GetClientId ¶ added in v0.26.0
func (c *ConfigRepositoryImpl) GetClientId() string
func (*ConfigRepositoryImpl) GetClientSecret ¶ added in v0.26.0
func (c *ConfigRepositoryImpl) GetClientSecret() string
func (*ConfigRepositoryImpl) GetJusticeBaseUrl ¶ added in v0.26.0
func (c *ConfigRepositoryImpl) GetJusticeBaseUrl() string
type OAuth20RefreshService ¶ added in v0.21.0
type OAuth20RefreshService struct { Client *iamclient.JusticeIamService ConfigRepository repository.ConfigRepository Token repository.TokenRepository }
type ObservableTokenRepositoryImpl ¶ added in v0.67.0
type ObservableTokenRepositoryImpl struct { Observers []repository.TokenRepositoryObserver TokenRepo repository.TokenRepository }
func DefaultObservableTokenRepositoryImpl ¶ added in v0.67.0
func DefaultObservableTokenRepositoryImpl(tokenRepo repository.TokenRepository) *ObservableTokenRepositoryImpl
DefaultObservableTokenRepositoryImpl initializes a new ObservableTokenRepositoryImpl instance
func (*ObservableTokenRepositoryImpl) GetAccessToken ¶ added in v0.67.0
func (o *ObservableTokenRepositoryImpl) GetAccessToken() (string, error)
Implement TokenRepository methods for ObservableTokenRepositoryImpl
func (*ObservableTokenRepositoryImpl) RegisterObserver ¶ added in v0.67.0
func (o *ObservableTokenRepositoryImpl) RegisterObserver(observer repository.TokenRepositoryObserver) bool
func (*ObservableTokenRepositoryImpl) SetAccessToken ¶ added in v0.67.0
func (o *ObservableTokenRepositoryImpl) SetAccessToken(token interface{}) error
func (*ObservableTokenRepositoryImpl) UnregisterObserver ¶ added in v0.67.0
func (o *ObservableTokenRepositoryImpl) UnregisterObserver(observer repository.TokenRepositoryObserver) bool
type RefreshTokenImpl ¶ added in v0.21.0
type RefreshTokenImpl struct { // RefreshRate specifies the percentage of token lifetime at which refresh should occur. // Value should be between 0.0 and 1.0 (e.g., 0.8 means refresh when 80% of token lifetime has passed). // This helps ensure tokens are refreshed before they expire, preventing authentication failures. // If the `AutoRefresh` sets to `true` this value must be set below 1.0. RefreshRate float64 // AutoRefresh enables or disables automatic token refresh in the background. // When true, the SDK will automatically refresh tokens based on RefreshRate. // When false, tokens must be refreshed manually by calling refresh methods. AutoRefresh bool // IsRefreshInProgress indicates whether a token refresh operation is currently running. // This flag prevents multiple concurrent refresh operations and helps avoid race conditions. // Should be treated as read-only in most cases. IsRefreshInProgress bool }
RefreshTokenImpl handles automatic token refresh functionality for AccelByte SDK authentication. It manages the timing and behavior of token refresh operations to maintain valid access tokens throughout the application lifecycle.
func DefaultRefreshTokenImpl ¶ added in v0.21.0
func DefaultRefreshTokenImpl() *RefreshTokenImpl
DefaultRefreshTokenImpl creates a new RefreshTokenImpl with the default settings. Returns a RefreshTokenImpl configured with:
- RefreshRate: 0.8 (refresh when token is 80% through its lifetime)
- AutoRefresh: false (manual refresh mode by default)
func (*RefreshTokenImpl) DisableAutoRefresh ¶ added in v0.21.0
func (r *RefreshTokenImpl) DisableAutoRefresh() bool
func (*RefreshTokenImpl) GetRefreshRate ¶ added in v0.21.0
func (r *RefreshTokenImpl) GetRefreshRate() float64
func (*RefreshTokenImpl) SetRefreshIsRunningInBackground ¶ added in v0.23.0
func (r *RefreshTokenImpl) SetRefreshIsRunningInBackground(b bool)
type Session ¶ added in v0.21.0
type Session struct { Token repository.TokenRepository Config repository.ConfigRepository Refresh repository.RefreshTokenRepository }
type TokenRepositoryImpl ¶ added in v0.26.0
type TokenRepositoryImpl struct { IssuedTime *time.Time AccessToken *iamclientmodels.OauthmodelTokenResponseV3 // contains filtered or unexported fields }
func DefaultTokenRepositoryImpl ¶ added in v0.26.0
func DefaultTokenRepositoryImpl() *TokenRepositoryImpl
func (*TokenRepositoryImpl) GetToken ¶ added in v0.26.0
func (t *TokenRepositoryImpl) GetToken() (*iamclientmodels.OauthmodelTokenResponseV3, error)
func (*TokenRepositoryImpl) RemoveToken ¶ added in v0.26.0
func (t *TokenRepositoryImpl) RemoveToken() error
func (*TokenRepositoryImpl) Store ¶ added in v0.26.0
func (t *TokenRepositoryImpl) Store(accessToken interface{}) error
func (*TokenRepositoryImpl) TokenIssuedTimeUTC ¶ added in v0.26.0
func (t *TokenRepositoryImpl) TokenIssuedTimeUTC() time.Time
Click to show internal directories.
Click to hide internal directories.