builder

package
v0.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 30, 2026 License: Apache-2.0 Imports: 8 Imported by: 2

Documentation

Overview

@Author daixk 2025/12/22 15:56:00

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Builder 

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

Builder builds a Manager from config and replaceable components Builder 根据配置和可替换组件构建 Manager

func NewBuilder 

func NewBuilder() *Builder

NewBuilder creates a builder with the default config NewBuilder 使用默认配置创建 Builder

func (*Builder) ActiveTimeout 

func (b *Builder) ActiveTimeout(seconds int64) *Builder

ActiveTimeout sets max inactive duration ActiveTimeout 设置最大不活跃时长

func (*Builder) AsyncEvent 

func (b *Builder) AsyncEvent(asyncEvent bool) *Builder

AsyncEvent sets async event switch AsyncEvent 设置是否异步触发事件

func (*Builder) AuthType 

func (b *Builder) AuthType(authType string) *Builder

AuthType sets auth type with suffix fix AuthType 设置认证体系类型并补齐后缀

func (*Builder) AutoRenew 

func (b *Builder) AutoRenew(autoRenew bool) *Builder

AutoRenew sets auto renew switch AutoRenew 设置是否自动续期

func (*Builder) Build 

func (b *Builder) Build() (*manager.Manager, error)

Build builds manager and returns configuration errors Build 构建 Manager 并返回配置错误

func (*Builder) Clone 

func (b *Builder) Clone() *Builder

Clone clones builder with deep copy Clone 深拷贝 Builder

func (*Builder) ConcurrencyScope 

func (b *Builder) ConcurrencyScope(concurrencyScope config.ConcurrencyScope) *Builder

ConcurrencyScope sets concurrency scope ConcurrencyScope 设置并发控制作用域

func (*Builder) Config 

func (b *Builder) Config(cfg *config.Config) *Builder

Config replaces the builder config with a clone of cfg Config 使用 cfg 的副本替换 Builder 配置

func (*Builder) CookieConfig 

func (b *Builder) CookieConfig(cfg *config.CookieConfig) *Builder

CookieConfig sets full cookie config CookieConfig 设置完整 Cookie 配置

func (*Builder) CookieDomain 

func (b *Builder) CookieDomain(domain string) *Builder

CookieDomain sets cookie domain CookieDomain 设置 Cookie 作用域

func (*Builder) CookieHttpOnly 

func (b *Builder) CookieHttpOnly(httpOnly bool) *Builder

CookieHttpOnly sets cookie httpOnly switch CookieHttpOnly 设置 Cookie 是否禁止 JavaScript 访问

func (*Builder) CookieMaxAge 

func (b *Builder) CookieMaxAge(maxAge int64) *Builder

CookieMaxAge sets cookie max age seconds CookieMaxAge 设置 Cookie 最大存活秒数

func (*Builder) CookiePath 

func (b *Builder) CookiePath(path string) *Builder

CookiePath sets cookie path CookiePath 设置 Cookie 路径

func (*Builder) CookieSameSite 

func (b *Builder) CookieSameSite(sameSite config.SameSiteMode) *Builder

CookieSameSite sets cookie sameSite mode CookieSameSite 设置 Cookie SameSite 模式

func (*Builder) CookieSecure 

func (b *Builder) CookieSecure(secure bool) *Builder

CookieSecure sets cookie secure switch CookieSecure 设置 Cookie 是否仅通过 HTTPS 传输

func (*Builder) GetConfig 

func (b *Builder) GetConfig() *config.Config

GetConfig returns the mutable builder config GetConfig 返回可修改的 Builder 配置

func (*Builder) IsConcurrent 

func (b *Builder) IsConcurrent(concurrent bool) *Builder

IsConcurrent sets concurrent login switch IsConcurrent 设置是否允许并发登录

func (*Builder) IsLog 

func (b *Builder) IsLog(isLog bool) *Builder

IsLog sets log switch IsLog 设置是否开启日志

func (*Builder) IsPrintBanner 

func (b *Builder) IsPrintBanner(isPrint bool) *Builder

IsPrintBanner sets banner print switch IsPrintBanner 设置是否打印 Banner

func (*Builder) IsReadBody 

func (b *Builder) IsReadBody(isRead bool) *Builder

IsReadBody sets body read switch IsReadBody 设置是否从请求体读取 Token

func (*Builder) IsReadCookie 

func (b *Builder) IsReadCookie(isRead bool) *Builder

IsReadCookie sets cookie read switch IsReadCookie 设置是否从 Cookie 读取 Token

