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 // This source code is part of the near-RT RIC (RAN Intelligent Controller)
18 // platform project (RICP).
20 package httpmsghandlers
23 "e2mgr/e2managererrors"
28 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
29 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
30 "github.com/go-ozzo/ozzo-validation"
31 "github.com/go-ozzo/ozzo-validation/is"
35 X2SetupActivityName = "X2_SETUP"
36 EndcSetupActivityName = "ENDC_SETUP"
39 type SetupRequestHandler struct {
40 rNibDataService services.RNibDataService
42 ranSetupManager managers.IRanSetupManager
43 protocol entities.E2ApplicationProtocol
44 e2tInstancesManager managers.IE2TInstancesManager
47 func NewSetupRequestHandler(logger *logger.Logger, rNibDataService services.RNibDataService,
48 ranSetupManager managers.IRanSetupManager, protocol entities.E2ApplicationProtocol, e2tInstancesManager managers.IE2TInstancesManager) *SetupRequestHandler {
49 return &SetupRequestHandler{
51 rNibDataService: rNibDataService,
52 ranSetupManager: ranSetupManager,
54 e2tInstancesManager: e2tInstancesManager,
58 func (h *SetupRequestHandler) Handle(request models.Request) (models.IResponse, error) {
60 setupRequest := request.(models.SetupRequest)
62 err := h.validateRequestDetails(setupRequest)
67 nodebInfo, err := h.rNibDataService.GetNodeb(setupRequest.RanName)
70 _, ok := err.(*common.ResourceNotFoundError)
72 h.logger.Errorf("#SetupRequestHandler.Handle - failed to get nodeB entity for ran name: %v from RNIB. Error: %s", setupRequest.RanName, err)
73 return nil, e2managererrors.NewRnibDbError()
76 result := h.connectNewRan(&setupRequest, h.protocol)
80 if nodebInfo.ConnectionStatus == entities.ConnectionStatus_SHUTTING_DOWN {
81 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithAssociatedE2TAddress - RAN: %s in wrong state (%s)", nodebInfo.RanName, entities.ConnectionStatus_name[int32(nodebInfo.ConnectionStatus)])
82 result := e2managererrors.NewWrongStateError(h.getActivityName(h.protocol), entities.ConnectionStatus_name[int32(nodebInfo.ConnectionStatus)])
86 if len(nodebInfo.AssociatedE2TInstanceAddress) != 0 {
87 result := h.connectExistingRanWithAssociatedE2TAddress(nodebInfo)
91 result := h.connectExistingRanWithoutAssociatedE2TAddress(nodebInfo)
95 func createInitialNodeInfo(requestDetails *models.SetupRequest, protocol entities.E2ApplicationProtocol, e2tAddress string) (*entities.NodebInfo, *entities.NbIdentity) {
97 nodebInfo := &entities.NodebInfo{
98 Ip: requestDetails.RanIp,
99 Port: uint32(requestDetails.RanPort),
100 ConnectionStatus: entities.ConnectionStatus_CONNECTING,
101 E2ApplicationProtocol: protocol,
102 RanName: requestDetails.RanName,
103 ConnectionAttempts: 0,
104 AssociatedE2TInstanceAddress: e2tAddress,
107 nbIdentity := &entities.NbIdentity{
108 InventoryName: requestDetails.RanName,
111 return nodebInfo, nbIdentity
114 func (h *SetupRequestHandler) connectExistingRanWithoutAssociatedE2TAddress(nodebInfo *entities.NodebInfo) error {
115 e2tAddress, err := h.e2tInstancesManager.SelectE2TInstance()
118 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - failed selecting E2T instance", nodebInfo.RanName)
120 if nodebInfo.ConnectionStatus == entities.ConnectionStatus_DISCONNECTED && nodebInfo.ConnectionAttempts == 0 {
124 nodebInfo.ConnectionStatus = entities.ConnectionStatus_DISCONNECTED
125 nodebInfo.ConnectionAttempts = 0
126 updateError := h.rNibDataService.UpdateNodebInfo(nodebInfo)
128 if updateError != nil {
129 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - failed updating nodeb. error: %s", nodebInfo.RanName, updateError)
135 err = h.e2tInstancesManager.AssociateRan(nodebInfo.RanName, e2tAddress)
138 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - failed associating ran to e2t address %s. error: %s", nodebInfo.RanName, e2tAddress, err)
142 nodebInfo.AssociatedE2TInstanceAddress = e2tAddress
143 nodebInfo.ConnectionAttempts = 0
145 err = h.rNibDataService.UpdateNodebInfo(nodebInfo)
148 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - failed updating nodeb in rNib. error: %s", nodebInfo.RanName, err)
149 return e2managererrors.NewRnibDbError()
152 h.logger.Infof("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - successfully updated nodeb in rNib", nodebInfo.RanName)
154 result := h.ranSetupManager.ExecuteSetup(nodebInfo, entities.ConnectionStatus_CONNECTING)
158 func (h *SetupRequestHandler) connectExistingRanWithAssociatedE2TAddress(nodebInfo *entities.NodebInfo) error {
159 status := entities.ConnectionStatus_CONNECTING
160 if nodebInfo.ConnectionStatus == entities.ConnectionStatus_CONNECTED {
161 status = nodebInfo.ConnectionStatus
163 nodebInfo.ConnectionAttempts = 0
164 err := h.rNibDataService.UpdateNodebInfo(nodebInfo)
167 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithAssociatedE2TAddress - RAN name: %s - failed resetting connection attempts of RAN. error: %s", nodebInfo.RanName, err)
168 return e2managererrors.NewRnibDbError()
171 h.logger.Infof("#SetupRequestHandler.connectExistingRanWithAssociatedE2TAddress - RAN name: %s - successfully reset connection attempts of RAN", nodebInfo.RanName)
174 result := h.ranSetupManager.ExecuteSetup(nodebInfo, status)
178 func (h *SetupRequestHandler) connectNewRan(request *models.SetupRequest, protocol entities.E2ApplicationProtocol) error {
180 e2tAddress, err := h.e2tInstancesManager.SelectE2TInstance()
183 h.logger.Errorf("#SetupRequestHandler.connectNewRan - RAN name: %s - failed selecting E2T instance", request.RanName)
187 err = h.e2tInstancesManager.AssociateRan(request.RanName, e2tAddress)
190 h.logger.Errorf("#SetupRequestHandler.connectNewRan - RAN name: %s - failed associating ran to e2t address %s. error: %s", request.RanName, e2tAddress, err)
194 nodebInfo, nodebIdentity := createInitialNodeInfo(request, protocol, e2tAddress)
196 err = h.rNibDataService.SaveNodeb(nodebIdentity, nodebInfo)
199 h.logger.Errorf("#SetupRequestHandler.connectNewRan - RAN name: %s - failed to save initial nodeb entity in RNIB. error: %s", request.RanName, err)
200 return e2managererrors.NewRnibDbError()
203 h.logger.Infof("#SetupRequestHandler.connectNewRan - RAN name: %s - initial nodeb entity was saved to rNib", request.RanName)
205 result := h.ranSetupManager.ExecuteSetup(nodebInfo, entities.ConnectionStatus_CONNECTING)
210 func (handler *SetupRequestHandler) validateRequestDetails(request models.SetupRequest) error {
212 if request.RanPort == 0 {
213 handler.logger.Errorf("#SetupRequestHandler.validateRequestDetails - validation failure: port cannot be zero")
214 return e2managererrors.NewRequestValidationError()
216 err := validation.ValidateStruct(&request,
217 validation.Field(&request.RanIp, validation.Required, is.IP),
218 validation.Field(&request.RanName, validation.Required),
222 handler.logger.Errorf("#SetupRequestHandler.validateRequestDetails - validation failure, error: %v", err)
223 return e2managererrors.NewRequestValidationError()
229 func (handler *SetupRequestHandler) getActivityName(protocol entities.E2ApplicationProtocol) string {
230 if protocol == entities.E2ApplicationProtocol_X2_SETUP_REQUEST {
231 return X2SetupActivityName
233 return EndcSetupActivityName