providerregistry

package

v0.15.14 Latest Latest Go to latest Published: Jan 18, 2024 License: AGPL-3.0 Imports: 15 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/common-fate/common-fate

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func ParseUses(uses string) (providerType string, version string, err error)
type ProviderRegistry
- func Registry() ProviderRegistry
type RegisteredProvider

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrProviderTypeNotFound = errors.New("provider type not found")
)

Functions ¶

func ParseUses ¶

func ParseUses(uses string) (providerType string, version string, err error)

Types ¶

type ProviderRegistry ¶

type ProviderRegistry struct {
	Providers map[string]map[string]RegisteredProvider
}

func Registry ¶

func Registry() ProviderRegistry

func (ProviderRegistry) All ¶

func (pr ProviderRegistry) All() map[string]RegisteredProvider

All returns all the registered providers. The key of the map is a 'uses' field like "commonfate/okta@v1"

func (ProviderRegistry) CLIOptions ¶

func (r ProviderRegistry) CLIOptions() []string

func (ProviderRegistry) FromCLIOption ¶

func (r ProviderRegistry) FromCLIOption(opt string) (uses string, p RegisteredProvider, err error)

func (ProviderRegistry) GetLatestByShortType ¶

func (r ProviderRegistry) GetLatestByShortType(providerType string) (latestVersion string, p *RegisteredProvider, err error)

GetLatestByShortType prepends 'commonfate/' to the providerType then calls GetLatestByType

func (ProviderRegistry) GetLatestByType ¶

func (r ProviderRegistry) GetLatestByType(providerType string) (latestVersion string, p *RegisteredProvider, err error)

GetLatestByType gets the latest version of a particular provider by it's type.

func (ProviderRegistry) Lookup ¶

func (r ProviderRegistry) Lookup(providerType, version string) (*RegisteredProvider, error)

func (ProviderRegistry) LookupByUses ¶

func (r ProviderRegistry) LookupByUses(uses string) (*RegisteredProvider, error)

Lookup a provider by the 'uses' string.

type RegisteredProvider ¶

type RegisteredProvider struct {
	Provider    providers.Accessor
	DefaultID   string
	Description string
	// Hidden providers can be used in testing but should be hidden from cli and setup docs
	Hidden bool
}

Source Files ¶

View all Source files

registry.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL