service

Documentation

Index

• Constants
• func AwaitTermination(logger log.Logger, terminationListener chan error) error
• func ConfigureHandlers(r *mux.Router) error
• func NewInternalClient(logger log.Logger, config *ClientConfig, name string) *http.Client
• func NewTerminationListener() chan error
• type BindAddress
• type ClientConfig
• type Config
  • func LoadConfig(logger log.Logger) (*Config, error)
• type Environment
  • func NewEnvironment(env *Environment) (*Environment, error)
  • func (env *Environment) RunServers(terminationListener chan error) func()
• type GlobalConfig
• type HTTPConfig
• type Response
• type ServerConfig

Constants

const (
	DisableValidateAttrs = "disable_attrs"
	GenerateAttrs        = "generate_attrs"
	Format               = "format"
	JsonFormat           = "json"
	XmlFormat            = "xml"
)

Functions

func AwaitTermination

func AwaitTermination(logger log.Logger, terminationListener chan error) error

func ConfigureHandlers

func ConfigureHandlers(r *mux.Router) error

configure handlers

func NewInternalClient

func NewInternalClient(logger log.Logger, config *ClientConfig, name string) *http.Client

func NewTerminationListener

func NewTerminationListener() chan error

Types

type BindAddress

type BindAddress struct {
	Address string
}

BindAddress specifies where the http server should bind to.

type ClientConfig

type ClientConfig struct {
	Timeout             time.Duration
	MaxIdleConns        int
	MaxIdleConnsPerHost int
	MaxConnsPerHost     int
}

type Config

type Config struct {
	Servers ServerConfig
	Clients *ClientConfig
}

Config defines all the configuration for the app

func LoadConfig

func LoadConfig(logger log.Logger) (*Config, error)

type Environment

type Environment struct {
	Logger         log.Logger
	Config         *Config
	TimeService    stime.TimeService
	DB             *sql.DB
	InternalClient *http.Client

	PublicRouter *mux.Router
	Shutdown     func()
}

Environment - Contains everything thats been instantiated for this service.

func NewEnvironment

func NewEnvironment(env *Environment) (*Environment, error)

NewEnvironment - Generates a new default environment. Overrides can be specified via configs.

func (*Environment) RunServers

func (env *Environment) RunServers(terminationListener chan error) func()

RunServers - Boots up all the servers and awaits till they are stopped.

type GlobalConfig

type GlobalConfig struct {
	Fincen Config
}

type HTTPConfig

type HTTPConfig struct {
	Bind BindAddress
}

HTTPConfig configuration for running an http server

type Response

type Response struct {
	Code    int
	Message string
	Format  string
	Report  *batch.EFilingBatchXML
}

type ServerConfig

type ServerConfig struct {
	Public *HTTPConfig
	Admin  HTTPConfig
}

ServerConfig - Groups all the http configs for the servers and ports that get opened.