user

Documentation

Overview

Package user holds the code that users of the skeleton write for their broker. To make a broker, fill out:

• The Options type, which holds options for the broker
• The AddFlags function, which adds CLI flags for an Options
• The methods of the BusinessLogic type, which implements the broker's business logic
• The NewBusinessLogic function, which creates a BusinessLogic from the Options the program is run with

Index

• func AddUserFlags(o *Options)
• type BusinessLogic
  • func NewBusinessLogic(o Options) (*BusinessLogic, error)
  • func (b *BusinessLogic) Bind(request *osb.BindRequest, w http.ResponseWriter, r *http.Request) (*osb.BindResponse, error)
  • func (b *BusinessLogic) Deprovision(request *osb.DeprovisionRequest, w http.ResponseWriter, r *http.Request) (*osb.DeprovisionResponse, error)
  • func (b *BusinessLogic) GetCatalog(w http.ResponseWriter, r *http.Request) (*osb.CatalogResponse, error)
  • func (b *BusinessLogic) LastOperation(request *osb.LastOperationRequest, w http.ResponseWriter, r *http.Request) (*osb.LastOperationResponse, error)
  • func (b *BusinessLogic) Provision(pr *osb.ProvisionRequest, w http.ResponseWriter, r *http.Request) (*osb.ProvisionResponse, error)
  • func (b *BusinessLogic) Unbind(request *osb.UnbindRequest, w http.ResponseWriter, r *http.Request) (*osb.UnbindResponse, error)
  • func (b *BusinessLogic) Update(request *osb.UpdateInstanceRequest, w http.ResponseWriter, r *http.Request) (*osb.UpdateInstanceResponse, error)
  • func (b *BusinessLogic) ValidateBrokerAPIVersion(version string) error
• type Options

Functions

func AddUserFlags

func AddUserFlags(o *Options)

AddUserFlags is a hook called to initialize the CLI flags for user options it is called after the flags are added for the skeleton and before flag.Parse is called.

Types

type BusinessLogic

type BusinessLogic struct {
	// Add fields here! These fields are provided purely as an example
	sync.RWMutex
	// contains filtered or unexported fields
}

BusinessLogic provides an implementation of the broker.BusinessLogic interface.

func NewBusinessLogic

func NewBusinessLogic(o Options) (*BusinessLogic, error)

NewBusinessLogic is a hook that is called with the Options the program is run with. NewBusinessLogic is the place where you will initialize your BusinessLogic the parameters passed in.

func (*BusinessLogic) Bind

func (b *BusinessLogic) Bind(request *osb.BindRequest, w http.ResponseWriter, r *http.Request) (*osb.BindResponse, error)

func (*BusinessLogic) Deprovision

func (b *BusinessLogic) Deprovision(request *osb.DeprovisionRequest, w http.ResponseWriter, r *http.Request) (*osb.DeprovisionResponse, error)

func (*BusinessLogic) GetCatalog

func (b *BusinessLogic) GetCatalog(w http.ResponseWriter, r *http.Request) (*osb.CatalogResponse, error)

func (*BusinessLogic) LastOperation

func (b *BusinessLogic) LastOperation(request *osb.LastOperationRequest, w http.ResponseWriter, r *http.Request) (*osb.LastOperationResponse, error)

func (*BusinessLogic) Provision

func (b *BusinessLogic) Provision(pr *osb.ProvisionRequest, w http.ResponseWriter, r *http.Request) (*osb.ProvisionResponse, error)

func (*BusinessLogic) Unbind

func (b *BusinessLogic) Unbind(request *osb.UnbindRequest, w http.ResponseWriter, r *http.Request) (*osb.UnbindResponse, error)

func (*BusinessLogic) Update

func (b *BusinessLogic) Update(request *osb.UpdateInstanceRequest, w http.ResponseWriter, r *http.Request) (*osb.UpdateInstanceResponse, error)

func (*BusinessLogic) ValidateBrokerAPIVersion

func (b *BusinessLogic) ValidateBrokerAPIVersion(version string) error

type Options

type Options struct {
	CatalogPath string
}

Options holds the options specified by the user's code on the command line. Users should add their own options here and add flags for them in AddUserFlags.