whitesource

Documentation

Index

• type Product
• type Project
• type Request
• type System
  • func (s *System) GetMetaInfoForProduct(productName string) (Product, error)
  • func (s *System) GetProductName(productToken string) (string, error)
  • func (s *System) GetProductsMetaInfo() ([]Product, error)
  • func (s *System) GetProjectToken(productToken, projectName string) (string, error)
  • func (s *System) GetProjectTokens(productToken string, projectNames []string) ([]string, error)
  • func (s *System) GetProjectsMetaInfo(productToken string) ([]Project, error)

Types

type Product

type Product struct {
	Name           string `json:"name"`
	Token          string `json:"token"`
	CreationDate   string `json:"creationDate,omitempty"`
	LastUpdateDate string `json:"lastUpdatedDate,omitempty"`
}

Product defines a WhiteSource product with name and token

type Project

type Project struct {
	Name           string `json:"name"`
	PluginName     string `json:"pluginName"`
	Token          string `json:"token"`
	UploadedBy     string `json:"uploadedBy"`
	CreationDate   string `json:"creationDate,omitempty"`
	LastUpdateDate string `json:"lastUpdatedDate,omitempty"`
}

Project defines a WhiteSource project with name and token

type Request

type Request struct {
	RequestType  string `json:"requestType,omitempty"`
	UserKey      string `json:"userKey,omitempty"`
	ProductToken string `json:"productToken,omitempty"`
	ProjectToken string `json:"projectToken,omitempty"`
	OrgToken     string `json:"orgToken,omitempty"`
}

Request defines a request object to be sent to the WhiteSource system

type System

type System struct {
	HTTPClient piperhttp.Sender
	OrgToken   string
	ServerURL  string
	UserToken  string
}

System defines a WhiteSource system including respective tokens (e.g. org token, user token)

func (*System) GetMetaInfoForProduct

func (s *System) GetMetaInfoForProduct(productName string) (Product, error)

GetMetaInfoForProduct retrieves meta information for a specific WhiteSource product

func (*System) GetProductName

func (s *System) GetProductName(productToken string) (string, error)

GetProductName returns the product name for a given product token

func (*System) GetProductsMetaInfo

func (s *System) GetProductsMetaInfo() ([]Product, error)

GetProductsMetaInfo retrieves meta information for all WhiteSource products a user has access to

func (*System) GetProjectToken

func (s *System) GetProjectToken(productToken, projectName string) (string, error)

GetProjectToken returns the project token for a project with a given name

func (*System) GetProjectTokens

func (s *System) GetProjectTokens(productToken string, projectNames []string) ([]string, error)

GetProjectTokens returns the project tokens for a list of given project names

func (*System) GetProjectsMetaInfo

func (s *System) GetProjectsMetaInfo(productToken string) ([]Project, error)

GetProjectsMetaInfo retrieves meta information for a specific WhiteSource product