2 // Copyright 2019 AT&T Intellectual Property
3 // Copyright 2019 Nokia
5 // Licensed under the Apache License, Version 2.0 (the "License");
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
9 // http://www.apache.org/licenses/LICENSE-2.0
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
17 package httpmsghandlers
20 "e2mgr/e2managererrors"
25 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
26 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
27 "github.com/go-ozzo/ozzo-validation"
28 "github.com/go-ozzo/ozzo-validation/is"
32 X2SetupActivityName = "X2_SETUP"
33 EndcSetupActivityName = "ENDC_SETUP"
36 type SetupRequestHandler struct {
37 rNibDataService services.RNibDataService
39 ranSetupManager managers.IRanSetupManager
40 protocol entities.E2ApplicationProtocol
41 e2tInstancesManager managers.IE2TInstancesManager
44 func NewSetupRequestHandler(logger *logger.Logger, rNibDataService services.RNibDataService,
45 ranSetupManager managers.IRanSetupManager, protocol entities.E2ApplicationProtocol, e2tInstancesManager managers.IE2TInstancesManager) *SetupRequestHandler {
46 return &SetupRequestHandler{
48 rNibDataService: rNibDataService,
49 ranSetupManager: ranSetupManager,
51 e2tInstancesManager: e2tInstancesManager,
55 func (h *SetupRequestHandler) Handle(request models.Request) (models.IResponse, error) {
57 setupRequest := request.(models.SetupRequest)
59 err := h.validateRequestDetails(setupRequest)
64 nodebInfo, err := h.rNibDataService.GetNodeb(setupRequest.RanName)
67 _, ok := err.(*common.ResourceNotFoundError)
69 h.logger.Errorf("#SetupRequestHandler.Handle - failed to get nodeB entity for ran name: %v from RNIB. Error: %s", setupRequest.RanName, err)
70 return nil, e2managererrors.NewRnibDbError()
73 result := h.connectNewRan(&setupRequest, h.protocol)
77 if nodebInfo.ConnectionStatus == entities.ConnectionStatus_SHUTTING_DOWN {
78 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithAssociatedE2TAddress - RAN: %s in wrong state (%s)", nodebInfo.RanName, entities.ConnectionStatus_name[int32(nodebInfo.ConnectionStatus)])
79 result := e2managererrors.NewWrongStateError(h.getActivityName(h.protocol), entities.ConnectionStatus_name[int32(nodebInfo.ConnectionStatus)])
83 if len(nodebInfo.AssociatedE2TInstanceAddress) != 0 {
84 result := h.connectExistingRanWithAssociatedE2TAddress(nodebInfo)
88 result := h.connectExistingRanWithoutAssociatedE2TAddress(nodebInfo)
92 func createInitialNodeInfo(requestDetails *models.SetupRequest, protocol entities.E2ApplicationProtocol, e2tAddress string) (*entities.NodebInfo, *entities.NbIdentity) {
94 nodebInfo := &entities.NodebInfo{
95 Ip: requestDetails.RanIp,
96 Port: uint32(requestDetails.RanPort),
97 ConnectionStatus: entities.ConnectionStatus_CONNECTING,
98 E2ApplicationProtocol: protocol,
99 RanName: requestDetails.RanName,
100 ConnectionAttempts: 0,
101 AssociatedE2TInstanceAddress: e2tAddress,
104 nbIdentity := &entities.NbIdentity{
105 InventoryName: requestDetails.RanName,
108 return nodebInfo, nbIdentity
111 func (h *SetupRequestHandler) connectExistingRanWithoutAssociatedE2TAddress(nodebInfo *entities.NodebInfo) error {
112 e2tAddress, err := h.e2tInstancesManager.SelectE2TInstance()
115 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - failed selecting E2T instance", nodebInfo.RanName)
117 // TODO: reset connection attempts?
119 if nodebInfo.ConnectionStatus == entities.ConnectionStatus_DISCONNECTED {
123 nodebInfo.ConnectionStatus = entities.ConnectionStatus_DISCONNECTED
124 updateError := h.rNibDataService.UpdateNodebInfo(nodebInfo)
126 if updateError != nil {
127 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - failed updating nodeb. error: %s", nodebInfo.RanName, updateError)
133 err = h.e2tInstancesManager.AssociateRan(nodebInfo.RanName, e2tAddress)
136 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - failed associating ran to e2t address %s. error: %s", nodebInfo.RanName, e2tAddress, err)
140 nodebInfo.AssociatedE2TInstanceAddress = e2tAddress
141 nodebInfo.ConnectionAttempts = 0
143 err = h.rNibDataService.UpdateNodebInfo(nodebInfo)
146 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - failed updating nodeb in rNib. error: %s", nodebInfo.RanName, err)
147 return e2managererrors.NewRnibDbError()
150 h.logger.Infof("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - successfully updated nodeb in rNib", nodebInfo.RanName)
152 result := h.ranSetupManager.ExecuteSetup(nodebInfo, entities.ConnectionStatus_CONNECTING)
156 func (h *SetupRequestHandler) connectExistingRanWithAssociatedE2TAddress(nodebInfo *entities.NodebInfo) error {
157 status := entities.ConnectionStatus_CONNECTING
158 if nodebInfo.ConnectionStatus == entities.ConnectionStatus_CONNECTED {
159 status = nodebInfo.ConnectionStatus
161 nodebInfo.ConnectionAttempts = 0
162 err := h.rNibDataService.UpdateNodebInfo(nodebInfo)
165 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithAssociatedE2TAddress - RAN name: %s - failed updating nodeb in rNib. error: %s", nodebInfo.RanName, err)
166 return e2managererrors.NewRnibDbError()
169 h.logger.Infof("#SetupRequestHandler.connectExistingRanWithAssociatedE2TAddress - RAN name: %s - successfully updated nodeb in rNib", nodebInfo.RanName)
172 result := h.ranSetupManager.ExecuteSetup(nodebInfo, status)
176 func (h *SetupRequestHandler) connectNewRan(request *models.SetupRequest, protocol entities.E2ApplicationProtocol) error {
178 e2tAddress, err := h.e2tInstancesManager.SelectE2TInstance()
181 h.logger.Errorf("#SetupRequestHandler.connectNewRan - RAN name: %s - failed selecting E2T instance", request.RanName)
185 err = h.e2tInstancesManager.AssociateRan(request.RanName, e2tAddress)
188 h.logger.Errorf("#SetupRequestHandler.connectNewRan - RAN name: %s - failed associating ran to e2t address %s. error: %s", request.RanName, e2tAddress, err)
192 nodebInfo, nodebIdentity := createInitialNodeInfo(request, protocol, e2tAddress)
194 err = h.rNibDataService.SaveNodeb(nodebIdentity, nodebInfo)
197 h.logger.Errorf("#SetupRequestHandler.connectNewRan - RAN name: %s - failed to save initial nodeb entity in RNIB. error: %s", request.RanName, err)
198 return e2managererrors.NewRnibDbError()
201 h.logger.Infof("#SetupRequestHandler.connectNewRan - RAN name: %s - initial nodeb entity was saved to rNib", request.RanName)
203 result := h.ranSetupManager.ExecuteSetup(nodebInfo, entities.ConnectionStatus_CONNECTING)
208 func (handler *SetupRequestHandler) validateRequestDetails(request models.SetupRequest) error {
210 if request.RanPort == 0 {
211 handler.logger.Errorf("#SetupRequestHandler.validateRequestDetails - validation failure: port cannot be zero")
212 return e2managererrors.NewRequestValidationError()
214 err := validation.ValidateStruct(&request,
215 validation.Field(&request.RanIp, validation.Required, is.IP),
216 validation.Field(&request.RanName, validation.Required),
220 handler.logger.Errorf("#SetupRequestHandler.validateRequestDetails - validation failure, error: %v", err)
221 return e2managererrors.NewRequestValidationError()
227 func (handler *SetupRequestHandler) getActivityName(protocol entities.E2ApplicationProtocol) string {
228 if protocol == entities.E2ApplicationProtocol_X2_SETUP_REQUEST {
229 return X2SetupActivityName
231 return EndcSetupActivityName