server

Documentation

Index

• Constants
• Variables
• func InitEventSystem(address string)
• type Authorization
• type Response
  • func (w Response) ClientError(message string, err error)
  • func (w Response) Created(body interface{})
  • func (w Response) DirectiveError()
  • func (w Response) Forbidden(msg string)
  • func (w Response) Location(loc string) Response
  • func (w Response) Ok(body interface{})
  • func (w Response) ServerError(message string, err error)
  • func (w Response) ServerNewError(message string)
  • func (w Response) Unauthorized()
• type Server
  • func NewServer(cfg def.Configuration, pier *pier.Pier, database *db.Db) (*Server, error)
  • func (s *Server) Start() error

Constants

const (
	// ServiceName is used for HTTP API
	ServiceName = "GEF"
	// Version defines the api version
	Version = "0.3.0"
)

Variables

var (
	AccessTokenQueryParam = "access_token"
	AccessTokenCookieKey  = "UIAccessToken"
)

Functions

func InitEventSystem

func InitEventSystem(address string)

InitEventSystem initializes the event system, or disables it if the address is empty

Types

type Authorization

type Authorization struct {
	// contains filtered or unexported fields
}

type Response

type Response struct {
	http.ResponseWriter
}

Response encapsulates a http ResponseWriter

func (Response) ClientError

func (w Response) ClientError(message string, err error)

ClientError sets a 400 error

func (Response) Created

func (w Response) Created(body interface{})

Created sets 201/created response code and body

func (Response) DirectiveError

func (w Response) DirectiveError()

DirectiveError sets a 403 error

func (Response) Forbidden

func (w Response) Forbidden(msg string)

Forbidden sets a 403 error

func (Response) Location

func (w Response) Location(loc string) Response

Location sets location header

func (Response) Ok

func (w Response) Ok(body interface{})

Ok sets 200/ok response code and body

func (Response) ServerError

func (w Response) ServerError(message string, err error)

ServerError sets a 500/server error

func (Response) ServerNewError

func (w Response) ServerNewError(message string)

ServerNewError sets a 500/server error

func (Response) Unauthorized

func (w Response) Unauthorized()

Unauthorized sets a 401 error

type Server

type Server struct {
	Server                 http.Server
	TLSCertificateFilePath string
	TLSKeyFilePath         string
	// contains filtered or unexported fields
}

Server is a master struct for serving HTTP API requests

func NewServer

func NewServer(cfg def.Configuration, pier *pier.Pier, database *db.Db) (*Server, error)

NewServer creates a new Server

func (*Server) Start

func (s *Server) Start() error

Start starts a new http listener