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 GetNodeb(writer http.ResponseWriter, r *http.Request)
50 UpdateGnb(writer http.ResponseWriter, r *http.Request)
51 GetNodebIdList(writer http.ResponseWriter, r *http.Request)
52 SetGeneralConfiguration(writer http.ResponseWriter, r *http.Request)
55 type NodebController struct {
57 handlerProvider *httpmsghandlerprovider.IncomingRequestHandlerProvider
60 func NewNodebController(logger *logger.Logger, handlerProvider *httpmsghandlerprovider.IncomingRequestHandlerProvider) *NodebController {
61 return &NodebController{
63 handlerProvider: handlerProvider,
67 func (c *NodebController) GetNodebIdList(writer http.ResponseWriter, r *http.Request) {
68 c.logger.Infof("[Client -> E2 Manager] #NodebController.GetNodebIdList - request: %v", c.prettifyRequest(r))
70 c.handleRequest(writer, &r.Header, httpmsghandlerprovider.GetNodebIdListRequest, nil, false)
73 func (c *NodebController) GetNodeb(writer http.ResponseWriter, r *http.Request) {
74 c.logger.Infof("[Client -> E2 Manager] #NodebController.GetNodeb - request: %v", c.prettifyRequest(r))
76 ranName := vars["ranName"]
77 request := models.GetNodebRequest{RanName: ranName}
78 c.handleRequest(writer, &r.Header, httpmsghandlerprovider.GetNodebRequest, request, false)
81 func (c *NodebController) UpdateGnb(writer http.ResponseWriter, r *http.Request) {
82 c.logger.Infof("[Client -> E2 Manager] #NodebController.UpdateGnb - request: %v", c.prettifyRequest(r))
84 ranName := vars[ParamRanName]
86 request := models.UpdateGnbRequest{}
90 if !c.extractRequestBodyToProto(r, &gnb, writer) {
95 request.RanName = ranName
96 c.handleRequest(writer, &r.Header, httpmsghandlerprovider.UpdateGnbRequest, request, true)
99 func (c *NodebController) SetGeneralConfiguration(writer http.ResponseWriter, r *http.Request) {
100 c.logger.Infof("[Client -> E2 Manager] #NodebController.SetGeneralConfiguration - request: %v", c.prettifyRequest(r))
102 request := models.GeneralConfigurationRequest{}
104 if !c.extractJsonBodyDisallowUnknownFields(r, &request, writer){
107 c.handleRequest(writer, &r.Header, httpmsghandlerprovider.SetGeneralConfigurationRequest, request, false)
110 func (c *NodebController) Shutdown(writer http.ResponseWriter, r *http.Request) {
111 c.logger.Infof("[Client -> E2 Manager] #NodebController.Shutdown - request: %v", c.prettifyRequest(r))
112 c.handleRequest(writer, &r.Header, httpmsghandlerprovider.ShutdownRequest, nil, false)
115 func (c *NodebController) X2Reset(writer http.ResponseWriter, r *http.Request) {
116 c.logger.Infof("[Client -> E2 Manager] #NodebController.X2Reset - request: %v", c.prettifyRequest(r))
117 request := models.ResetRequest{}
119 ranName := vars[ParamRanName]
121 if r.ContentLength > 0 && !c.extractJsonBody(r, &request, writer) {
124 request.RanName = ranName
125 c.handleRequest(writer, &r.Header, httpmsghandlerprovider.ResetRequest, request, false)
128 func (c *NodebController) extractRequestBodyToProto(r *http.Request, pb proto.Message , writer http.ResponseWriter) bool {
131 err := jsonpb.Unmarshal(r.Body, pb)
134 c.logger.Errorf("[Client -> E2 Manager] #NodebController.extractJsonBody - unable to extract json body - error: %s", err)
135 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
142 func (c *NodebController) extractJsonBodyDisallowUnknownFields(r *http.Request, request models.Request, writer http.ResponseWriter) bool {
145 decoder := json.NewDecoder(r.Body)
146 decoder.DisallowUnknownFields()
148 if err := decoder.Decode(&request); err != nil {
149 c.logger.Errorf("[Client -> E2 Manager] #NodebController.extractJsonBody - unable to extract json body - error: %s", err)
150 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
157 func (c *NodebController) extractJsonBody(r *http.Request, request models.Request, writer http.ResponseWriter) bool {
159 body, err := ioutil.ReadAll(io.LimitReader(r.Body, LimitRequest))
162 c.logger.Errorf("[Client -> E2 Manager] #NodebController.extractJsonBody - unable to extract json body - error: %s", err)
163 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
167 err = json.Unmarshal(body, &request)
169 c.logger.Errorf("[Client -> E2 Manager] #NodebController.extractJsonBody - unable to extract json body - error: %s", err)
170 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
177 func (c *NodebController) handleRequest(writer http.ResponseWriter, header *http.Header, requestName httpmsghandlerprovider.IncomingRequest, request models.Request, validateRequestHeaders bool) {
179 if validateRequestHeaders {
181 err := c.validateRequestHeader(header)
183 c.handleErrorResponse(err, writer)
188 handler, err := c.handlerProvider.GetHandler(requestName)
191 c.handleErrorResponse(err, writer)
195 response, err := handler.Handle(request)
198 c.handleErrorResponse(err, writer)
203 writer.WriteHeader(http.StatusNoContent)
204 c.logger.Infof("[E2 Manager -> Client] #NodebController.handleRequest - status response: %v", http.StatusNoContent)
208 result, err := response.Marshal()
211 c.handleErrorResponse(err, writer)
215 c.logger.Infof("[E2 Manager -> Client] #NodebController.handleRequest - response: %s", result)
216 writer.Header().Set(ContentType, ApplicationJson)
220 func (c *NodebController) validateRequestHeader(header *http.Header) error {
222 if header.Get(ContentType) != ApplicationJson {
223 c.logger.Errorf("#NodebController.validateRequestHeader - validation failure, incorrect content type")
225 return e2managererrors.NewHeaderValidationError()
230 func (c *NodebController) handleErrorResponse(err error, writer http.ResponseWriter) {
232 var errorResponseDetails models.ErrorResponse
237 case *e2managererrors.RnibDbError:
238 e2Error, _ := err.(*e2managererrors.RnibDbError)
239 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
240 httpError = http.StatusInternalServerError
241 case *e2managererrors.CommandAlreadyInProgressError:
242 e2Error, _ := err.(*e2managererrors.CommandAlreadyInProgressError)
243 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
244 httpError = http.StatusMethodNotAllowed
245 case *e2managererrors.HeaderValidationError:
246 e2Error, _ := err.(*e2managererrors.HeaderValidationError)
247 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
248 httpError = http.StatusUnsupportedMediaType
249 case *e2managererrors.WrongStateError:
250 e2Error, _ := err.(*e2managererrors.WrongStateError)
251 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
252 httpError = http.StatusBadRequest
253 case *e2managererrors.RequestValidationError:
254 e2Error, _ := err.(*e2managererrors.RequestValidationError)
255 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
256 httpError = http.StatusBadRequest
257 case *e2managererrors.InvalidJsonError:
258 e2Error, _ := err.(*e2managererrors.InvalidJsonError)
259 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
260 httpError = http.StatusBadRequest
261 case *e2managererrors.RmrError:
262 e2Error, _ := err.(*e2managererrors.RmrError)
263 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
264 httpError = http.StatusInternalServerError
265 case *e2managererrors.ResourceNotFoundError:
266 e2Error, _ := err.(*e2managererrors.ResourceNotFoundError)
267 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
268 httpError = http.StatusNotFound
269 case *e2managererrors.E2TInstanceAbsenceError:
270 e2Error, _ := err.(*e2managererrors.E2TInstanceAbsenceError)
271 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
272 httpError = http.StatusServiceUnavailable
273 case *e2managererrors.RoutingManagerError:
274 e2Error, _ := err.(*e2managererrors.RoutingManagerError)
275 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
276 httpError = http.StatusServiceUnavailable
278 e2Error := e2managererrors.NewInternalError()
279 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
280 httpError = http.StatusInternalServerError
283 errorResponse, _ := json.Marshal(errorResponseDetails)
285 c.logger.Errorf("[E2 Manager -> Client] #NodebController.handleErrorResponse - http status: %d, error response: %+v", httpError, errorResponseDetails)
287 writer.Header().Set(ContentType, ApplicationJson)
288 writer.WriteHeader(httpError)
289 _, err = writer.Write(errorResponse)
292 func (c *NodebController) prettifyRequest(request *http.Request) string {
293 dump, _ := httputil.DumpRequest(request, true)
294 requestPrettyPrint := strings.Replace(string(dump), "\r\n", " ", -1)
295 return strings.Replace(requestPrettyPrint, "\n", "", -1)