configaction

Documentation

Overview

Package configaction handles all operations done to the CF Config.

Index

• type Actor
  • func NewActor(config Config, client CloudControllerClient) Actor
  • func (actor Actor) ClearTarget()
  • func (actor Actor) SetTarget(settings TargetSettings) (Warnings, error)
• type CloudControllerClient
• type Config
• type TargetSettings
• type Warnings

Types

type Actor

type Actor struct {
	Config                Config
	CloudControllerClient CloudControllerClient
}

Actor handles all operations done to the CF Config

func NewActor

func NewActor(config Config, client CloudControllerClient) Actor

NewActor returns an Actor with default settings

func (Actor) ClearTarget

func (actor Actor) ClearTarget()

ClearTarget clears target information from the actor.

func (Actor) SetTarget

func (actor Actor) SetTarget(settings TargetSettings) (Warnings, error)

SetTarget targets the Cloud Controller using the client and sets target information in the actor based on the response.

type CloudControllerClient

type CloudControllerClient interface {
	TargetCF(settings ccv2.TargetSettings) (ccv2.Warnings, error)

	API() string
	APIVersion() string
	AuthorizationEndpoint() string
	DopplerEndpoint() string
	LoggregatorEndpoint() string
	MinCLIVersion() string
	RoutingEndpoint() string
	TokenEndpoint() string
}

type Config

type Config interface {
	Target() string
	SkipSSLValidation() bool
	SetTargetInformation(api string, apiVersion string, auth string, loggregator string, minCLIVersion string, doppler string, uaa string, routing string, skipSSLValidation bool)
	SetTokenInformation(accessToken string, refreshToken string, sshOAuthClient string)
}

Config a way of getting basic CF configuration

type TargetSettings

type TargetSettings ccv2.TargetSettings

type Warnings

type Warnings []string

Warnings is a list of warnings returned back from the cloud controller