cpiclient

Documentation

Overview

Copyright © 2022 Aleksandr Ivanov <shamrockspb@gmail.com>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type CPIClient
  • func NewCPIBasicAuthClient(username, password, url string, verbose bool) *CPIClient
  • func (s *CPIClient) CheckConnection() error
  • func (s *CPIClient) CopyIntegrationPackageFromDiscover(DiscoverPackageId string) (*IntegrationPackage, error)
  • func (s *CPIClient) CreateIntegrationPackage(integrationPackage *IntegrationPackage) error
  • func (s *CPIClient) DeleteIntegrationDesigntimeArtifact(ArtifactId string, ArtifactVersion string) error
  • func (s *CPIClient) DeployIntegrationDesigntimeArtifact(ArtifactId string, ArtifactVersion string) error
  • func (s *CPIClient) DownloadIntegrationDesigntimeArtifact(ArtifactId string, ArtifactVersion string) (*IntegrationDesigntimeArtifact, error)
  • func (s *CPIClient) ReadIntegrationDesigntimeArtifact(ArtifactId string, ArtifactVersion string) (*IntegrationDesigntimeArtifact, error)
  • func (s *CPIClient) ReadIntegrationDesigntimeArtifactConfigurations(ArtifactId string, ArtifactVersion string) ([]*Configuration, error)
  • func (s *CPIClient) ReadIntegrationDesigntimeArtifacts(PackageId string, fetchConfig bool) ([]*IntegrationDesigntimeArtifact, error)
  • func (s *CPIClient) ReadIntegrationPackage(PackageId string) (*IntegrationPackage, error)
  • func (s *CPIClient) ReadIntegrationPackages() ([]*IntegrationPackage, error)
  • func (s *CPIClient) ReadIntegrationRuntimeArtifact(ArtifactId string) (*IntegrationRuntimeArtifact, error)
  • func (s *CPIClient) UndeployIntegrationRuntimeArtifact(ArtifactId string) error
  • func (s *CPIClient) UpdateIntegrationDesigntimeArtifactConfiguration(ArtifactId string, ArtifactVersion string, configuration *Configuration) error
  • func (s *CPIClient) UploadIntegrationDesigntimeArtifact(integrationArtifact *IntegrationDesigntimeArtifact) error
• type Configuration
• type IntegrationDesigntimeArtifact
  • func (artifact *IntegrationDesigntimeArtifact) GetConfiguration(parameter string) (*Configuration, error)
• type IntegrationDesigntimeArtifactXMLEntry
• type IntegrationDesigntimeArtifactXMLProperties
• type IntegrationPackage
• type IntegrationRuntimeArtifact

Types

type CPIClient

type CPIClient struct {
	Username string
	Password string
	URL      string
	Client   *http.Client

	VerboseLog bool
	// contains filtered or unexported fields
}

func NewCPIBasicAuthClient

func NewCPIBasicAuthClient(username, password, url string, verbose bool) *CPIClient

func (*CPIClient) CheckConnection

func (s *CPIClient) CheckConnection() error

func (*CPIClient) CopyIntegrationPackageFromDiscover

func (s *CPIClient) CopyIntegrationPackageFromDiscover(DiscoverPackageId string) (*IntegrationPackage, error)

func (*CPIClient) CreateIntegrationPackage

func (s *CPIClient) CreateIntegrationPackage(integrationPackage *IntegrationPackage) error

func (*CPIClient) DeleteIntegrationDesigntimeArtifact

func (s *CPIClient) DeleteIntegrationDesigntimeArtifact(ArtifactId string, ArtifactVersion string) error

Delete artifact

func (*CPIClient) DeployIntegrationDesigntimeArtifact

func (s *CPIClient) DeployIntegrationDesigntimeArtifact(ArtifactId string, ArtifactVersion string) error

func (*CPIClient) DownloadIntegrationDesigntimeArtifact

func (s *CPIClient) DownloadIntegrationDesigntimeArtifact(ArtifactId string, ArtifactVersion string) (*IntegrationDesigntimeArtifact, error)

func (*CPIClient) ReadIntegrationDesigntimeArtifact

