server

Documentation

Index

• Constants
• Variables
• func RegisterServer(serverTypeName string, serverGen ProvisioningServerGen)
• type Account
• type Credential
• type Credentials
• type ProvisioningServer
  • func NewProvisioningServer(serverType, instanceID string, serverConfiguration interface{}) (ProvisioningServer, error)
• type ProvisioningServerGen
• type Resource

Constants

const (
	RESOURCE_DATA_TRANSFER uint64 = iota + 1
	RESOURCE_SERVICE_HOUR
	RESOURCE_IP_ADDRESS_V4
	RESOURCE_IP_ADDRESS_V6
	RESOURCE_TCP_PORT
	RESOURCE_UDP_PORT
)

ResourceID ENUMS

Variables

var (
	ErrServerUnknown        = errors.New("ulysses/server: server type is not registered")
	ErrServerConfigurables  = errors.New("ulysses/server: bad server config")
	ErrAccountConfigurables = errors.New("ulysses/server: bad account config")
)

Caller of this module should check the returned error against the list provided below. Any error returned not appearing in the list should be considered as an Internal Error and should not be displayed to Customer/Non-Dev.

Functions

func RegisterServer

func RegisterServer(serverTypeName string, serverGen ProvisioningServerGen)

RegisterServer tells the server module how to instantiate a server struct. A ProvisioningServer implementation should be registered with the server module in init()

Types

type Account

type Account interface {
	Credentials() (Credentials, error)
	Resources() ([]*Resource, error)
}

type Credential

type Credential struct {
	CredentialName  string
	CredentialValue interface{} // string, int, bool, []string, []int only
}

type Credentials

type Credentials interface {
	// Customer() returns the customer-oriented information.
	// interface{} types should be in string/number/bool/[]string/[]number
	Customer() []*Credential

	// Provider() returns the provider-oriented information.
	// interface{} types should be in string/number/bool/[]string/[]number
	Admin() []*Credential
}

It is up to module designer to parse/utilize the Credential.

type ProvisioningServer

type ProvisioningServer interface {
	// CreateAccount() utilizes internal server configuration and aconf pased in to create a series of accounts with
	// same sconf and variable aconf in order.
	CreateAccount(productSN uint64, accountConfiguration interface{}) error

	// ReadAccount() returns an ServerAccount-compatible struct
	GetAccount(productSN uint64) (Account, error)

	// UpdateAccount() utilizes internal server configuration and aconf pased in to update a series of accounts
	// specified by productSN.
	UpdateAccount(productSN uint64, accountConfiguration interface{}) error

	// DeleteAccount() utilizes internal server configuration to delete a series of accounts specified by accID.
	DeleteAccount(productSN uint64) error

	// Temporarily disable an account from being used or recover it
	SuspendAccount(productSN uint64) error
	UnsuspendAccount(productSN uint64) error

	// Monthly Refresh Usage
	RefreshAccount(productSN uint64) error
}

func NewProvisioningServer

func NewProvisioningServer(serverType, instanceID string, serverConfiguration interface{}) (ProvisioningServer, error)

NewProvisioningServer returns a ProvisioningServer interface specified by serverType according to the ServerRegistrarMap the internal state of the returned Server interface should reflect serverConfiguration. A Server implementation should utilize this function to instantiate a ProvisioningServer struct with known name.

type ProvisioningServerGen

type ProvisioningServerGen func(instanceID string, serverConfiguration interface{}) (ProvisioningServer, error)

type Resource

type Resource struct {
	ResourceID uint64 // enums should be saved somewhere in the database
	Allocated  float64
	Used       float64
	Free       float64
}