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).
23 "e2mgr/e2managererrors"
26 "e2mgr/providers/httpmsghandlerprovider"
28 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
29 "github.com/golang/protobuf/jsonpb"
30 "github.com/golang/protobuf/proto"
31 "github.com/gorilla/mux"
40 ParamRanName = "ranName"
43 const ApplicationJson = "application/json"
44 const ContentType = "Content-Type"
46 type INodebController interface {
47 Shutdown(writer http.ResponseWriter, r *http.Request)
48 X2Reset(writer http.ResponseWriter, r *http.Request)
49 X2Setup(writer http.ResponseWriter, r *http.Request)
50 EndcSetup(writer http.ResponseWriter, r *http.Request)
51 GetNodeb(writer http.ResponseWriter, r *http.Request)
52 UpdateGnb(writer http.ResponseWriter, r *http.Request)
53 GetNodebIdList(writer http.ResponseWriter, r *http.Request)
54 SetGeneralConfiguration(writer http.ResponseWriter, r *http.Request)
57 type NodebController struct {
59 handlerProvider *httpmsghandlerprovider.IncomingRequestHandlerProvider
62 func NewNodebController(logger *logger.Logger, handlerProvider *httpmsghandlerprovider.IncomingRequestHandlerProvider) *NodebController {
63 return &NodebController{
65 handlerProvider: handlerProvider,
69 func (c *NodebController) GetNodebIdList(writer http.ResponseWriter, r *http.Request) {
70 c.logger.Infof("[Client -> E2 Manager] #NodebController.GetNodebIdList - request: %v", c.prettifyRequest(r))
72 c.handleRequest(writer, &r.Header, httpmsghandlerprovider.GetNodebIdListRequest, nil, false)
75 func (c *NodebController) GetNodeb(writer http.ResponseWriter, r *http.Request) {
76 c.logger.Infof("[Client -> E2 Manager] #NodebController.GetNodeb - request: %v", c.prettifyRequest(r))
78 ranName := vars["ranName"]
79 request := models.GetNodebRequest{RanName: ranName}
80 c.handleRequest(writer, &r.Header, httpmsghandlerprovider.GetNodebRequest, request, false)
83 func (c *NodebController) UpdateGnb(writer http.ResponseWriter, r *http.Request) {
84 c.logger.Infof("[Client -> E2 Manager] #NodebController.UpdateGnb - request: %v", c.prettifyRequest(r))
86 ranName := vars[ParamRanName]
88 request := models.UpdateGnbRequest{}
92 if !c.extractRequestBodyToProto(r, &gnb, writer) {
97 request.RanName = ranName
98 c.handleRequest(writer, &r.Header, httpmsghandlerprovider.UpdateGnbRequest, request, true)
101 func (c *NodebController) SetGeneralConfiguration(writer http.ResponseWriter, r *http.Request) {
102 c.logger.Infof("[Client -> E2 Manager] #NodebController.SetGeneralConfiguration - request: %v", c.prettifyRequest(r))
104 request := models.GeneralConfigurationRequest{}
106 if !c.extractJsonBody(r, &request, writer){
109 c.handleRequest(writer, &r.Header, httpmsghandlerprovider.SetGeneralConfigurationRequest, request, false)
112 func (c *NodebController) Shutdown(writer http.ResponseWriter, r *http.Request) {
113 c.logger.Infof("[Client -> E2 Manager] #NodebController.Shutdown - request: %v", c.prettifyRequest(r))
114 c.handleRequest(writer, &r.Header, httpmsghandlerprovider.ShutdownRequest, nil, false)
117 func (c *NodebController) X2Reset(writer http.ResponseWriter, r *http.Request) {
118 c.logger.Infof("[Client -> E2 Manager] #NodebController.X2Reset - request: %v", c.prettifyRequest(r))
119 request := models.ResetRequest{}
121 ranName := vars[ParamRanName]
123 if r.ContentLength > 0 && !c.extractJsonBody(r, &request, writer) {
126 request.RanName = ranName
127 c.handleRequest(writer, &r.Header, httpmsghandlerprovider.ResetRequest, request, false)
130 func (c *NodebController) X2Setup(writer http.ResponseWriter, r *http.Request) {
131 c.logger.Infof("[Client -> E2 Manager] #NodebController.X2Setup - request: %v", c.prettifyRequest(r))
133 request := models.SetupRequest{}
135 if !c.extractJsonBody(r, &request, writer) {
139 c.handleRequest(writer, &r.Header, httpmsghandlerprovider.X2SetupRequest, request, true)
142 func (c *NodebController) EndcSetup(writer http.ResponseWriter, r *http.Request) {
143 c.logger.Infof("[Client -> E2 Manager] #NodebController.EndcSetup - request: %v", c.prettifyRequest(r))
145 request := models.SetupRequest{}
147 if !c.extractJsonBody(r, &request, writer) {
151 c.handleRequest(writer, &r.Header, httpmsghandlerprovider.EndcSetupRequest, request, true)
154 func (c *NodebController) extractRequestBodyToProto(r *http.Request, pb proto.Message , writer http.ResponseWriter) bool {
157 err := jsonpb.Unmarshal(r.Body, pb)
160 c.logger.Errorf("[Client -> E2 Manager] #NodebController.extractJsonBody - unable to extract json body - error: %s", err)
161 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
168 func (c *NodebController) extractJsonBody(r *http.Request, request models.Request, writer http.ResponseWriter) bool {
170 body, err := ioutil.ReadAll(io.LimitReader(r.Body, LimitRequest))
173 c.logger.Errorf("[Client -> E2 Manager] #NodebController.extractJsonBody - unable to extract json body - error: %s", err)
174 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
178 err = json.Unmarshal(body, &request)
180 c.logger.Errorf("[Client -> E2 Manager] #NodebController.extractJsonBody - unable to extract json body - error: %s", err)
181 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
188 func (c *NodebController) handleRequest(writer http.ResponseWriter, header *http.Header, requestName httpmsghandlerprovider.IncomingRequest, request models.Request, validateRequestHeaders bool) {
190 if validateRequestHeaders {
192 err := c.validateRequestHeader(header)
194 c.handleErrorResponse(err, writer)
199 handler, err := c.handlerProvider.GetHandler(requestName)
202 c.handleErrorResponse(err, writer)
206 response, err := handler.Handle(request)
209 c.handleErrorResponse(err, writer)
214 writer.WriteHeader(http.StatusNoContent)
215 c.logger.Infof("[E2 Manager -> Client] #NodebController.handleRequest - status response: %v", http.StatusNoContent)
219 result, err := response.Marshal()
222 c.handleErrorResponse(err, writer)
226 c.logger.Infof("[E2 Manager -> Client] #NodebController.handleRequest - response: %s", result)
227 writer.Header().Set(ContentType, ApplicationJson)
231 func (c *NodebController) validateRequestHeader(header *http.Header) error {
233 if header.Get(ContentType) != ApplicationJson {
234 c.logger.Errorf("#NodebController.validateRequestHeader - validation failure, incorrect content type")
236 return e2managererrors.NewHeaderValidationError()
241 func (c *NodebController) handleErrorResponse(err error, writer http.ResponseWriter) {
243 var errorResponseDetails models.ErrorResponse
248 case *e2managererrors.RnibDbError:
249 e2Error, _ := err.(*e2managererrors.RnibDbError)
250 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
251 httpError = http.StatusInternalServerError
252 case *e2managererrors.CommandAlreadyInProgressError:
253 e2Error, _ := err.(*e2managererrors.CommandAlreadyInProgressError)
254 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
255 httpError = http.StatusMethodNotAllowed
256 case *e2managererrors.HeaderValidationError:
257 e2Error, _ := err.(*e2managererrors.HeaderValidationError)
258 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
259 httpError = http.StatusUnsupportedMediaType
260 case *e2managererrors.WrongStateError:
261 e2Error, _ := err.(*e2managererrors.WrongStateError)
262 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
263 httpError = http.StatusBadRequest
264 case *e2managererrors.RequestValidationError:
265 e2Error, _ := err.(*e2managererrors.RequestValidationError)
266 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
267 httpError = http.StatusBadRequest
268 case *e2managererrors.InvalidJsonError:
269 e2Error, _ := err.(*e2managererrors.InvalidJsonError)
270 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
271 httpError = http.StatusBadRequest
272 case *e2managererrors.RmrError:
273 e2Error, _ := err.(*e2managererrors.RmrError)
274 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
275 httpError = http.StatusInternalServerError
276 case *e2managererrors.ResourceNotFoundError:
277 e2Error, _ := err.(*e2managererrors.ResourceNotFoundError)
278 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
279 httpError = http.StatusNotFound
280 case *e2managererrors.E2TInstanceAbsenceError:
281 e2Error, _ := err.(*e2managererrors.E2TInstanceAbsenceError)
282 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
283 httpError = http.StatusServiceUnavailable
284 case *e2managererrors.RoutingManagerError:
285 e2Error, _ := err.(*e2managererrors.RoutingManagerError)
286 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
287 httpError = http.StatusServiceUnavailable
289 e2Error := e2managererrors.NewInternalError()
290 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
291 httpError = http.StatusInternalServerError
294 errorResponse, _ := json.Marshal(errorResponseDetails)
296 c.logger.Errorf("[E2 Manager -> Client] #NodebController.handleErrorResponse - http status: %d, error response: %+v", httpError, errorResponseDetails)
298 writer.Header().Set(ContentType, ApplicationJson)
299 writer.WriteHeader(httpError)
300 _, err = writer.Write(errorResponse)
303 func (c *NodebController) prettifyRequest(request *http.Request) string {
304 dump, _ := httputil.DumpRequest(request, true)
305 requestPrettyPrint := strings.Replace(string(dump), "\r\n", " ", -1)
306 return strings.Replace(requestPrettyPrint, "\n", "", -1)