iot_server/internal/pkg/messaging/mqclient/errors.go

/********************************************************************************
 *  Copyright 2020 Dell Inc.
 *
 * 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.
 *******************************************************************************/

package mqclient

import "fmt"

// CertificateErr represents an error associated with interacting with a Certificate.
type CertificateErr struct {
	description string
}

func (ce CertificateErr) Error() string {
	return fmt.Sprintf("Unable to process certificate properties: %s", ce.description)
}

// NewCertificateErr constructs a new CertificateErr
func NewCertificateErr(message string) CertificateErr {
	return CertificateErr{description: message}
}

// BrokerURLErr represents an error associated parsing a broker's URL.
type BrokerURLErr struct {
	description string
}

func (bue BrokerURLErr) Error() string {
	return fmt.Sprintf("Unable to process broker URL: %s", bue.description)
}

// NewBrokerURLErr constructs a new BrokerURLErr
func NewBrokerURLErr(description string) BrokerURLErr {
	return BrokerURLErr{description: description}
}

type PublishHostURLErr struct {
	description string
}

func (p PublishHostURLErr) Error() string {
	return fmt.Sprintf("Unable to use PublishHost URL: %s", p.description)
}

func NewPublishHostURLErr(message string) PublishHostURLErr {
	return PublishHostURLErr{description: message}
}

type SubscribeHostURLErr struct {
	description string
}

func (p SubscribeHostURLErr) Error() string {
	return fmt.Sprintf("Unable to use SubscribeHost URL: %s", p.description)
}

func NewSubscribeHostURLErr(message string) SubscribeHostURLErr {
	return SubscribeHostURLErr{description: message}
}

type MissingConfigurationErr struct {
	missingConfiguration string
	description          string
}

func (mce MissingConfigurationErr) Error() string {
	return fmt.Sprintf("Missing configuration '%s' : %s", mce.missingConfiguration, mce.description)
}

func NewMissingConfigurationErr(missingConfiguration string, message string) MissingConfigurationErr {
	return MissingConfigurationErr{
		missingConfiguration: missingConfiguration,
		description:          message,
	}
}

type InvalidTopicErr struct {
	topic       string
	description string
}

func (ite InvalidTopicErr) Error() string {
	return fmt.Sprintf("Invalid topic '%s': %s", ite.topic, ite.description)
}

func NewInvalidTopicErr(topic string, description string) InvalidTopicErr {
	return InvalidTopicErr{
		topic:       topic,
		description: description,
	}
}

type SubscribeTopicGroupErr struct {
	topic       string
	group       string
	description string
}

func (ite SubscribeTopicGroupErr) Error() string {
	return fmt.Sprintf("subscribe topic group err topic '%s' group '%s' : %s", ite.topic, ite.group, ite.description)
}

func NewSubscribeTopicGroupErr(topic, group, description string) SubscribeTopicGroupErr {
	return SubscribeTopicGroupErr{
		topic:       topic,
		group:       group,
		description: description,
	}
}