func (*Builder) IsReadHeader 

func (b *Builder) IsReadHeader(isRead bool) *Builder

IsReadHeader sets header read switch IsReadHeader 设置是否从 Header 读取 Token

func (*Builder) IsShare 

func (b *Builder) IsShare(share bool) *Builder

IsShare sets shared token switch IsShare 设置是否共享 Token

func (*Builder) JwtSecret 

func (b *Builder) JwtSecret(secret string) *Builder

JwtSecret enables JWT style and sets secret JwtSecret 启用 JWT 风格并设置密钥

func (*Builder) JwtSecretKey 

func (b *Builder) JwtSecretKey(key string) *Builder

JwtSecretKey sets JWT secret key JwtSecretKey 设置 JWT 密钥

func (*Builder) KeyPrefix 

func (b *Builder) KeyPrefix(keyPrefix string) *Builder

KeyPrefix sets key prefix with suffix fix KeyPrefix 设置存储键前缀并补齐后缀

func (*Builder) MaxLoginCount 

func (b *Builder) MaxLoginCount(count int64) *Builder

MaxLoginCount sets max login count MaxLoginCount 设置最大登录数量

func (*Builder) MustBuild 

func (b *Builder) MustBuild() *manager.Manager

MustBuild builds manager and panics on error MustBuild 构建 Manager 并在失败时触发 panic

func (*Builder) OverflowLogoutMode 

func (b *Builder) OverflowLogoutMode(mode config.LogoutMode) *Builder

OverflowLogoutMode sets overflow logout mode OverflowLogoutMode 设置超限登录下线模式

func (*Builder) RenewInterval 

func (b *Builder) RenewInterval(seconds int64) *Builder

RenewInterval sets minimum renew interval RenewInterval 设置最小续期间隔

func (*Builder) RenewMaxRefresh 

func (b *Builder) RenewMaxRefresh(seconds int64) *Builder

RenewMaxRefresh sets renew trigger threshold RenewMaxRefresh 设置自动续期触发阈值

func (*Builder) ReplacedLoginExitMode 

func (b *Builder) ReplacedLoginExitMode(mode config.ReplacedLoginExitMode) *Builder

ReplacedLoginExitMode sets non-concurrent login strategy ReplacedLoginExitMode 设置非并发登录处理策略

func (*Builder) SetAccessProvider 

func (b *Builder) SetAccessProvider(provider manager.AccessProvider) *Builder

SetAccessProvider sets the permission and role provider SetAccessProvider 设置权限与角色提供器

func (*Builder) SetCodec 

func (b *Builder) SetCodec(codec adapter.Codec) *Builder

SetCodec sets codec adapter SetCodec 设置编解码适配器

func (*Builder) SetCodecFactory 

func (b *Builder) SetCodecFactory(factory CodecFactory) *Builder

SetCodecFactory sets default codec factory SetCodecFactory 设置默认编解码工厂

func (*Builder) SetCustomPermissionListExtFunc 

func (b *Builder) SetCustomPermissionListExtFunc(f func(loginID, device, deviceId, authType string) ([]string, error)) *Builder

SetCustomPermissionListExtFunc sets extended permission callback SetCustomPermissionListExtFunc 设置扩展权限回调

func (*Builder) SetCustomPermissionListFunc 

func (b *Builder) SetCustomPermissionListFunc(f func(loginID, authType string) ([]string, error)) *Builder

SetCustomPermissionListFunc sets permission callback SetCustomPermissionListFunc 设置权限回调

func (*Builder) SetCustomRoleListExtFunc 

func (b *Builder) SetCustomRoleListExtFunc(f func(loginID, device, deviceId, authType string) ([]string, error)) *Builder

SetCustomRoleListExtFunc sets extended role callback SetCustomRoleListExtFunc 设置扩展角色回调

func (*Builder) SetCustomRoleListFunc 

func (b *Builder) SetCustomRoleListFunc(f func(loginID, authType string) ([]string, error)) *Builder

SetCustomRoleListFunc sets role callback SetCustomRoleListFunc 设置角色回调

func (*Builder) SetGenerator 

func (b *Builder) SetGenerator(generator adapter.Generator) *Builder

SetGenerator sets token generator SetGenerator 设置 Token 生成器

func (*Builder) SetGeneratorFactory 

func (b *Builder) SetGeneratorFactory(factory GeneratorFactory) *Builder

SetGeneratorFactory sets default generator factory SetGeneratorFactory 设置默认生成器工厂

func (*Builder) SetLog 

