cloudfoundry

Documentation

Index

• func Login(options LoginOptions) error
• func LoginCheck(options LoginOptions) (bool, error)
• func Logout() error
• type AbapBinding
• type AbapConnection
• type LoginOptions
• type Manifest
  • func ReadManifest(name string) (Manifest, error)
• type ServiceKey
  • func ReadServiceKeyAbapEnvironment(options ServiceKeyOptions, cfLogoutOption bool) (ServiceKey, error)
• type ServiceKeyOptions

Functions

func Login

func Login(options LoginOptions) error

Login logs user in to Cloud Foundry via cf cli. Checks if user is logged in first, if not perform 'cf login' command with appropriate parameters

func LoginCheck

func LoginCheck(options LoginOptions) (bool, error)

LoginCheck checks if user is logged in to Cloud Foundry. If user is not logged in 'cf api' command will return string that contains 'User is not logged in' only if user is not logged in. If the returned string doesn't contain the substring 'User is not logged in' we know he is logged in.

func Logout

func Logout() error

Logout logs User out of Cloud Foundry Logout can be perforned via 'cf logout' command regardless if user is logged in or not

Types

type AbapBinding

type AbapBinding struct {
	Env     string `json:"env"`
	ID      string `json:"id"`
	Type    string `json:"type"`
	Version string `json:"version"`
}

AbapBinding contains information about service binding in Cloud Foundry

type AbapConnection

type AbapConnection struct {
	CommunicationArrangementID string `json:"communication_arrangement_id"`
	CommunicationScenarioID    string `json:"communication_scenario_id"`
	CommunicationSystemID      string `json:"communication_system_id"`
	Password                   string `json:"password"`
	Username                   string `json:"username"`
}

AbapConnection contains information about the ABAP connection for the ABAP endpoint

type LoginOptions

type LoginOptions struct {
	CfAPIEndpoint string
	CfOrg         string
	CfSpace       string
	Username      string
	Password      string
	CfAPIOpts     []string
	CfLoginOpts   []string
}

LoginOptions for logging in to CF

type Manifest

type Manifest interface {
	GetFileName() string
	GetAppName(index int) (string, error)
	ApplicationHasProperty(index int, name string) (bool, error)
	GetApplicationProperty(index int, name string) (interface{}, error)
	Transform() error
	IsModified() bool
	GetApplications() ([]map[string]interface{}, error)
	WriteManifest() error
}

Manifest ...

func ReadManifest

func ReadManifest(name string) (Manifest, error)

ReadManifest Reads the manifest denoted by 'name'

type ServiceKey

type ServiceKey struct {
	Abap     AbapConnection `json:"abap"`
	Binding  AbapBinding    `json:"binding"`
	Systemid string         `json:"systemid"`
	URL      string         `json:"url"`
}

ServiceKey struct to parse CF Service Key

func ReadServiceKeyAbapEnvironment

func ReadServiceKeyAbapEnvironment(options ServiceKeyOptions, cfLogoutOption bool) (ServiceKey, error)

ReadServiceKeyAbapEnvironment from Cloud Foundry and returns it. Depending on user/developer requirements if he wants to perform further Cloud Foundry actions the cfLogoutOption parameters gives the option to logout after reading ABAP communication arrangement or not.

type ServiceKeyOptions

type ServiceKeyOptions struct {
	CfAPIEndpoint     string
	CfOrg             string
	CfSpace           string
	CfServiceInstance string
	CfServiceKey      string
	Username          string
	Password          string
}

ServiceKeyOptions for reading CF Service Key