keystone

package

v0.9.0 Latest Latest Go to latest Published: Sep 1, 2025 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/warpcomdev/fiware

Links

Open Source Insights

Documentation ¶

Index ¶

func Exhaust(resp *http.Response)
func GetJSON(client HTTPClient, headers http.Header, path *url.URL, data interface{}, ...) error
func GetPaginatedJSON(client HTTPClient, headers http.Header, path *url.URL, p Paginator, ...) error
func PostJSON(client HTTPClient, headers http.Header, path *url.URL, data interface{}) (http.Header, []byte, error)
func PutJSON(client HTTPClient, headers http.Header, path *url.URL, data interface{}) (http.Header, []byte, error)
func Query(client HTTPClient, method string, headers http.Header, path *url.URL, ...) (http.Header, error)
func Update(client HTTPClient, method string, headers http.Header, path *url.URL, ...) (http.Header, []byte, error)
type Backoff
type DecodeError
- func (d DecodeError) Error() string
- func (d DecodeError) Unwrap() error
type ExponentialBackoff
- func (l ExponentialBackoff) KeepTrying(retries int) (bool, time.Duration)
type HTTPClient
type Keystone
- func New(keystoneURL string, username, service string) (*Keystone, error)
- func (k *Keystone) Domains(client HTTPClient, headers http.Header, enabled bool) ([]models.Domain, error)
- func (k *Keystone) GroupRoles(client HTTPClient, headers http.Header, gids []string, skipErrors bool) ([]models.RoleAssignment, error)
- func (k *Keystone) Groups(client HTTPClient, headers http.Header) ([]models.Group, error)
- func (o *Keystone) Headers(subservice, token string) http.Header
- func (o *Keystone) Login(client HTTPClient, password string, retries Backoff) (string, string, error)
- func (k *Keystone) MyDomain(client HTTPClient, headers http.Header) (string, string, error)
- func (k *Keystone) PostAssignments(client HTTPClient, headers http.Header, assignments []models.RoleAssignment) error
- func (k *Keystone) PostGroups(client HTTPClient, headers http.Header, groups []models.Group) error
- func (k *Keystone) PostProjects(client HTTPClient, headers http.Header, projects []models.Project) error
- func (k *Keystone) PostUsers(client HTTPClient, headers http.Header, users []models.User) error
- func (k *Keystone) Projects(client HTTPClient, headers http.Header) ([]models.Project, error)
- func (k *Keystone) Roles(client HTTPClient, headers http.Header) ([]models.Role, error)
- func (k *Keystone) UserRoles(client HTTPClient, headers http.Header, uids []string, skipErrors bool) ([]models.RoleAssignment, error)
- func (k *Keystone) Users(client HTTPClient, headers http.Header) ([]models.User, error)
type LinealBackoff
- func (l LinealBackoff) KeepTrying(retries int) (bool, time.Duration)
type NetError
- func (n NetError) Error() string
- func (n NetError) Unwrap() error
type Paginator
type SlicePaginator
- func NewPaginator[T any](slice []T) *SlicePaginator[T]
- func (s *SlicePaginator[T]) Append(raw json.RawMessage, allowUnknownFields bool) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Exhaust ¶

func Exhaust(resp *http.Response)

Exhaust reads the response body until completion, and closes it.

func GetJSON ¶

func GetJSON(client HTTPClient, headers http.Header, path *url.URL, data interface{}, allowUnknownFields bool) error

GetJSON is a convenience wrapper for Query(client, http.MethodGet, ...) TODO: Add a variant with pagination support

func GetPaginatedJSON ¶

func GetPaginatedJSON(client HTTPClient, headers http.Header, path *url.URL, p Paginator, allowUnknownFields bool, maximum int) error

GetPaginatedJSON is a convenience wrapper for Query(client, http.MethodGet, ...)

func PostJSON ¶

func PostJSON(client HTTPClient, headers http.Header, path *url.URL, data interface{}) (http.Header, []byte, error)

PostJSON is a convenience wrapper for Update(client, http.MethodPost, ...)

func PutJSON ¶

func PutJSON(client HTTPClient, headers http.Header, path *url.URL, data interface{}) (http.Header, []byte, error)

