site_portal_client

Documentation

Index

• type Client
  • func NewClient(site Site) (Client, error)
• type FMLManagerConnectionInfo
• type Site

Types

type Client

type Client interface {
	// ConfigAndConnectSite configures the site info and connect it to the fml manager
	ConfigAndConnectSite() error
	// UnregisterFromFMLManager asks the site to unregister from the fml manager
	UnregisterFromFMLManager() error
}

Client provides interface to work with a site portal service

func NewClient

func NewClient(site Site) (Client, error)

type FMLManagerConnectionInfo

type FMLManagerConnectionInfo struct {
	// Endpoint address starting with "http" or "https"
	Endpoint string `json:"endpoint"`
	// ServerName is used by Site Portal to verify FML Manager's certificate
	ServerName string `json:"server_name"`
}

FMLManagerConnectionInfo contains connection settings for the fml manager

type Site

type Site struct {
	Username             string `json:"-"`
	Password             string `json:"-"`
	Name                 string `json:"name"`
	Description          string `json:"description"`
	PartyID              uint   `json:"party_id"`
	ExternalHost         string `json:"external_host"`
	ExternalPort         uint   `json:"external_port"`
	HTTPS                bool   `json:"https"`
	FMLManagerEndpoint   string `json:"fml_manager_endpoint"`
	FMLManagerServerName string `json:"fml_manager_server_name"`
	FATEFlowHost         string `json:"fate_flow_host"`
	FATEFlowHTTPPort     uint   `json:"fate_flow_http_port"`
}

Site contains essential info to configure its connection with fml manager