Documentation
¶
Index ¶
- Constants
- func MapAuthDtoSDKToRest(authAudit *dto.AuthAuditDTO) *models.AuthAuditDTO
- func MapDataDtoSDKToRest(dataAudit *dto.DataAuditDTO) *models.DataAuditDTO
- func MapDataValueDTOsSDKToRest(dataAuditValues []*dto.DataAuditValueDTO) []*models.DataAuditValueDTO
- func MapDataValueDtoSDKToRest(dataAuditValue *dto.DataAuditValueDTO) *models.DataAuditValueDTO
- type AuditClientOption
- func WithBaseURL[D any](url string) AuditClientOption[D]
- func WithCompleteProcess[D any](flag bool) AuditClientOption[D]
- func WithDataCapacity[D any](capacity int) AuditClientOption[D]
- func WithLogger[D any](log logger.Logger) AuditClientOption[D]
- func WithName[D any](name string) AuditClientOption[D]
- func WithReadTimeout[D any](timeout time.Duration) AuditClientOption[D]
- func WithStopTimeout[D any](timeout time.Duration) AuditClientOption[D]
- func WithTokenProvider[D any](provider auth.TokenProvider) AuditClientOption[D]
- func WithWorkerCount[D any](count int) AuditClientOption[D]
- type AuditClientOptions
- type AuthAuditClient
- type DataAuditClient
Constants ¶
const ( DefaultBaseURL string = "http://localhost:8080/" DefaultTimeout time.Duration = 5 * time.Second DefaultWorkerCount int = 2 DefaultDataCapacity int = 10000 DefaultCompleteProcessing bool = true DefaultStopTimeout time.Duration = 10 * time.Second )
Константы со значениями по умолчанию для конфигурации REST-клиента аудита.
Variables ¶
This section is empty.
Functions ¶
func MapAuthDtoSDKToRest ¶ added in v0.0.12
func MapAuthDtoSDKToRest(authAudit *dto.AuthAuditDTO) *models.AuthAuditDTO
MapAuthDtoSDKToRest преобразует модель данных аудита аутентификации из формата SDK (DTO) в транспортную модель REST API (models). Возвращает nil, если входной объект равен nil.
func MapDataDtoSDKToRest ¶ added in v0.0.12
func MapDataDtoSDKToRest(dataAudit *dto.DataAuditDTO) *models.DataAuditDTO
MapDataDtoSDKToRest преобразует бизнес-модель данных аудита операций из формата SDK (DTO) в транспортную модель REST API (models), включая вложенную коллекцию измененных значений. Возвращает nil, если входной объект равен nil.
func MapDataValueDTOsSDKToRest ¶ added in v0.0.12
func MapDataValueDTOsSDKToRest(dataAuditValues []*dto.DataAuditValueDTO) []*models.DataAuditValueDTO
MapDataValueDTOsSDKToRest преобразует слайс измененных значений из формата SDK в слайс моделей REST API. Фильтрует возможные nil-указатели внутри исходной коллекции. Возвращает nil, если слайс пустой.
func MapDataValueDtoSDKToRest ¶ added in v0.0.12
func MapDataValueDtoSDKToRest(dataAuditValue *dto.DataAuditValueDTO) *models.DataAuditValueDTO
MapDataValueDtoSDKToRest преобразует отдельное измененное значение поля из формата SDK (DTO) в транспортную модель REST API (models). Возвращает nil, если входной объект равен nil.
Types ¶
type AuditClientOption ¶ added in v0.0.34
type AuditClientOption[D any] func(options *AuditClientOptions[D])
AuditClientOption определяет сигнатуру функции для конфигурирования параметров REST-клиента.
func WithBaseURL ¶ added in v0.0.34
func WithBaseURL[D any](url string) AuditClientOption[D]
WithBaseURL конфигурирует базовый URL адрес удаленного сервиса аудита.
func WithCompleteProcess ¶ added in v0.0.34
func WithCompleteProcess[D any](flag bool) AuditClientOption[D]
WithCompleteProcess определяет, нужно ли досылать оставшиеся в буфере логи при остановке пула.
func WithDataCapacity ¶ added in v0.0.34
func WithDataCapacity[D any](capacity int) AuditClientOption[D]
WithDataCapacity устанавливает максимальную емкость буфера очереди отправки пула.
func WithLogger ¶ added in v0.0.34
func WithLogger[D any](log logger.Logger) AuditClientOption[D]
WithLogger настраивает системный логгер для пула воркеров REST-клиента.
func WithName ¶ added in v0.0.34
func WithName[D any](name string) AuditClientOption[D]
WithName задает уникальное имя для пула воркеров REST-клиента.
func WithReadTimeout ¶ added in v0.0.34
func WithReadTimeout[D any](timeout time.Duration) AuditClientOption[D]
WithReadTimeout задает таймаут на чтение/выполнение HTTP-запросов.
func WithStopTimeout ¶ added in v0.0.34
func WithStopTimeout[D any](timeout time.Duration) AuditClientOption[D]
WithStopTimeout задает максимальное время ожидания Graceful Shutdown для пула воркеров.
func WithTokenProvider ¶ added in v0.0.34
func WithTokenProvider[D any](provider auth.TokenProvider) AuditClientOption[D]
WithTokenProvider конфигурирует провайдер авторизационных токенов для HTTP-запросов.
func WithWorkerCount ¶ added in v0.0.34
func WithWorkerCount[D any](count int) AuditClientOption[D]
WithWorkerCount задает количество параллельных воркеров отправки REST-сообщений.
type AuditClientOptions ¶ added in v0.0.34
type AuditClientOptions[D any] struct { *client.BaseAuditClientOptions[D] BaseURL string ReadTimeout time.Duration }
AuditClientOptions содержит конфигурационные параметры для REST-клиента аудита. Включает в себя базовые опции через эмбеддинг BaseAuditClientOptions.
func NewAuditClientOptions ¶ added in v0.0.34
func NewAuditClientOptions[D any]() *AuditClientOptions[D]
NewAuditClientOptions создает и возвращает новый экземпляр AuditClientOptions с переопределенными базовыми параметрами пула и REST-настройками по умолчанию.
func (*AuditClientOptions[D]) Validate ¶ added in v0.0.34
func (aco *AuditClientOptions[D]) Validate() error
Validate проверяет корректность заполнения всех обязательных fields конфигурации. Возвращает ошибку, если хотя бы одно из ключевых полей не инициализировано или имеет невалидное значение.
type AuthAuditClient ¶
type AuthAuditClient struct {
*client.BaseAuditClient[*dto.AuthAuditDTO]
// contains filtered or unexported fields
}
AuthAuditClient представляет собой специализированный REST-клиент для отправки аудит-логов аутентификации v1 посредством автоматически сгенерированного go-swagger SDK.
func NewAuthAuditClient ¶
func NewAuthAuditClient(options ...AuditClientOption[*dto.AuthAuditDTO]) (*AuthAuditClient, error)
NewAuthAuditClient инициализирует опции, парсит базовый URL и конструирует новый экземпляр клиента AuthAuditClient со встроенным асинхронным воркер-пулом.
func (*AuthAuditClient) GetLogger ¶ added in v0.0.12
func (aac *AuthAuditClient) GetLogger() logger.Logger
GetLogger возвращает изолированный и именованный инстанс логгера для текущего клиента.
func (*AuthAuditClient) GetName ¶ added in v0.0.34
func (aac *AuthAuditClient) GetName() string
GetName возвращает уникальное скомпонованное строковое имя клиента.
func (*AuthAuditClient) GetOpts ¶ added in v0.0.34
func (aac *AuthAuditClient) GetOpts() *AuditClientOptions[*dto.AuthAuditDTO]
GetOpts возвращает конфигурационные опции (таймауты, пулы, урлы), с которыми был инициализирован клиент.
type DataAuditClient ¶
type DataAuditClient struct {
*client.BaseAuditClient[*dto.DataAuditDTO]
// contains filtered or unexported fields
}
DataAuditClient представляет собой специализированный REST-клиент для асинхронной отправки логов аудита изменений данных посредством сгенерированного OpenAPI SDK.
func NewDataAuditClient ¶
func NewDataAuditClient(options ...AuditClientOption[*dto.DataAuditDTO]) (*DataAuditClient, error)
NewDataAuditClient инициализирует опции, валидирует параметры и конструирует новый экземпляр клиента DataAuditClient со встроенным воркер-пулом.
func (*DataAuditClient) GetConfig ¶ added in v0.0.12
func (dac *DataAuditClient) GetConfig() *AuditClientOptions[*dto.DataAuditDTO]
GetConfig возвращает конфигурационные параметры и настройки пула, примененные для данного клиента.
func (*DataAuditClient) GetLogger ¶ added in v0.0.12
func (dac *DataAuditClient) GetLogger() logger.Logger
GetLogger возвращает именованный логгер, назначенный для текущего REST-клиента.
func (*DataAuditClient) GetName ¶ added in v0.0.34
func (dac *DataAuditClient) GetName() string
GetName возвращает строковое имя текущего экземпляра REST-клиента.