func (s *CPIClient) ReadIntegrationDesigntimeArtifact(ArtifactId string, ArtifactVersion string) (*IntegrationDesigntimeArtifact, error)

func (*CPIClient) ReadIntegrationDesigntimeArtifactConfigurations

func (s *CPIClient) ReadIntegrationDesigntimeArtifactConfigurations(ArtifactId string, ArtifactVersion string) ([]*Configuration, error)

func (*CPIClient) ReadIntegrationDesigntimeArtifacts

func (s *CPIClient) ReadIntegrationDesigntimeArtifacts(PackageId string, fetchConfig bool) ([]*IntegrationDesigntimeArtifact, error)

IntegrationDesigntimeArtifacts

func (*CPIClient) ReadIntegrationPackage

func (s *CPIClient) ReadIntegrationPackage(PackageId string) (*IntegrationPackage, error)

IntegrationPackage by ID

func (*CPIClient) ReadIntegrationPackages

func (s *CPIClient) ReadIntegrationPackages() ([]*IntegrationPackage, error)

IntegrationPackages

func (*CPIClient) ReadIntegrationRuntimeArtifact

func (s *CPIClient) ReadIntegrationRuntimeArtifact(ArtifactId string) (*IntegrationRuntimeArtifact, error)

IntegrationRuntimeArtifacts

func (*CPIClient) UndeployIntegrationRuntimeArtifact

func (s *CPIClient) UndeployIntegrationRuntimeArtifact(ArtifactId string) error

func (*CPIClient) UpdateIntegrationDesigntimeArtifactConfiguration

func (s *CPIClient) UpdateIntegrationDesigntimeArtifactConfiguration(ArtifactId string, ArtifactVersion string, configuration *Configuration) error

Configuration

func (*CPIClient) UploadIntegrationDesigntimeArtifact

func (s *CPIClient) UploadIntegrationDesigntimeArtifact(integrationArtifact *IntegrationDesigntimeArtifact) error

type Configuration

type Configuration struct {
	ParameterKey   string
	ParameterValue string
	DataType       string
}

type IntegrationDesigntimeArtifact

type IntegrationDesigntimeArtifact struct {
	Id              string
	Version         string `json:"-"`
	PackageId       string
	Name            string
	Description     string
	Sender          string `json:"-"`
	Receiver        string `json:"-"`
	ArtifactContent string
	Configurations  []*Configuration `json:"-"`
}

func (*IntegrationDesigntimeArtifact) GetConfiguration

func (artifact *IntegrationDesigntimeArtifact) GetConfiguration(parameter string) (*Configuration, error)

type IntegrationDesigntimeArtifactXMLEntry

type IntegrationDesigntimeArtifactXMLEntry struct {
	XMLName    xml.Name                                   `xml:"entry"`
	Properties IntegrationDesigntimeArtifactXMLProperties `xml:"properties"`
}

Workaround, while JSON response for certain requests is not supported

type IntegrationDesigntimeArtifactXMLProperties

type IntegrationDesigntimeArtifactXMLProperties struct {
	XMLName     xml.Name `xml:"properties"`
	Id          string   `xml:"Id"`
	Version     string   `xml:"Version"`
	PackageId   string   `xml:"PackageId"`
	Name        string   `xml:"Name"`
	Description string   `xml:"Description"`
	Sender      string   `xml:"Sender"`
	Receiver    string   `xml:"Receiver"`
}

type IntegrationPackage

type IntegrationPackage struct {
	Id                string
	Name              string
	Description       string
	ShortText         string
	Version           string
	Vendor            string
	PartnerContent    bool
	UpdateAvailable   bool
	Mode              string `json:"-"`
	SupportedPlatform string
	ModifiedBy        string `json:"-"`
	CreationDate      string `json:"-"`
	ModifiedDate      string `json:"-"`
	CreatedBy         string `json:"-"`
	Products          string
	Keywords          string
	Countries         string
	Industries        string
	LineOfBusiness    string
	PackageContent    string
}

type IntegrationRuntimeArtifact

type IntegrationRuntimeArtifact struct {
	Id         string
	Version    string
	Name       string
	Type       string
	DeployedBy string
	DeployedOn string
	Status     string
}