sty_shared

Documentation

Overview

Package sty_shared

This is the STY-Holdings shared services

NOTES:

Validation of the config must be done in the caller.

COPYRIGHT & WARRANTY:

Copyright (c) 2022 STY-Holdings, inc
All rights reserved.

This software is the confidential and proprietary information of STY-Holdings, Inc.
Use is subject to license terms.

Unauthorized copying of this file, via any medium is strictly prohibited.

Proprietary and confidential

Written by Scott Yacko / syacko
STY-Holdings, Inc.
support@sty-holdings.com
www.sty-holdings.com

01-2024
USA

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 sty_shared

This is the STY-Holdings shared services

NOTES:

None

COPYRIGHT & WARRANTY:

Copyright (c) 2022 STY-Holdings, inc
All rights reserved.

This software is the confidential and proprietary information of STY-Holdings, Inc.
Use is subject to license terms.

Unauthorized copying of this file, via any medium is strictly prohibited.

Proprietary and confidential

Written by Scott Yacko / syacko
STY-Holdings, Inc.
support@sty-holdings.com
www.sty-holdings.com

01-2024
USA

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

• Constants
• func GenerateConfigFileSkeleton(serverName, SkeletonConfigFQD string) (errorInfo pi.ErrorInfo)
• func GetConfigFile(configFileFQN string) (configData map[string]interface{}, errorInfo pi.ErrorInfo)
• func ReadConfigFile(configFileFQN string) (configData []byte, errorInfo pi.ErrorInfo)

Constants

const (
	DEFAULT_LOG_DIRECTORY                    = "/var/log/natsSerices-connect"
	DEFAULT_MAX_THREADS                      = 1
	DEFAULT_PID_DIRECTORY                    = "/var/run/natsSerices-connect"
	DEFAULT_SKELETON_CONFIG_FQD              = "/Users/syacko/workspace/sty-holdings/GriesPikeThomp/shared-services/src/coreConfiguration/"
	DEFAULT_SKELETON_CONFIG_FILENAME         = "skeleton-config-file.json"
	DEFAULT_SKELETON_CONFIG_NOTE_FILENAME    = "skeleton-config-file.txt"
	DEFAULT_INVALID_SKELETON_CONFIG_FILENAME = "invalid-skeleton-config-file.json"
	DEFAULT_UNREADABLE_CONFIG_FILENAME       = "unreadable-skeleton-config-file.json"
)

Functions

func GenerateConfigFileSkeleton

func GenerateConfigFileSkeleton(serverName, SkeletonConfigFQD string) (errorInfo pi.ErrorInfo)

GenerateConfigFileSkeleton will output to the console a skeleton file with notes.

Customer Messages: None
Errors: ErrConfigFileMissing
Verifications: None

func GetConfigFile

func GetConfigFile(
	configFileFQN string,
) (
	configData map[string]interface{},
	errorInfo pi.ErrorInfo,
)

GetConfigFile - reads and unmarshals the file into a map.

Customer Messages: None
Errors: ReadConfigFile returned error, ErrJSONInvalid
Verifications: None

func ReadConfigFile

func ReadConfigFile(configFileFQN string) (
	configData []byte,
	errorInfo pi.ErrorInfo,
)

ReadConfigFile - opens the provide file and returns the contents.

Customer Messages: None
Errors: ReadConfigFile returned error
Verifications: None