func (b *Builder) SetLog(log adapter.Log) *Builder

SetLog sets log adapter SetLog 设置日志适配器

func (*Builder) SetLogFactory 

func (b *Builder) SetLogFactory(factory LogFactory) *Builder

SetLogFactory sets default log factory SetLogFactory 设置默认日志工厂

func (*Builder) SetNonceManager 

func (b *Builder) SetNonceManager(nonceManager *nonce.NonceManager) *Builder

SetNonceManager sets optional nonce manager SetNonceManager 设置可选 Nonce 管理器

func (*Builder) SetOAuth2Manager 

func (b *Builder) SetOAuth2Manager(oauth2Manager *oauth2.OAuth2Server) *Builder

SetOAuth2Manager sets optional OAuth2 manager SetOAuth2Manager 设置可选 OAuth2 管理器

func (*Builder) SetPool 

func (b *Builder) SetPool(pool adapter.Pool) *Builder

SetPool sets async task pool SetPool 设置异步任务池

func (*Builder) SetPoolFactory 

func (b *Builder) SetPoolFactory(factory PoolFactory) *Builder

SetPoolFactory sets default pool factory SetPoolFactory 设置默认任务池工厂

func (*Builder) SetStorage 

func (b *Builder) SetStorage(storage adapter.Storage) *Builder

SetStorage sets storage adapter SetStorage 设置存储适配器

func (*Builder) SetStorageFactory 

func (b *Builder) SetStorageFactory(factory StorageFactory) *Builder

SetStorageFactory sets default storage factory SetStorageFactory 设置默认存储工厂

func (*Builder) Timeout 

func (b *Builder) Timeout(seconds int64) *Builder

Timeout sets timeout seconds Timeout 设置超时时长秒数

func (*Builder) TimeoutDuration 

func (b *Builder) TimeoutDuration(d time.Duration) *Builder

TimeoutDuration sets timeout by duration TimeoutDuration 使用时长设置超时时间

func (*Builder) TokenName 

func (b *Builder) TokenName(name string) *Builder

TokenName sets token name TokenName 设置 Token 名称

func (*Builder) TokenStyle 

func (b *Builder) TokenStyle(style adapter.TokenStyle) *Builder

TokenStyle sets token style TokenStyle 设置 Token 生成风格

func (*Builder) UseManagerOption 

func (b *Builder) UseManagerOption(option manager.Option) *Builder

UseManagerOption appends optional manager assembly option UseManagerOption 添加 Manager 可选模块装配项

type CodecFactory 

type CodecFactory func(cfg *config.Config) (adapter.Codec, error)

CodecFactory creates a codec adapter from config CodecFactory 根据配置创建编解码适配器

type ComponentFactories 

type ComponentFactories struct {
	// Generator stores generator factory Generator 存储生成器工厂
	Generator GeneratorFactory
	// Storage stores storage factory Storage 存储存储工厂
	Storage StorageFactory
	// Codec stores codec factory Codec 存储编解码工厂
	Codec CodecFactory
	// Log stores logger factory Log 存储日志工厂
	Log LogFactory
	// Pool stores pool factory Pool 存储任务池工厂
	Pool PoolFactory
}

ComponentFactories groups default component factories ComponentFactories 聚合默认组件工厂

type Components 

type Components struct {
	// Generator stores token generator Generator 存储 Token 生成器
	Generator adapter.Generator
	// Storage stores storage adapter Storage 存储存储适配器
	Storage adapter.Storage
	// Codec stores codec adapter Codec 存储编解码适配器
	Codec adapter.Codec
	// Log stores logger adapter Log 存储日志适配器
	Log adapter.Log
	// Pool stores async task pool Pool 存储异步任务池
	Pool adapter.Pool
}

Components groups pluggable runtime components Components 聚合可替换的运行时组件

type GeneratorFactory 

type GeneratorFactory func(cfg *config.Config) (adapter.Generator, error)

GeneratorFactory creates a token generator from config GeneratorFactory 根据配置创建 Token 生成器

type LogFactory 

type LogFactory func(cfg *config.Config) (adapter.Log, error)

LogFactory creates a logger adapter from config LogFactory 根据配置创建日志适配器

type PoolFactory 

type PoolFactory func(cfg *config.Config) (adapter.Pool, error)

PoolFactory creates an async task pool from config PoolFactory 根据配置创建异步任务池

type StorageFactory 

type StorageFactory func(cfg *config.Config) (adapter.Storage, error)

StorageFactory creates a storage adapter from config StorageFactory 根据配置创建存储适配器

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.