realm

Documentation

Overview

Package realm regroups all infra (driven-side) implementations of the realm domain.

Index

• Constants
• type YAMLRealm
• type YAMLStorage
  • func NewYAMLStorage() YAMLStorage
  • func (s YAMLStorage) CreateOrUpdateRealm(r realm.Realm) error
  • func (s YAMLStorage) DeleteRealm(id string) error
  • func (s YAMLStorage) GetRealm(id string) (realm.Realm, error)
  • func (s YAMLStorage) ListRealms() (realm.List, error)
• type YAMLStructure

Constants

const Version string = "v1.beta"

Version of the YAML strcuture

Types

type YAMLRealm

type YAMLRealm struct {
	ID       string `yaml:"id"`
	URL      string `yaml:"url"`
	Username string `yaml:"username"`
}

YAMLRealm defines how to store a realm in YAML format

type YAMLStorage

type YAMLStorage struct{}

YAMLStorage provides storage in a local YAML file

func NewYAMLStorage

func NewYAMLStorage() YAMLStorage

NewYAMLStorage create a new YAML storage

func (YAMLStorage) CreateOrUpdateRealm

func (s YAMLStorage) CreateOrUpdateRealm(r realm.Realm) error

CreateOrUpdateRealm in the local YAML file

func (YAMLStorage) DeleteRealm

func (s YAMLStorage) DeleteRealm(id string) error

DeleteRealm remove the realm with id from the local storage.

func (YAMLStorage) GetRealm

func (s YAMLStorage) GetRealm(id string) (realm.Realm, error)

GetRealm from the local YAML file

func (YAMLStorage) ListRealms

func (s YAMLStorage) ListRealms() (realm.List, error)

ListRealms contained in the local YAML file

type YAMLStructure

type YAMLStructure struct {
	Version string      `yaml:"version"`
	Realms  []YAMLRealm `yaml:"realms,omitempty"`
}

YAMLStructure of the file