validation

Documentation

Index

• Constants
• Variables
• func AppendHTTPListenerError(httpListenerReport *validation.HttpListenerReport, ...)
• func AppendHTTPListenerWarning(httpListenerReport *validation.HttpListenerReport, ...)
• func AppendListenerError(listenerReport *validation.ListenerReport, ...)
• func AppendListenerWarning(listenerReport *validation.ListenerReport, ...)
• func AppendRouteError(routeReport *validation.RouteReport, errType validation.RouteReport_Error_Type, ...)
• func AppendRouteErrorWithMetadata(routeReport *validation.RouteReport, errType validation.RouteReport_Error_Type, ...)
• func AppendRouteWarning(routeReport *validation.RouteReport, ...)
• func AppendTCPListenerError(tcpListenerReport *validation.TcpListenerReport, ...)
• func AppendTCPListenerWarning(httpListenerReport *validation.TcpListenerReport, ...)
• func AppendTcpHostWarning(tcpHostReport *validation.TcpHostReport, ...)
• func AppendVirtualHostError(virtualHostReport *validation.VirtualHostReport, ...)
• func AppendVirtualHostErrorWithMetadata(virtualHostReport *validation.VirtualHostReport, ...)
• func GetHttpListenerErr(httpListener *validation.HttpListenerReport) []error
• func GetHttpListenerWarning(httpListener *validation.HttpListenerReport) []string
• func GetListenerErr(listener *validation.ListenerReport) []error
• func GetListenerError(listener *validation.ListenerReport) []error
• func GetListenerWarn(listener *validation.ListenerReport) []string
• func GetListenerWarning(listener *validation.ListenerReport) []string
• func GetProxyError(proxyRpt *validation.ProxyReport) error
• func GetProxyWarning(proxyRpt *validation.ProxyReport) []string
• func GetRouteErr(route *validation.RouteReport) []error
• func GetRouteWarning(route *validation.RouteReport) []string
• func GetTcpHostErr(tcpHost *validation.TcpHostReport) []error
• func GetTcpHostWarning(tcpHost *validation.TcpHostReport) []string
• func GetTcpListenerErr(tcpListener *validation.TcpListenerReport) []error
• func GetTcpListenerWarning(tcpListener *validation.TcpListenerReport) []string
• func GetVirtualHostErr(virtualHost *validation.VirtualHostReport) []error
• func MakeReport(proxy *v1.Proxy) *validation.ProxyReport
• type ErrorLevelContext
• type ErrorWithKnownLevel
• type TcpHostWarning
  • func (tcpHostWarning *TcpHostWarning) Error() string
  • func (tcpHostWarning *TcpHostWarning) ErrorLevel() string
  • func (tcpHostWarning *TcpHostWarning) GetContext() ErrorLevelContext
  • func (tcpHostWarning *TcpHostWarning) GetError() error

Constants

const (
	ErrorLevels_WARNING string = "WARNING"
	ErrorLevels_ERROR   string = "ERROR"
)

Variables

var (
	RouteErrorMsg      = "Route Error"
	RouteIdentifierTxt = "Route Name"
)

Functions

func AppendHTTPListenerError

func AppendHTTPListenerError(httpListenerReport *validation.HttpListenerReport, errType validation.HttpListenerReport_Error_Type, reason string)

func AppendHTTPListenerWarning

func AppendHTTPListenerWarning(httpListenerReport *validation.HttpListenerReport, errType validation.HttpListenerReport_Warning_Type, reason string)

func AppendListenerError

func AppendListenerError(listenerReport *validation.ListenerReport, errType validation.ListenerReport_Error_Type, reason string)

func AppendListenerWarning

func AppendListenerWarning(listenerReport *validation.ListenerReport, errType validation.ListenerReport_Warning_Type, reason string)

func AppendRouteError

func AppendRouteError(routeReport *validation.RouteReport, errType validation.RouteReport_Error_Type, reason string, routeName string)

func AppendRouteErrorWithMetadata

func AppendRouteErrorWithMetadata(routeReport *validation.RouteReport, errType validation.RouteReport_Error_Type, reason string, routeName string, metadata *v1.SourceMetadata)

func AppendRouteWarning

func AppendRouteWarning(routeReport *validation.RouteReport, errType validation.RouteReport_Warning_Type, reason string)

func AppendTCPListenerError

func AppendTCPListenerError(tcpListenerReport *validation.TcpListenerReport, errType validation.TcpListenerReport_Error_Type, reason string)

func AppendTCPListenerWarning

func AppendTCPListenerWarning(httpListenerReport *validation.TcpListenerReport, errType validation.TcpListenerReport_Warning_Type, reason string)

func AppendTcpHostWarning

func AppendTcpHostWarning(tcpHostReport *validation.TcpHostReport, errType validation.TcpHostReport_Warning_Type, reason string)

func AppendVirtualHostError

func AppendVirtualHostError(virtualHostReport *validation.VirtualHostReport, errType validation.VirtualHostReport_Error_Type, reason string)

func AppendVirtualHostErrorWithMetadata

func AppendVirtualHostErrorWithMetadata(virtualHostReport *validation.VirtualHostReport, errType validation.VirtualHostReport_Error_Type, reason string, metadata *v1.SourceMetadata)

