server

Documentation

Index

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

Examples

• GetAllCompleteServiceExamples

Functions

func AddDocsHandler

func AddDocsHandler(router *mux.Router, registry broker.BrokerRegistry)

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

func AddHealthHandler

func AddHealthHandler(router *mux.Router, 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 GetAllCompleteServiceExamples

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

Example

Sanity check to make sure GetAllCompleteServiceExamples returns a result

allServiceExamples, err := GetAllCompleteServiceExamples(builtin.BuiltinBrokerRegistry())
fmt.Println(allServiceExamples != nil)
fmt.Println(err)

Output:

true
<nil>

func GetExamplesFromServer

func GetExamplesFromServer() []client.CompleteServiceExample

func NewCfSharingWrapper

func NewCfSharingWrapper(wrapped brokerapi.ServiceBroker) brokerapi.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 CfSharingWraper

type CfSharingWraper struct {
	brokerapi.ServiceBroker
}

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

func (*CfSharingWraper) Services

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

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