core

package

Go to main page

Versions in this module

v1

v1.1.0

Nov 6, 2019

Changes in this version

type BaseService

+ func (service *BaseService) ConfigureService(serviceName string) error

v1.0.1

Oct 18, 2019

v1.0.0

Oct 4, 2019

v0

v0.9.0

Sep 24, 2019

Changes in this version

+ const ERRORMSG_SSL_VERIFICATION_FAILED

+ const SSL_CERTIFICATION_ERROR

v0.8.0

Sep 16, 2019

Changes in this version

+ const ERRORMSG_SERVICE_URL_INVALID

+ const ERRORMSG_SERVICE_URL_MISSING

type BaseService

+ func (service *BaseService) GetServiceURL() string

+ func (service *BaseService) SetServiceURL(url string) error

v0.7.0

Sep 7, 2019

Changes in this version

type DetailedResponse

+ RawResult []byte

+ func (response *DetailedResponse) GetRawResult() []byte

+ func (response *DetailedResponse) GetResultAsMap() (map[string]interface{}, bool)

v0.6.0

Sep 3, 2019

v0.5.0

Aug 29, 2019

Changes in this version

+ const AUTHTYPE_BASIC

+ const AUTHTYPE_BEARER_TOKEN

+ const AUTHTYPE_CP4D

+ const AUTHTYPE_IAM

+ const AUTHTYPE_NOAUTH

+ const ERRORMSG_AUTHTYPE_UNKNOWN

+ const ERRORMSG_NO_AUTHENTICATOR

+ const ERRORMSG_PROPS_MAP_NIL

+ const ERRORMSG_PROP_INVALID

+ const ERRORMSG_PROP_MISSING

+ const IBM_CREDENTIAL_FILE_ENVVAR

+ const PROPNAME_APIKEY

+ const PROPNAME_AUTH_DISABLE_SSL

+ const PROPNAME_AUTH_TYPE

+ const PROPNAME_AUTH_URL

+ const PROPNAME_BEARER_TOKEN

+ const PROPNAME_CLIENT_ID

+ const PROPNAME_CLIENT_SECRET

+ const PROPNAME_PASSWORD

+ const PROPNAME_SVC_DISABLE_SSL

+ const PROPNAME_SVC_URL

+ const PROPNAME_USERNAME

+ type Authenticator interface

+ Authenticate func(*http.Request) error

+ AuthenticationType func() string

+ Validate func() error

+ func GetAuthenticatorFromEnvironment(credentialKey string) (authenticator Authenticator, err error)

+ type BasicAuthenticator struct

+ Password string

+ Username string

+ func NewBasicAuthenticator(username string, password string) (*BasicAuthenticator, error)

+ func (BasicAuthenticator) AuthenticationType() string

+ func (this BasicAuthenticator) Authenticate(request *http.Request) error

+ func (this BasicAuthenticator) Validate() error

+ type BearerTokenAuthenticator struct

+ BearerToken string

+ func NewBearerTokenAuthenticator(bearerToken string) (*BearerTokenAuthenticator, error)

+ func (BearerTokenAuthenticator) AuthenticationType() string

+ func (this BearerTokenAuthenticator) Authenticate(request *http.Request) error

+ func (this BearerTokenAuthenticator) Validate() error

+ type CloudPakForDataAuthenticator struct

+ Client *http.Client

+ DisableSSLVerification bool

+ Headers map[string]string

+ Password string

+ URL string

+ Username string

+ func NewCloudPakForDataAuthenticator(url string, username string, password string, disableSSLVerification bool, ...) (*CloudPakForDataAuthenticator, error)

+ func (CloudPakForDataAuthenticator) AuthenticationType() string

+ func (authenticator CloudPakForDataAuthenticator) Authenticate(request *http.Request) error

+ func (authenticator CloudPakForDataAuthenticator) Validate() error

+ type IamAuthenticator struct

+ ApiKey string

+ Client *http.Client

+ ClientId string

+ ClientSecret string

+ DisableSSLVerification bool

+ Headers map[string]string

+ URL string

+ func NewIamAuthenticator(apikey string, url string, clientId string, clientSecret string, ...) (*IamAuthenticator, error)

+ func (IamAuthenticator) AuthenticationType() string

+ func (authenticator IamAuthenticator) Authenticate(request *http.Request) error

+ func (this IamAuthenticator) Validate() error

+ type NoAuthAuthenticator struct

