utils

Documentation

Index

• Variables
• func CombineByteArraysForJSON(elements [][]byte, elementName []string) ([]byte, error)
• func DirectoryExists(directory string) bool
• func EnsureDirectory(directory string) error
• func EnsureDirectoryWithPerms(directory string, perm fs.FileMode) error
• func FileExists(path string) bool
• func FormatPartitions(partitions []int) string
• func GetBackupCount(ownership map[int]*config.PartitionOwnership) int
• func GetCoherenceMainClass(_ string) string
• func GetError(message string, err error) error
• func GetErrors(errorList []error) error
• func GetJSONPathResults(jsonData []byte, jsonPath string) (string, error)
• func GetMemberCountReceiving(members []string) int32
• func GetSliceIndex(theSlice []string, value string) int
• func GetStartupDelayInMillis(startupDelay string) (int64, error)
• func GetStorageMap(storage config.StorageDetails) map[int]bool
• func GetStringValueFromEnvVarOrDefault(envVar string, defaultValue string) string
• func GetTLSDetails() ([]tls.Certificate, *x509.CertPool, string, string, string, error)
• func GetUniqueValues(input []string) []string
• func IsDistributedCache(serviceType string) bool
• func IsStorageEnabled(nodeID int, storageMap map[int]bool) bool
• func IsValidInt(value string) bool
• func ParsePartitionOwnership(sOwnership string) (map[int]*config.PartitionOwnership, error)
• func ProcessJSONPath(jsonData interface{}, jsonPathQuery string) ([]byte, error)
• func SanitizeSnapshotName(snapshotName string) string
• func SliceContains(theSlice []string, value string) bool
• func ValidatePort(port int32) error
• func ValidateStartClass(startClass string) error

Variables

var (
	// DebugEnabled defines if debugging is enabled
	DebugEnabled bool

	// Logger is the logger to use for writing logs
	Logger *zap.Logger

	// ErrPort indicates an invalid port value
	ErrPort = errors.New("port must be between 1024 and 65535")
)

Functions

func CombineByteArraysForJSON

func CombineByteArraysForJSON(elements [][]byte, elementName []string) ([]byte, error)

CombineByteArraysForJSON combines byte arrays for json output

func DirectoryExists

func DirectoryExists(directory string) bool

DirectoryExists returns a bool indicating if a directory exists.

func EnsureDirectory

func EnsureDirectory(directory string) error

EnsureDirectory ensures a directory exists and if not then will create it.

func EnsureDirectoryWithPerms

func EnsureDirectoryWithPerms(directory string, perm fs.FileMode) error

EnsureDirectoryWithPerms ensures a directory exists and if not then will create it with specific permissions.

func FileExists

func FileExists(path string) bool

FileExists returns a bool indicating if a file exists and is not a directory.

func FormatPartitions

func FormatPartitions(partitions []int) string

func GetBackupCount

func GetBackupCount(ownership map[int]*config.PartitionOwnership) int

func GetCoherenceMainClass

func GetCoherenceMainClass(_ string) string

GetCoherenceMainClass returns the default startup class for the specified Coherence version. In the future this may be automatically determined but default to coherenceMain.

func GetError

func GetError(message string, err error) error

GetError returns a formatted error and prints to log.

func GetErrors

func GetErrors(errorList []error) error

GetErrors return an error containing either the single error or an error indicating there are multiple errors in the log.

func GetJSONPathResults

func GetJSONPathResults(jsonData []byte, jsonPath string) (string, error)

GetJSONPathResults returns jsonapth results.

func GetMemberCountReceiving

func GetMemberCountReceiving(members []string) int32

func GetSliceIndex

func GetSliceIndex(theSlice []string, value string) int

GetSliceIndex returns the index of the matching slice value.

func GetStartupDelayInMillis

func GetStartupDelayInMillis(startupDelay string) (int64, error)

GetStartupDelayInMillis returns the startup delay in millis converted from the following suffixes: ms = millis - eg. 10ms s = seconds ed 5s no suffix is millis.

func GetStorageMap

func GetStorageMap(storage config.StorageDetails) map[int]bool

GetStorageMap returns a map by node Id indicating if the node is storage enabled.

func GetStringValueFromEnvVarOrDefault

func GetStringValueFromEnvVarOrDefault(envVar string, defaultValue string) string

func GetTLSDetails

func GetTLSDetails() ([]tls.Certificate, *x509.CertPool, string, string, string, error)

func GetUniqueValues

func GetUniqueValues(input []string) []string

GetUniqueValues returns the slice of unique values.

func IsDistributedCache

func IsDistributedCache(serviceType string) bool

IsDistributedCache returns true if the service type is distributed.

func IsStorageEnabled

func IsStorageEnabled(nodeID int, storageMap map[int]bool) bool

IsStorageEnabled returns true or false.

func IsValidInt

func IsValidInt(value string) bool

IsValidInt returns true or false indicating if a string int is a valid integer.

func ParsePartitionOwnership

func ParsePartitionOwnership(sOwnership string) (map[int]*config.PartitionOwnership, error)

func ProcessJSONPath

func ProcessJSONPath(jsonData interface{}, jsonPathQuery string) ([]byte, error)

ProcessJSONPath parses json path expression on Json and returns the json.

func SanitizeSnapshotName

func SanitizeSnapshotName(snapshotName string) string

SanitizeSnapshotName sanitizes a snapshot name by replacing any unwanted characters with '-'.

func SliceContains

func SliceContains(theSlice []string, value string) bool

SliceContains returns true of the slice contains the value.

func ValidatePort

func ValidatePort(port int32) error

ValidatePort validates that a port is valid.

func ValidateStartClass

func ValidateStartClass(startClass string) error

ValidateStartClass validates that the server start class is and empty string, and therefore use the default, or a valid option.