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 e2tAssociationManager *managers.E2TAssociationManager
45 e2tInstancesManager managers.IE2TInstancesManager
48 func NewSetupRequestHandler(logger *logger.Logger, rNibDataService services.RNibDataService,
49 ranSetupManager managers.IRanSetupManager, protocol entities.E2ApplicationProtocol, e2tInstancesManager managers.IE2TInstancesManager, e2tAssociationManager *managers.E2TAssociationManager) *SetupRequestHandler {
50 return &SetupRequestHandler{
52 rNibDataService: rNibDataService,
53 ranSetupManager: ranSetupManager,
55 e2tAssociationManager: e2tAssociationManager,
56 e2tInstancesManager: e2tInstancesManager,
60 func (h *SetupRequestHandler) Handle(request models.Request) (models.IResponse, error) {
62 setupRequest := request.(models.SetupRequest)
64 err := h.validateRequestDetails(setupRequest)
69 nodebInfo, err := h.rNibDataService.GetNodeb(setupRequest.RanName)
72 _, ok := err.(*common.ResourceNotFoundError)
74 h.logger.Errorf("#SetupRequestHandler.Handle - failed to get nodeB entity for ran name: %v from RNIB. Error: %s", setupRequest.RanName, err)
75 return nil, e2managererrors.NewRnibDbError()
78 result := h.connectNewRan(&setupRequest, h.protocol)
82 if nodebInfo.ConnectionStatus == entities.ConnectionStatus_SHUTTING_DOWN {
83 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithAssociatedE2TAddress - RAN: %s in wrong state (%s)", nodebInfo.RanName, entities.ConnectionStatus_name[int32(nodebInfo.ConnectionStatus)])
84 result := e2managererrors.NewWrongStateError(h.getActivityName(h.protocol), entities.ConnectionStatus_name[int32(nodebInfo.ConnectionStatus)])
88 if len(nodebInfo.AssociatedE2TInstanceAddress) != 0 {
89 result := h.connectExistingRanWithAssociatedE2TAddress(nodebInfo)
93 result := h.connectExistingRanWithoutAssociatedE2TAddress(nodebInfo)
97 func createInitialNodeInfo(requestDetails *models.SetupRequest, protocol entities.E2ApplicationProtocol) (*entities.NodebInfo, *entities.NbIdentity) {
99 nodebInfo := &entities.NodebInfo{
100 Ip: requestDetails.RanIp,
101 Port: uint32(requestDetails.RanPort),
102 ConnectionStatus: entities.ConnectionStatus_CONNECTING,
103 E2ApplicationProtocol: protocol,
104 RanName: requestDetails.RanName,
105 ConnectionAttempts: 0,
108 nbIdentity := &entities.NbIdentity{
109 InventoryName: requestDetails.RanName,
112 return nodebInfo, nbIdentity
115 func (h *SetupRequestHandler) connectExistingRanWithoutAssociatedE2TAddress(nodebInfo *entities.NodebInfo) error {
116 e2tAddress, err := h.e2tInstancesManager.SelectE2TInstance()
119 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - failed selecting E2T instance", nodebInfo.RanName)
121 if nodebInfo.ConnectionStatus == entities.ConnectionStatus_DISCONNECTED && nodebInfo.ConnectionAttempts == 0 {
125 nodebInfo.ConnectionStatus = entities.ConnectionStatus_DISCONNECTED
126 nodebInfo.ConnectionAttempts = 0
127 updateError := h.rNibDataService.UpdateNodebInfo(nodebInfo)
129 if updateError != nil {
130 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - failed updating nodeb. error: %s", nodebInfo.RanName, updateError)
136 err = h.e2tAssociationManager.AssociateRan(e2tAddress, nodebInfo)
139 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - failed associating ran to e2t address %s. error: %s", nodebInfo.RanName, e2tAddress, err)
143 h.logger.Infof("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - successfully updated nodeb in rNib", nodebInfo.RanName)
145 result := h.ranSetupManager.ExecuteSetup(nodebInfo, entities.ConnectionStatus_CONNECTING)
149 func (h *SetupRequestHandler) connectExistingRanWithAssociatedE2TAddress(nodebInfo *entities.NodebInfo) error {
150 status := entities.ConnectionStatus_CONNECTING
151 if nodebInfo.ConnectionStatus == entities.ConnectionStatus_CONNECTED {
152 status = nodebInfo.ConnectionStatus
154 nodebInfo.ConnectionAttempts = 0
155 err := h.rNibDataService.UpdateNodebInfo(nodebInfo)
158 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithAssociatedE2TAddress - RAN name: %s - failed resetting connection attempts of RAN. error: %s", nodebInfo.RanName, err)
159 return e2managererrors.NewRnibDbError()
162 h.logger.Infof("#SetupRequestHandler.connectExistingRanWithAssociatedE2TAddress - RAN name: %s - successfully reset connection attempts of RAN", nodebInfo.RanName)
164 result := h.ranSetupManager.ExecuteSetup(nodebInfo, status)
168 func (h *SetupRequestHandler) connectNewRan(request *models.SetupRequest, protocol entities.E2ApplicationProtocol) error {
170 e2tAddress, err := h.e2tInstancesManager.SelectE2TInstance()
173 h.logger.Errorf("#SetupRequestHandler.connectNewRan - RAN name: %s - failed selecting E2T instance", request.RanName)
177 nodebInfo, nodebIdentity := createInitialNodeInfo(request, protocol)
179 err = h.rNibDataService.SaveNodeb(nodebIdentity, nodebInfo)
182 h.logger.Errorf("#SetupRequestHandler.connectNewRan - RAN name: %s - failed to save initial nodeb entity in RNIB. error: %s", request.RanName, err)
183 return e2managererrors.NewRnibDbError()
186 h.logger.Infof("#SetupRequestHandler.connectNewRan - RAN name: %s - initial nodeb entity was saved to rNib", request.RanName)
188 err = h.e2tAssociationManager.AssociateRan(e2tAddress, nodebInfo)
191 h.logger.Errorf("#SetupRequestHandler.connectNewRan - RAN name: %s - failed associating ran to e2t address %s. error: %s", request.RanName, e2tAddress, err)
195 result := h.ranSetupManager.ExecuteSetup(nodebInfo, entities.ConnectionStatus_CONNECTING)
200 func (handler *SetupRequestHandler) validateRequestDetails(request models.SetupRequest) error {
202 if request.RanPort == 0 {
203 handler.logger.Errorf("#SetupRequestHandler.validateRequestDetails - validation failure: port cannot be zero")
204 return e2managererrors.NewRequestValidationError()
206 err := validation.ValidateStruct(&request,
207 validation.Field(&request.RanIp, validation.Required, is.IP),
208 validation.Field(&request.RanName, validation.Required),
212 handler.logger.Errorf("#SetupRequestHandler.validateRequestDetails - validation failure, error: %v", err)
213 return e2managererrors.NewRequestValidationError()
219 func (handler *SetupRequestHandler) getActivityName(protocol entities.E2ApplicationProtocol) string {
220 if protocol == entities.E2ApplicationProtocol_X2_SETUP_REQUEST {
221 return X2SetupActivityName
223 return EndcSetupActivityName