PutJSON is a convenience wrapper for Update(client, http.MethodPut, ...)

func Query ¶

func Query(client HTTPClient, method string, headers http.Header, path *url.URL, data interface{}, allowUnknownFields bool) (http.Header, error)

Query performs an HTTP request without payload, loads the result into `data`

func Update ¶

func Update(client HTTPClient, method string, headers http.Header, path *url.URL, data interface{}) (http.Header, []byte, error)

Update performs an HTTP request with JSON payload, returns headers.

Types ¶

type Backoff ¶

type Backoff interface {
	KeepTrying(retries int) (bool, time.Duration)
}

Backoff controls retry policy

type DecodeError ¶

type DecodeError struct {
	Type interface{}
	Data json.RawMessage
	Err  error
}

DecodeError returned when failed to decode json data

func (DecodeError) Error ¶

func (d DecodeError) Error() string

Error implements error

func (DecodeError) Unwrap ¶

func (d DecodeError) Unwrap() error

Unwrap implements errors.Unwrap

type ExponentialBackoff ¶

type ExponentialBackoff struct {
	MaxRetries   int
	InitialDelay time.Duration
	DelayFactor  float64
	MaxDelay     time.Duration
}

ExponentialBackoff performs exponential backoff

func (ExponentialBackoff) KeepTrying ¶

func (l ExponentialBackoff) KeepTrying(retries int) (bool, time.Duration)

KeepTrying implements Retry

type HTTPClient ¶

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

HTTPClient encapsulates the funcionality required from *http.Client.

type Keystone ¶

type Keystone struct {
	URL               *url.URL
	Username, Service string
}

Keystone manages Requests to the Identity Manager

func New ¶

func New(keystoneURL string, username, service string) (*Keystone, error)

New Keystone client instance

func (*Keystone) Domains ¶

func (k *Keystone) Domains(client HTTPClient, headers http.Header, enabled bool) ([]models.Domain, error)

func (*Keystone) GroupRoles ¶

func (k *Keystone) GroupRoles(client HTTPClient, headers http.Header, gids []string, skipErrors bool) ([]models.RoleAssignment, error)

func (*Keystone) Groups ¶

func (k *Keystone) Groups(client HTTPClient, headers http.Header) ([]models.Group, error)

func (*Keystone) Headers ¶

func (o *Keystone) Headers(subservice, token string) http.Header

Headers returns the authentication headers for a subservice

func (o *Keystone) Login(client HTTPClient, password string, retries Backoff) (string, string, error)

Login into the Context Broker, get a session token

func (*Keystone) MyDomain ¶

func (k *Keystone) MyDomain(client HTTPClient, headers http.Header) (string, string, error)

func (*Keystone) PostAssignments ¶

func (k *Keystone) PostAssignments(client HTTPClient, headers http.Header, assignments []models.RoleAssignment) error

func (*Keystone) PostGroups ¶

func (k *Keystone) PostGroups(client HTTPClient, headers http.Header, groups []models.Group) error

func (*Keystone) PostProjects ¶

func (k *Keystone) PostProjects(client HTTPClient, headers http.Header, projects []models.Project) error

func (*Keystone) PostUsers ¶

func (k *Keystone) PostUsers(client HTTPClient, headers http.Header, users []models.User) error

func (*Keystone) Projects ¶

func (k *Keystone) Projects(client HTTPClient, headers http.Header) ([]models.Project, error)

func (*Keystone) Roles ¶

func (k *Keystone) Roles(client HTTPClient, headers http.Header) ([]models.Role, error)

func (*Keystone) UserRoles ¶

func (k *Keystone) UserRoles(client HTTPClient, headers http.Header, uids []string, skipErrors bool) ([]models.RoleAssignment, error)

func (*Keystone) Users ¶

func (k *Keystone) Users(client HTTPClient, headers http.Header) ([]models.User, error)

type LinealBackoff ¶

type LinealBackoff struct {
	MaxRetries int
	Delay      time.Duration
}

LinealBackoff performs lineal backoff

func (LinealBackoff) KeepTrying ¶

func (l LinealBackoff) KeepTrying(retries int) (bool, time.Duration)