statistics

Documentation

Index

• Constants
• func MakeAuthorizationManagementComponentMW(logger log.Logger, authorizationManager security.AuthorizationManager) func(Component) Component
• func MakeGetMigrationReportEndpoint(ec Component) cs.Endpoint
• func MakeGetStatisticsEndpoint(ec Component) cs.Endpoint
• func MakeStatisticsHandler(e endpoint.Endpoint, logger log.Logger) *http_transport.Server
• type Component
  • func NewComponent(db keycloakb.EventsDBModule, keycloakClient KeycloakClient, logger log.Logger) Component
• type Endpoints
• type KeycloakClient

Constants

const (
	STGetStatistics      = "ST_GetStatistics"
	STGetMigrationReport = "ST_GetMigrationReport"
)

Actions used for authorization module

Functions

func MakeAuthorizationManagementComponentMW

func MakeAuthorizationManagementComponentMW(logger log.Logger, authorizationManager security.AuthorizationManager) func(Component) Component

MakeAuthorizationManagementComponentMW checks authorization and return an error if the action is not allowed.

func MakeGetMigrationReportEndpoint

func MakeGetMigrationReportEndpoint(ec Component) cs.Endpoint

MakeGetMigrationReportEndpoint makes the migration reporting endpoint.

func MakeGetStatisticsEndpoint

func MakeGetStatisticsEndpoint(ec Component) cs.Endpoint

MakeGetStatisticsEndpoint makes the statistic summary endpoint.

func MakeStatisticsHandler

func MakeStatisticsHandler(e endpoint.Endpoint, logger log.Logger) *http_transport.Server

MakeStatisticsHandler make an HTTP handler for a Statistics endpoint.

Types

type Component

type Component interface {
	GetStatistics(context.Context, string) (api.StatisticsRepresentation, error)
	GetMigrationReport(context.Context, string) (map[string]bool, error)
}

Component is the interface of the events component.

func NewComponent

func NewComponent(db keycloakb.EventsDBModule, keycloakClient KeycloakClient, logger log.Logger) Component

NewComponent returns a component

type Endpoints

type Endpoints struct {
	GetStatistics      endpoint.Endpoint
	GetMigrationReport endpoint.Endpoint
}

Endpoints exposed for path /events

type KeycloakClient

type KeycloakClient interface {
	GetUsers(accessToken string, reqRealmName, targetRealmName string, paramKV ...string) (kc.UsersPageRepresentation, error)
}