broker

Documentation

Overview

Package broker 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 AddFlags(o *Options)
• type BusinessLogic
  • func NewBusinessLogic(o Options) (*BusinessLogic, error)
  • func (b *BusinessLogic) Bind(request *osb.BindRequest, c *broker.RequestContext) (*broker.BindResponse, error)
  • func (b *BusinessLogic) Deprovision(request *osb.DeprovisionRequest, c *broker.RequestContext) (*broker.DeprovisionResponse, error)
  • func (b *BusinessLogic) GetCatalog(c *broker.RequestContext) (*broker.CatalogResponse, error)
  • func (b *BusinessLogic) LastOperation(request *osb.LastOperationRequest, c *broker.RequestContext) (*broker.LastOperationResponse, error)
  • func (b *BusinessLogic) Provision(request *osb.ProvisionRequest, c *broker.RequestContext) (*broker.ProvisionResponse, error)
  • func (b *BusinessLogic) Unbind(request *osb.UnbindRequest, c *broker.RequestContext) (*broker.UnbindResponse, error)
  • func (b *BusinessLogic) Update(request *osb.UpdateInstanceRequest, c *broker.RequestContext) (*broker.UpdateInstanceResponse, error)
  • func (b *BusinessLogic) ValidateBrokerAPIVersion(version string) error
• type Options

Functions

func AddFlags

func AddFlags(o *Options)

AddFlags is a hook called to initialize the CLI flags for broker options. It is called after the flags are added for the skeleton and before flag parse is called.

Types

type BusinessLogic

type BusinessLogic struct {

	// Synchronize go routines.
	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, c *broker.RequestContext) (*broker.BindResponse, error)

func (*BusinessLogic) Deprovision

func (b *BusinessLogic) Deprovision(request *osb.DeprovisionRequest, c *broker.RequestContext) (*broker.DeprovisionResponse, error)

func (*BusinessLogic) GetCatalog

func (b *BusinessLogic) GetCatalog(c *broker.RequestContext) (*broker.CatalogResponse, error)

func (*BusinessLogic) LastOperation

func (b *BusinessLogic) LastOperation(request *osb.LastOperationRequest, c *broker.RequestContext) (*broker.LastOperationResponse, error)

func (*BusinessLogic) Provision

func (b *BusinessLogic) Provision(request *osb.ProvisionRequest, c *broker.RequestContext) (*broker.ProvisionResponse, error)

func (*BusinessLogic) Unbind

func (b *BusinessLogic) Unbind(request *osb.UnbindRequest, c *broker.RequestContext) (*broker.UnbindResponse, error)

func (*BusinessLogic) Update

func (b *BusinessLogic) Update(request *osb.UpdateInstanceRequest, c *broker.RequestContext) (*broker.UpdateInstanceResponse, error)

func (*BusinessLogic) ValidateBrokerAPIVersion

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

type Options

type Options struct {
	CatalogPath string
	Async       bool
}

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