+ func NewNoAuthAuthenticator() (*NoAuthAuthenticator, error)

+ func (NoAuthAuthenticator) AuthenticationType() string

+ func (NoAuthAuthenticator) Validate() error

+ func (this NoAuthAuthenticator) Authenticate(request *http.Request) error

type ServiceOptions

+ Authenticator Authenticator

v0.4.2

Jul 24, 2019

Changes in this version

+ const FRACTION_OF_TIME_TO_LIVE

v0.4.1

Jun 14, 2019

v0.4.0

Jun 14, 2019

Changes in this version

+ const APIKEY

+ const DEFAULT_CONTENT_TYPE

+ const DEFAULT_IAM_CLIENT_ID

+ const DEFAULT_IAM_CLIENT_SECRET

+ const DEFAULT_IAM_URL

+ const IAM

+ const IAM_APIKEY

+ const ICP4D

+ const PRE_AUTH_PATH

+ const REQUEST_TOKEN_GRANT_TYPE

+ const REQUEST_TOKEN_RESPONSE_TYPE

+ func GetCurrentTime() int64

type BaseService

+ IAMTokenManager *IAMTokenManager

+ ICP4DTokenManager *ICP4DTokenManager

+ func (service *BaseService) SetICP4DAccessToken(icp4dAccessToken string)

+ type IAMTokenInfo struct

+ AccessToken string

+ Expiration int64

+ ExpiresIn int64

+ RefreshToken string

+ TokenType string

+ type IAMTokenManager struct

+ func NewIAMTokenManager(iamAPIkey string, iamURL string, userAccessToken string, iamClientId string, ...) (*IAMTokenManager, error)

+ func (tm *IAMTokenManager) GetToken() (string, error)

+ func (tm *IAMTokenManager) SetIAMAPIKey(key string)

+ func (tm *IAMTokenManager) SetIAMAccessToken(userAccessToken string)

+ type ICP4DTokenInfo struct

+ AccessToken string

+ Audience string

+ Issuer string

+ Message string

+ MessageCode string

+ Permissions []string

+ Role string

+ Subject string

+ UID string

+ Username string

+ type ICP4DTokenManager struct

+ func NewICP4DTokenManager(icp4dURL, username, password, accessToken string) *ICP4DTokenManager

+ func (tm *ICP4DTokenManager) DisableSSLVerification()

+ func (tm *ICP4DTokenManager) GetToken() (string, error)

+ func (tm *ICP4DTokenManager) SetICP4DAccessToken(userAccessToken string)

type ServiceOptions

+ AuthenticationType string

+ ICP4DAccessToken string

+ ICP4DURL string

v0.3.0

May 7, 2019

Changes in this version

+ const DefaultIAMClientId

+ const DefaultIAMClientSecret

type ServiceOptions

+ IAMClientId string

+ IAMClientSecret string

v0.2.4

Apr 17, 2019

v0.2.3

Mar 28, 2019

v0.2.2

Mar 28, 2019

Changes in this version

+ func PrettyPrint(result interface{}, resultName string)

v0.2.1

Mar 25, 2019

v0.2.0

Mar 25, 2019

Changes in this version

+ const UNKNOWN_ERROR

+ type Error struct

+ Message string

+ type Errors struct

+ Errors []Error

v0.1.0

Mar 22, 2019

Changes in this version

+ const API_KEY

+ const APPLICATION_JSON

+ const AUTHORIZATION

+ const Accept

+ const BEARER

+ const CONTENT_DISPOSITION

+ const CONTENT_TYPE

+ const DEFAULT_CREDENTIAL_FILE_NAME

+ const DELETE

+ const DefaultAuthorization

+ const DefaultContentType

+ const DefaultIAMURL

+ const FORM_URL_ENCODED_HEADER

+ const GET

+ const IAM_API_KEY

+ const IAM_URL

+ const IBM_CREDENTIAL_FILE_ENV

+ const ICP_PREFIX

+ const PASSWORD

+ const PATCH

+ const POST

+ const PUT

+ const RefreshTokenGrantType

+ const RequestTokenGrantType

+ const RequestTokenResponseType

+ const SDK_NAME

+ const URL

+ const USERNAME

+ const USER_AGENT

+ var Validate *validator.Validate

+ func BoolPtr(literal bool) *bool

+ func Float32Ptr(literal float32) *float32

+ func Float64Ptr(literal float64) *float64

+ func HasBadFirstOrLastChar(str string) bool

+ func Int64Ptr(literal int64) *int64

