server

Documentation

Overview

Package server implements helpers and endpoints for the server

Index

• func AddHealthHandler(router *http.ServeMux, db *sql.DB) healthcheck.Handler
• func DocsHandler(registry broker.BrokerRegistry) http.HandlerFunc
• func GetAllCompleteServiceExamples(registry broker.BrokerRegistry) ([]client.CompleteServiceExample, error)
• func GetExamplesFromServer() []client.CompleteServiceExample
• func NewCfSharingWrapper(wrapped domain.ServiceBroker) domain.ServiceBroker
• func NewExampleHandler(registry broker.BrokerRegistry) http.HandlerFunc
• type CfSharingWrapper
  • func (w *CfSharingWrapper) Services(ctx context.Context) (services []domain.Service, err error)

Functions

func AddHealthHandler

func AddHealthHandler(router *http.ServeMux, db *sql.DB) healthcheck.Handler

AddHealthHandler creates a new handler for health and liveness checks and adds it to the /live and /ready endpoints.

func DocsHandler

func DocsHandler(registry broker.BrokerRegistry) http.HandlerFunc

DocsHandler creates a handler func that generates HTML documentation for the given registry and adds it to the /docs and / routes.

func GetAllCompleteServiceExamples

func GetAllCompleteServiceExamples(registry broker.BrokerRegistry) ([]client.CompleteServiceExample, error)

func GetExamplesFromServer

func GetExamplesFromServer() []client.CompleteServiceExample

func NewCfSharingWrapper

func NewCfSharingWrapper(wrapped domain.ServiceBroker) domain.ServiceBroker

NewCfSharingWrapper wraps the given servicebroker with the augmenter that sets the Shareable flag on all services.

func NewExampleHandler

func NewExampleHandler(registry broker.BrokerRegistry) http.HandlerFunc

Types

type CfSharingWrapper

type CfSharingWrapper struct {
	brokerapi.ServiceBroker
}

CfSharingWrapper enables the Shareable flag for every service provided by the broker.

func (*CfSharingWrapper) Services

func (w *CfSharingWrapper) Services(ctx context.Context) (services []domain.Service, err error)

Services augments the response from the wrapped ServiceBroker by adding the shareable flag.