server

package

v0.0.0-...-8f6edbe Latest Latest Go to latest Published: May 30, 2023 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/InterDigitalInc/AdvantEDGE

Links

Open Source Insights

README ¶

Go API Server for server

MEC Service Management Service is AdvantEDGE's implementation of ETSI MEC ISG MEC011 Application Enablement API

Copyright (c) ETSI 2017

Micro-service
meep-app-enablement

Type & Usage
Edge Service used by edge applications that want to get information about services in the network

Note
AdvantEDGE supports all of Service Management API endpoints (see below).

Overview

This server was generated by the [swagger-codegen] (https://github.com/swagger-api/swagger-codegen) project.
By using the OpenAPI-Spec from a remote server, you can easily generate a server stub.

To see how to make this your own, look here:

README

API version: 2.2.1
Build date: 2022-12-19T08:32:22.065107-05:00[America/Toronto]

Running the server

To run the server, follow these simple steps:

go run main.go

Documentation ¶

Overview ¶

* Copyright (c) 2022 The AdvantEDGE Authors * * 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. * * AdvantEDGE Service Management API * * MEC Service Management Service is AdvantEDGE's implementation of [ETSI MEC ISG MEC011 Application Enablement API](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.02.01_60/gs_MEC011v020201p.pdf) [Copyright (c) ETSI 2017](https://forge.etsi.org/etsi-forge-copyright-notice.txt) **Micro-service** [meep-app-enablement](https://github.com/InterDigitalInc/AdvantEDGE/tree/master/go-apps/meep-app-enablement/server/service-mgmt) **Type & Usage** Edge Service used by edge applications that want to get information about services in the network **Note** AdvantEDGE supports all of Service Management API endpoints (see below). * * API version: 2.2.1 * Contact: AdvantEDGE@InterDigital.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Constants
Variables
func AppServicesGET(w http.ResponseWriter, r *http.Request)
func AppServicesPOST(w http.ResponseWriter, r *http.Request)
func AppServicesServiceIdDELETE(w http.ResponseWriter, r *http.Request)
func AppServicesServiceIdGET(w http.ResponseWriter, r *http.Request)
func AppServicesServiceIdPUT(w http.ResponseWriter, r *http.Request)
func ApplicationsSubscriptionDELETE(w http.ResponseWriter, r *http.Request)
func ApplicationsSubscriptionGET(w http.ResponseWriter, r *http.Request)
func ApplicationsSubscriptionsGET(w http.ResponseWriter, r *http.Request)
func ApplicationsSubscriptionsPOST(w http.ResponseWriter, r *http.Request)
func DeleteServiceSubscriptions(appId string) error
func DeleteServices(appId string) error
func Init(sandbox string, mep string, host *url.URL, msgQueue *mq.MsgQueue, ...) (err error)
func Run() (err error)
func ServicesGET(w http.ResponseWriter, r *http.Request)
func ServicesServiceIdGET(w http.ResponseWriter, r *http.Request)
func Stop() (err error)
func TransportsGET(w http.ResponseWriter, r *http.Request)
type CategoryRef
type EndPointInfoAddresses
type EndPointInfoAddressesAddresses
type EndPointInfoAlternative
type EndPointInfoUris
type FilterParameters
type GrantType
type LinkType
type LocalityType
type OAuth2Info
type OneOfServiceInfoPost
type OneOfTransportInfoEndpoint
type ProblemDetails
type SecurityInfo
type Self
type SerAvailabilityNotificationSubscription
type SerAvailabilityNotificationSubscriptionFilteringCriteria
type SerializerType
type ServiceAvailabilityNotification
type ServiceAvailabilityNotificationChangeType
type ServiceAvailabilityNotificationServiceReferences
type ServiceInfo
type ServiceInfoLinks
type ServiceInfoList
type ServiceInfoPost
type ServiceLivenessInfo
type ServiceLivenessInfoTimeStamp
type ServiceLivenessUpdate
type ServiceState
type StateData
type Subscription
type SubscriptionLinkList
type SubscriptionLinkListLinks
type SubscriptionLinkListLinksSubscriptions
type TransportInfo
type TransportType

Constants ¶

View Source

const APP_STATE_READY = "READY"

View Source

const SER_AVAILABILITY_NOTIF_SUB_TYPE = "SerAvailabilityNotificationSubscription"

View Source

const SER_AVAILABILITY_NOTIF_TYPE = "SerAvailabilityNotification"

Variables ¶

View Source

var APP_ENABLEMENT_DB = 0

Functions ¶

func AppServicesGET ¶

func AppServicesGET(w http.ResponseWriter, r *http.Request)

func AppServicesPOST ¶

func AppServicesPOST(w http.ResponseWriter, r *http.Request)

func AppServicesServiceIdDELETE ¶

func AppServicesServiceIdDELETE(w http.ResponseWriter, r *http.Request)

func AppServicesServiceIdGET ¶

func AppServicesServiceIdGET(w http.ResponseWriter, r *http.Request)

func AppServicesServiceIdPUT ¶

func AppServicesServiceIdPUT(w http.ResponseWriter, r *http.Request)

func ApplicationsSubscriptionDELETE ¶

func ApplicationsSubscriptionDELETE(w http.ResponseWriter, r *http.Request)

func ApplicationsSubscriptionGET ¶

func ApplicationsSubscriptionGET(w http.ResponseWriter, r *http.Request)

func ApplicationsSubscriptionsGET ¶

func ApplicationsSubscriptionsGET(w http.ResponseWriter, r *http.Request)

func ApplicationsSubscriptionsPOST ¶

func ApplicationsSubscriptionsPOST(w http.ResponseWriter, r *http.Request)

func DeleteServiceSubscriptions ¶

func DeleteServiceSubscriptions(appId string) error

Delete App services subscriptions

func DeleteServices ¶

func DeleteServices(appId string) error

Delete App services

func Init ¶

func Init(sandbox string, mep string, host *url.URL, msgQueue *mq.MsgQueue, globalMutex *sync.Mutex) (err error)

func Run ¶

func Run() (err error)

Run - Start Service Mgmt

func ServicesGET ¶

func ServicesGET(w http.ResponseWriter, r *http.Request)

func ServicesServiceIdGET ¶

func ServicesServiceIdGET(w http.ResponseWriter, r *http.Request)

func Stop ¶

func Stop() (err error)

Stop - Stop Service Mgmt

func TransportsGET ¶

func TransportsGET(w http.ResponseWriter, r *http.Request)

Types ¶

type CategoryRef ¶

type CategoryRef struct {
	// Reference of the catalogue
	Href string `json:"href"`
	// Unique identifier of the category
	Id string `json:"id"`
	// Name of the category, example values include RNI, Location & Bandwidth Management
	Name string `json:"name"`
	// Category version
	Version string `json:"version"`
}

This type represents the category reference

type EndPointInfoAddresses ¶

type EndPointInfoAddresses struct {
	Addresses []EndPointInfoAddressesAddresses `json:"addresses"`
}

Entry point information of the service as one or more pairs of IP address and port

type EndPointInfoAddressesAddresses ¶

type EndPointInfoAddressesAddresses struct {
	// Host portion of the address
	Host string `json:"host"`
	// Port portion of the address
	Port int32 `json:"port"`
}

A IP address and port pair

type EndPointInfoAlternative ¶

type EndPointInfoAlternative struct {
	Alternative *interface{} `json:"alternative"`
}

Entry point information of the service in a format defined by an implementation, or in an external specification.

type EndPointInfoUris ¶

type EndPointInfoUris struct {
	Uris []string `json:"uris"`
}

Entry point information of the service as string, formatted according to URI syntax

type FilterParameters ¶

type FilterParameters struct {
	// contains filtered or unexported fields
}

type GrantType ¶

type GrantType string

GrantType : OAuth 2.0 grant type

const (
	AUTHORIZATION_CODE_GrantType GrantType = "OAUTH2_AUTHORIZATION_CODE"
	IMPLICIT_GRANT_GrantType     GrantType = "OAUTH2_IMPLICIT_GRANT"
	RESOURCE_OWNER_GrantType     GrantType = "OAUTH2_RESOURCE_OWNER"
	CLIENT_CREDENTIALS_GrantType GrantType = "OAUTH2_CLIENT_CREDENTIALS"
)

List of GrantType

type LinkType ¶

type LinkType struct {
	// URI referring to a resource
	Href string `json:"href,omitempty"`
}

This type represents a type of link and may be referenced from data structures

type LocalityType ¶

type LocalityType string

LocalityType : The scope of locality as expressed by \"consumedLocalOnly\" and \"isLocal\". If absent, defaults to MEC_HOST

const (
	MEC_SYSTEM_LocalityType LocalityType = "MEC_SYSTEM"
	MEC_HOST_LocalityType   LocalityType = "MEC_HOST"
	NFVI_POP_LocalityType   LocalityType = "NFVI_POP"
	ZONE_LocalityType       LocalityType = "ZONE"
	ZONE_GROUP_LocalityType LocalityType = "ZONE_GROUP"
	NFVI_NODE_LocalityType  LocalityType = "NFVI_NODE"
)

List of LocalityType

type OAuth2Info ¶

type OAuth2Info struct {
	// List of supported OAuth 2.0 grant types.
	GrantTypes []GrantType `json:"grantTypes"`
	// The token endpoint
	TokenEndpoint string `json:"tokenEndpoint"`
}

Parameters related to use of OAuth 2.0

type OneOfServiceInfoPost ¶

type OneOfServiceInfoPost struct {
}

type OneOfTransportInfoEndpoint ¶

type OneOfTransportInfoEndpoint struct {
	Addresses []EndPointInfoAddressesAddresses `json:"addresses,omitempty"`

	Host string `json:"host,omitempty"`
	Port int32  `json:"port,omitempty"`

	Alternative *interface{} `json:"alternative,omitempty"`

	Uris []string `json:"uris,omitempty"`
}

type ProblemDetails ¶

type ProblemDetails struct {
	// A URI reference according to IETF RFC 3986 that identifies the problem type
	Type_ string `json:"type,omitempty"`
	// A short, human-readable summary of the problem type
	Title string `json:"title,omitempty"`
	// The HTTP status code for this occurrence of the problem
	Status int32 `json:"status"`
	// A human-readable explanation specific to this occurrence of the problem
	Detail string `json:"detail"`
	// A URI reference that identifies the specific occurrence of the problem
	Instance string `json:"instance,omitempty"`
}

type SecurityInfo ¶

type SecurityInfo struct {
	OAuth2Info *OAuth2Info `json:"oAuth2Info,omitempty"`
}

This type represents security information related to a transport

type Self ¶

type Self struct {
	Self *LinkType `json:"self"`
}

Self-referring URI.

type SerAvailabilityNotificationSubscription ¶

type SerAvailabilityNotificationSubscription struct {
	// Shall be set to SerAvailabilityNotificationSubscription.
	SubscriptionType string `json:"subscriptionType"`
	// URI selected by the MEC application instance to receive notifications on the subscribed MEC service availability information. This shall be included in both the request and the response.
	CallbackReference string `json:"callbackReference"`

	Links *Self `json:"_links,omitempty"`

	FilteringCriteria *SerAvailabilityNotificationSubscriptionFilteringCriteria `json:"filteringCriteria,omitempty"`
}

This type represents a subscription to the notifications from the MEC platform regarding the availability of a MEC service or a list of MEC services.

type SerAvailabilityNotificationSubscriptionFilteringCriteria ¶

type SerAvailabilityNotificationSubscriptionFilteringCriteria struct {
	SerInstanceIds *[]string `json:"serInstanceIds,omitempty"`

	SerNames *[]string `json:"serNames,omitempty"`

	SerCategories *[]CategoryRef `json:"serCategories,omitempty"`

	States *[]ServiceState `json:"states,omitempty"`
	// Indicate whether the service is located in the same locality (as defined by scopeOfLocality) as the consuming MEC application.
	IsLocal bool `json:"isLocal,omitempty"`
}

Filtering criteria to match services for which events are requested to be reported. If absent, matches all services. All child attributes are combined with the logical \"AND\" operation.

type SerializerType ¶

type SerializerType string

SerializerType : The enumeration represents types of serializers

const (
	JSON_SerializerType      SerializerType = "JSON"
	XML_SerializerType       SerializerType = "XML"
	PROTOBUF3_SerializerType SerializerType = "PROTOBUF3"
)

List of SerializerType

type ServiceAvailabilityNotification ¶

type ServiceAvailabilityNotification struct {
	// Shall be set to SerAvailabilityNotification.
	NotificationType string `json:"notificationType"`

	ServiceReferences []ServiceAvailabilityNotificationServiceReferences `json:"serviceReferences"`

	Links *Subscription `json:"_links"`
}

This type represents the service availability information.

type ServiceAvailabilityNotificationChangeType ¶

type ServiceAvailabilityNotificationChangeType string

ServiceAvailabilityNotificationChangeType : Type of the change. Valid values: ADDED: The service was newly added. REMOVED: The service was removed. STATE_CHANGED: Only the state of the service was changed. ATTRIBUTES_CHANGED: At least one attribute of the service other than state was changed. The change may or may not include changing the state.

const (
	ADDED_ServiceAvailabilityNotificationChangeType              ServiceAvailabilityNotificationChangeType = "ADDED"
	REMOVED_ServiceAvailabilityNotificationChangeType            ServiceAvailabilityNotificationChangeType = "REMOVED"
	STATE_CHANGED_ServiceAvailabilityNotificationChangeType      ServiceAvailabilityNotificationChangeType = "STATE_CHANGED"
	ATTRIBUTES_CHANGED_ServiceAvailabilityNotificationChangeType ServiceAvailabilityNotificationChangeType = "ATTRIBUTES_CHANGED"
)

List of ServiceAvailabilityNotificationChangeType

type ServiceAvailabilityNotificationServiceReferences ¶

type ServiceAvailabilityNotificationServiceReferences struct {
	Link *LinkType `json:"link,omitempty"`

	SerName string `json:"serName"`

	SerInstanceId string `json:"serInstanceId"`

	State *ServiceState `json:"state"`

	ChangeType *ServiceAvailabilityNotificationChangeType `json:"changeType"`
}

List of links to services whose availability has changed.

type ServiceInfo ¶

type ServiceInfo struct {
	SerInstanceId string `json:"serInstanceId,omitempty"`

	SerName string `json:"serName"`

	SerCategory *CategoryRef `json:"serCategory,omitempty"`
	// Service version
	Version string `json:"version"`

	State *ServiceState `json:"state"`
	// Identifier of the platform-provided transport to be used by the service. Valid identifiers may be obtained using the \"Transport information query\" procedure. May be present in POST requests to signal the use of a platform-provided transport for the service, and shall be absent otherwise.
	TransportId string `json:"transportId,omitempty"`

	TransportInfo *TransportInfo `json:"transportInfo,omitempty"`

	Serializer *SerializerType `json:"serializer"`

	ScopeOfLocality *LocalityType `json:"scopeOfLocality,omitempty"`
	// Indicate whether the service can only be consumed by the MEC applications located in the same locality (as defined by scopeOfLocality) as this  service instance.
	// manually removed the omitempty
	ConsumedLocalOnly bool `json:"consumedLocalOnly"`
	// Indicate whether the service is located in the same locality (as defined by scopeOfLocality) as the consuming MEC application.
	// manually removed the omitempty
	IsLocal bool `json:"isLocal"`

	LivenessInterval int32 `json:"livenessInterval,omitempty"`

	Links *ServiceInfoLinks `json:"_links"`
}

This type represents the general information of a MEC service.

type ServiceInfoLinks ¶

type ServiceInfoLinks struct {
	Self *LinkType `json:"self"`

	Liveness *LinkType `json:"liveness,omitempty"`
}

type ServiceInfoList ¶

type ServiceInfoList struct {
	Services                 []ServiceInfo
	ConsumedLocalOnlyPresent bool
	IsLocalPresent           bool
	Filters                  *FilterParameters
}

type ServiceInfoPost ¶

type ServiceInfoPost struct {
	SerInstanceId string `json:"serInstanceId,omitempty"`

	SerName string `json:"serName"`

	SerCategory *CategoryRef `json:"serCategory,omitempty"`
	// Service version
	Version string `json:"version"`

	State *ServiceState `json:"state"`
	// Identifier of the platform-provided transport to be used by the service. Valid identifiers may be obtained using the \"Transport information query\" procedure. May be present in POST requests to signal the use of a platform-provided transport for the service, and shall be absent otherwise.
	TransportId string `json:"transportId,omitempty"`

	TransportInfo *TransportInfo `json:"transportInfo,omitempty"`

	Serializer *SerializerType `json:"serializer"`

	ScopeOfLocality *LocalityType `json:"scopeOfLocality,omitempty"`
	// Indicate whether the service can only be consumed by the MEC applications located in the same locality (as defined by scopeOfLocality) as this  service instance.
	// manually removed the omitempty
	ConsumedLocalOnly bool `json:"consumedLocalOnly"`
	// Indicate whether the service is located in the same locality (as defined by scopeOfLocality) as the consuming MEC application.
	// manually removed the omitempty
	IsLocal bool `json:"isLocal"`

	LivenessInterval int32 `json:"livenessInterval,omitempty"`

	Links *ServiceInfoLinks `json:"_links"`
}

This type represents the general information of a MEC service.

type ServiceLivenessInfo ¶

type ServiceLivenessInfo struct {
	State *ServiceState `json:"state"`

	TimeStamp *ServiceLivenessInfoTimeStamp `json:"timeStamp"`
	// The interval (in seconds) between two consecutive \"heartbeat\" messages (see clause 8.2.10.3.3) that MEC platform has determined.
	Interval int32 `json:"interval"`
}

type ServiceLivenessInfoTimeStamp ¶

type ServiceLivenessInfoTimeStamp struct {
	Seconds int32 `json:"seconds"`

	NanoSeconds int32 `json:"nanoSeconds"`
}

The time when the last \"heartbeat\" message was received by MEC platform

type ServiceLivenessUpdate ¶

type ServiceLivenessUpdate struct {
	State *ServiceState `json:"state"`
}

type ServiceState ¶

type ServiceState string

ServiceState : This enumeration defines the possible states of a service.

const (
	ACTIVE_ServiceState    ServiceState = "ACTIVE"
	INACTIVE_ServiceState  ServiceState = "INACTIVE"
	SUSPENDED_ServiceState ServiceState = "SUSPENDED"
)

List of ServiceState

type StateData ¶

type StateData struct {
	State ServiceState
	AppId string
}

type Subscription ¶

type Subscription struct {
	Subscription *LinkType `json:"subscription"`
}

A link to the related subscription

type SubscriptionLinkList ¶

type SubscriptionLinkList struct {
	Links *SubscriptionLinkListLinks `json:"_links"`
}

This type represents a list of links related to currently existing subscriptions for a MEC application instance. This information is returned when sending a request to receive current subscriptions.

type SubscriptionLinkListLinks ¶

type SubscriptionLinkListLinks struct {
	Self *LinkType `json:"self"`
	// The MEC application instance's subscriptions
	Subscriptions []SubscriptionLinkListLinksSubscriptions `json:"subscriptions,omitempty"`
}

Self-referring URI.

type SubscriptionLinkListLinksSubscriptions ¶

type SubscriptionLinkListLinksSubscriptions struct {
	// URI referring to a resource
	Href string `json:"href"`
	// Type of the subscription. The values are as defined in the \"subscriptionType\" attribute for each different Mp1 event subscription data type.
	SubscriptionType string `json:"subscriptionType"`
}

A link to a subscription.

type TransportInfo ¶

type TransportInfo struct {
	// The identifier of this transport
	Id string `json:"id"`
	// The name of this transport
	Name string `json:"name"`
	// Human-readable description of this transport
	Description string `json:"description,omitempty"`

	Type_ *TransportType `json:"type"`
	// The name of the protocol used. Shall be set to HTTP for a REST API.
	Protocol string `json:"protocol"`
	// The version of the protocol used
	Version string `json:"version"`
	// This type represents information about a transport endpoint
	Endpoint *OneOfTransportInfoEndpoint `json:"endpoint"`

	Security *SecurityInfo `json:"security"`
	// Additional implementation specific details of the transport
	ImplSpecificInfo *interface{} `json:"implSpecificInfo,omitempty"`
}

This type represents the general information of a MEC service.

type TransportType ¶

type TransportType string

TransportType : The enumeration TransportType represents types of transports

const (
	REST_HTTP_TransportType      TransportType = "REST_HTTP"
	MB_TOPIC_BASED_TransportType TransportType = "MB_TOPIC_BASED"
	MB_ROUTING_TransportType     TransportType = "MB_ROUTING"
	MB_PUBSUB_TransportType      TransportType = "MB_PUBSUB"
	RPC_TransportType            TransportType = "RPC"
	RPC_STREAMING_TransportType  TransportType = "RPC_STREAMING"
	WEBSOCKET_TransportType      TransportType = "WEBSOCKET"
)

List of TransportType

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

README ¶

Go API Server for server

Overview

This server was generated by the [swagger-codegen] (https://github.com/swagger-api/swagger-codegen) project. By using the OpenAPI-Spec from a remote server, you can easily generate a server stub.

Running the server

Documentation ¶

Overview ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func AppServicesGET ¶

func AppServicesPOST ¶

func AppServicesServiceIdDELETE ¶

func AppServicesServiceIdGET ¶

func AppServicesServiceIdPUT ¶

func ApplicationsSubscriptionDELETE ¶

func ApplicationsSubscriptionGET ¶

func ApplicationsSubscriptionsGET ¶

func ApplicationsSubscriptionsPOST ¶

func DeleteServiceSubscriptions ¶

func DeleteServices ¶

func Init ¶

func Run ¶

func ServicesGET ¶

func ServicesServiceIdGET ¶

func Stop ¶

func TransportsGET ¶

Types ¶

type CategoryRef ¶

type EndPointInfoAddresses ¶

type EndPointInfoAddressesAddresses ¶

type EndPointInfoAlternative ¶

type EndPointInfoUris ¶

type FilterParameters ¶

type GrantType ¶

type LinkType ¶

type LocalityType ¶

type OAuth2Info ¶

type OneOfServiceInfoPost ¶

type OneOfTransportInfoEndpoint ¶

type ProblemDetails ¶

type SecurityInfo ¶

type Self ¶

type SerAvailabilityNotificationSubscription ¶

type SerAvailabilityNotificationSubscriptionFilteringCriteria ¶

type SerializerType ¶

type ServiceAvailabilityNotification ¶

type ServiceAvailabilityNotificationChangeType ¶

type ServiceAvailabilityNotificationServiceReferences ¶

type ServiceInfo ¶

type ServiceInfoLinks ¶

type ServiceInfoList ¶

type ServiceInfoPost ¶

type ServiceLivenessInfo ¶

type ServiceLivenessInfoTimeStamp ¶

type ServiceLivenessUpdate ¶

type ServiceState ¶

type StateData ¶

type Subscription ¶

type SubscriptionLinkList ¶

type SubscriptionLinkListLinks ¶

type SubscriptionLinkListLinksSubscriptions ¶

type TransportInfo ¶

type TransportType ¶

Source Files ¶

This server was generated by the [swagger-codegen] (https://github.com/swagger-api/swagger-codegen) project.
By using the OpenAPI-Spec from a remote server, you can easily generate a server stub.