+ func IsJSONMimeType(mimeType string) bool

+ func IsJSONPatchMimeType(mimeType string) bool

+ func StringNilMapper(s *string) string

+ func StringPtr(literal string) *string

+ func SystemInfo() string

+ func UserHomeDir() string

+ func ValidateNotNil(object interface{}, errorMsg string) error

+ func ValidateStruct(param interface{}, paramName string) error

+ type BaseService struct

+ Client *http.Client

+ DefaultHeaders http.Header

+ Options *ServiceOptions

+ TokenManager *TokenManager

+ UserAgent string

+ func NewBaseService(options *ServiceOptions, serviceName, displayName string) (*BaseService, error)

+ func (service *BaseService) BuildUserAgent() string

+ func (service *BaseService) DisableSSLVerification()

+ func (service *BaseService) Request(req *http.Request, result interface{}) (*DetailedResponse, error)

+ func (service *BaseService) SetDefaultHeaders(headers http.Header)

+ func (service *BaseService) SetHTTPClient(client *http.Client)

+ func (service *BaseService) SetIAMAPIKey(iamAPIKey string) error

+ func (service *BaseService) SetIAMAccessToken(iamAccessToken string)

+ func (service *BaseService) SetTokenManager(iamAPIKey string, iamAccessToken string, iamURL string) error

+ func (service *BaseService) SetURL(url string) error

+ func (service *BaseService) SetUserAgent(userAgentString string)

+ func (service *BaseService) SetUsernameAndPassword(username string, password string) error

+ type Credential struct

+ APIKey string

+ Password string

+ URL string

+ Username string

+ func LoadFromVCAPServices(serviceName string) *Credential

+ type DetailedResponse struct

+ Headers http.Header

+ Result interface{}

+ StatusCode int

+ func (response *DetailedResponse) GetHeaders() http.Header

+ func (response *DetailedResponse) GetResult() interface{}

+ func (response *DetailedResponse) GetStatusCode() int

+ func (response *DetailedResponse) String() string

+ type FormData struct

+ type RequestBuilder struct

+ Body io.Reader

+ Form map[string]FormData

+ Header http.Header

+ Method string

+ Query map[string]string

+ URL *url.URL

+ func NewRequestBuilder(method string) *RequestBuilder

+ func (requestBuilder *RequestBuilder) AddFormData(fieldName string, fileName string, contentType string, contents interface{}) *RequestBuilder

+ func (requestBuilder *RequestBuilder) AddHeader(name string, value string) *RequestBuilder

+ func (requestBuilder *RequestBuilder) AddQuery(name string, value string) *RequestBuilder

+ func (requestBuilder *RequestBuilder) Build() (*http.Request, error)

+ func (requestBuilder *RequestBuilder) ConstructHTTPURL(endPoint string, pathSegments []string, pathParameters []string) *RequestBuilder

+ func (requestBuilder *RequestBuilder) SetBodyContent(contentType string, jsonContent interface{}, jsonPatchContent interface{}, ...) (*RequestBuilder, error)

+ func (requestBuilder *RequestBuilder) SetBodyContentForMultipart(contentType string, content interface{}, writer io.Writer) error

+ func (requestBuilder *RequestBuilder) SetBodyContentJSON(bodyContent interface{}) (*RequestBuilder, error)

+ func (requestBuilder *RequestBuilder) SetBodyContentStream(bodyContent io.Reader) (*RequestBuilder, error)

+ func (requestBuilder *RequestBuilder) SetBodyContentString(bodyContent string) (*RequestBuilder, error)

+ type Service struct

+ Credentials Credential

+ type ServiceOptions struct

+ IAMAccessToken string

+ IAMApiKey string

+ IAMURL string

+ Password string

+ URL string

+ Username string

+ Version string

+ type TokenInfo struct

+ AccessToken string

+ Expiration int64

+ ExpiresIn int64

+ RefreshToken string

+ TokenType string

+ type TokenManager struct

+ func NewTokenManager(iamAPIkey string, iamURL string, userAccessToken string) *TokenManager

+ func (tm *TokenManager) GetToken() (string, error)

+ func (tm *TokenManager) SetAccessToken(userAccessToken string)

+ func (tm *TokenManager) SetIAMAPIKey(key string)

Other modules containing this package

github.com/IBM/go-sdk-core/v3

github.com/IBM/go-sdk-core/v4

github.com/IBM/go-sdk-core/v5

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL