sty_shared

Documentation

Overview

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 <Replace with FULL_NAME> / 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

General description of the purpose of the go file.

RESTRICTIONS:

AWS functions:
* Program must have access to a .awsServices/credentials file in the default location.
* This will only access system parameters that start with '/sote' (ROOTPATH).
* {Enter other restrictions here for AWS

{Other catagories of restrictions}
* {List of restrictions for the catagory

NOTES:

{Enter any additional notes that you believe will help the next developer.}

COPYRIGHT:

Copyright 2022
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.

Index

• Constants
• type HTTPConfiguration
• type HTTPService
  • func NewHTTP(configFilename string) (service HTTPService, errorInfo pi.ErrorInfo)
• type RouteInfo

Constants

const (
	TEST_CREDENTIALS_FILENAME = "/Users/syacko/workspace/styh-dev/src/albert/keys/local/.keys/natsSerices-savup-backend.key"
	TEST_MESSAGE_ENVIRONMENT  = "local"
	TEST_MESSAGE_NAMESPACE    = "nci"
	TEST_URL                  = "savup-local-0030.savup.com"
	TEST_PORT                 = 4222
	TEST_PORT_EMPTY           = ""
	TEST_TLS_CERT             = "/Users/syacko/workspace/styh-dev/src/albert/keys/local/.keys/savup/STAR_savup_com/STAR_savup_com.crt"
	TEST_TLS_PRIVATE_KEY      = "/Users/syacko/workspace/styh-dev/src/albert/keys/local/.keys/savup/STAR_savup_com/savup.com.key"
	TEST_TLS_CA_BUNDLE        = "/Users/syacko/workspace/styh-dev/src/albert/keys/local/.keys/savup/STAR_savup_com/CAbundle.crt"
	//
	TEST_INVALID_URL = "invalid URL"
)

Types

type HTTPConfiguration

type HTTPConfiguration struct {
	CredentialsFilename string       `json:"credentials_filename"`
	GinMode             string       `json:"gin_mode"`
	HTTPDomain          string       `json:"http_domain"`
	MessageEnvironment  string       `json:"message_environment"`
	Port                int          `json:"port"`
	RequestedThreads    uint         `json:"requested_threads"`
	RouteRegistry       []RouteInfo  `json:"route_registry"`
	TLSInfo             jwts.TLSInfo `json:"tls_info"`
}

type HTTPService

type HTTPService struct {
	Config         HTTPConfiguration
	CredentialsFQN string
	HTTPServerPtr  *http.Server
	Secure         bool
}

func NewHTTP

func NewHTTP(configFilename string) (
	service HTTPService,
	errorInfo pi.ErrorInfo,
)

NewHTTP - creates a new httpServices service using the provided extension values.

Customer Messages: None
Errors: error returned by validateConfiguration
Verifications: validateConfiguration

type RouteInfo

type RouteInfo struct {
	Namespace   string `json:"namespace"`
	Subject     string `json:"subject"`
	Description string `json:"description"`
}