func GetHttpListenerErr

func GetHttpListenerErr(httpListener *validation.HttpListenerReport) []error

GetHttpListenerErr returns the formatted errors on the HttpListenerReport only. It does NOT recursively aggregate errors in its sub-reports such as VirtualHostReports, RouteReports, etc.

func GetHttpListenerWarning

func GetHttpListenerWarning(httpListener *validation.HttpListenerReport) []string

GetHttpListenerWarning returns the formatted warnings on the HttpListenerReport only. It does NOT recursively aggregate warnings in its sub-reports such as VirtualHostReports, RouteReports, etc.

func GetListenerErr

func GetListenerErr(listener *validation.ListenerReport) []error

GetListenerErr returns the formatted errors on the ListenerReport only. It does NOT recursively aggregate errors in its sub-reports such as its host report, route report, etc.

func GetListenerError

func GetListenerError(listener *validation.ListenerReport) []error

GetListenerError returns the aggregated errors on the ListenerReport. Based on the type of listener, it aggregates the errors in its sub-reports such as its host report, route report, etc.

func GetListenerWarn

func GetListenerWarn(listener *validation.ListenerReport) []string

GetListenerWarn returns the formatted warnings on the ListenerReport only. It does NOT recursively aggregate errors in its sub-reports such as its host report, route report, etc.

func GetListenerWarning

func GetListenerWarning(listener *validation.ListenerReport) []string

GetListenerWarning returns the aggregated warnings on the ListenerReport. Based on the type of listener, it aggregates the warnings in its sub-reports such as its host report, route report, etc.

func GetProxyError

func GetProxyError(proxyRpt *validation.ProxyReport) error

GetProxyError returns the aggregated errors on the ProxyReport. It iterates through the listeners and based on the type of listener, it aggregates the errors in its sub-reports such as its host report, route report, etc.

func GetProxyWarning

func GetProxyWarning(proxyRpt *validation.ProxyReport) []string

GetProxyWarning returns the aggregated warnings on the ProxyReport. It iterates through the listeners and based on the type of listener, it aggregates the warnings in its sub-reports such as its host report, route report, etc.

func GetRouteErr

func GetRouteErr(route *validation.RouteReport) []error

GetRouteErr returns the formatted errors on the RouteReport.

func GetRouteWarning

func GetRouteWarning(route *validation.RouteReport) []string

GetRouteWarning returns the formatted warnings on the RouteReport.

func GetTcpHostErr

func GetTcpHostErr(tcpHost *validation.TcpHostReport) []error

GetTcpHostErr returns the formatted errors on the TcpHostReport.

func GetTcpHostWarning

func GetTcpHostWarning(tcpHost *validation.TcpHostReport) []string

GetTcpHostWarning returns the formatted warnings on the TcpHostReport.

func GetTcpListenerErr

func GetTcpListenerErr(tcpListener *validation.TcpListenerReport) []error

GetTcpListenerErr returns the formatted errors on the TcpListenerReport only. It does NOT recursively aggregate errors in its sub-reports such as TcpHostReports, etc.

func GetTcpListenerWarning

func GetTcpListenerWarning(tcpListener *validation.TcpListenerReport) []string

GetTcpListenerWarning returns the formatted warnings on the TcpListenerReport only. It does NOT recursively aggregate warnings in its sub-reports such as TcpHostReports, etc.

func GetVirtualHostErr

func GetVirtualHostErr(virtualHost *validation.VirtualHostReport) []error

GetVirtualHostErr returns the formatted errors on the VirtualHostReport only. It does NOT recursively aggregate errors in its sub-reports such as Routes, etc.

func MakeReport

func MakeReport(proxy *v1.Proxy) *validation.ProxyReport

Types

type ErrorLevelContext

type ErrorLevelContext struct {
	// A given TCP listener can have multiple TCP hosts; HostNum provides the
	// numerical index of the host on the listener associated with the error to
	// be reported
	HostNum *int
}

ErrorLevelContext carries additional information to be passed in the ErrorWithKnownLevel object

type ErrorWithKnownLevel

type ErrorWithKnownLevel interface {
	error
	// The severity of the error - should return either ErrorLevels_WARNING or
	// ErrorLevels_ERROR
	ErrorLevel() string
	// Additional contextual information required to report the error/warning
	GetContext() ErrorLevelContext
	// The instance of the error itself
	GetError() error
}

Types implementing ErrorWithKnownLevel are able to report on the severity of the error they describe by evaluating ErrorLevel()

type TcpHostWarning

type TcpHostWarning struct {
	Err      error
	ErrLevel string
	Context  ErrorLevelContext
}

TcpHostWarning implements ErrorWithKnownLevel; it is intended to allow reporting certain errors as warnings and others as errors, and provides the necessary context required for reporting errors as such

func (*TcpHostWarning) Error

func (tcpHostWarning *TcpHostWarning) Error() string

func (*TcpHostWarning) ErrorLevel

func (tcpHostWarning *TcpHostWarning) ErrorLevel() string

func (*TcpHostWarning) GetContext

func (tcpHostWarning *TcpHostWarning) GetContext() ErrorLevelContext

func (*TcpHostWarning) GetError

func (tcpHostWarning *TcpHostWarning) GetError() error

return the instance of the Error this object is wrapping