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.extractJsonBody(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) extractJsonBody(r *http.Request, request models.Request, writer http.ResponseWriter) bool {
144 body, err := ioutil.ReadAll(io.LimitReader(r.Body, LimitRequest))
147 c.logger.Errorf("[Client -> E2 Manager] #NodebController.extractJsonBody - unable to extract json body - error: %s", err)
148 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
152 err = json.Unmarshal(body, &request)
154 c.logger.Errorf("[Client -> E2 Manager] #NodebController.extractJsonBody - unable to extract json body - error: %s", err)
155 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
162 func (c *NodebController) handleRequest(writer http.ResponseWriter, header *http.Header, requestName httpmsghandlerprovider.IncomingRequest, request models.Request, validateRequestHeaders bool) {
164 if validateRequestHeaders {
166 err := c.validateRequestHeader(header)
168 c.handleErrorResponse(err, writer)
173 handler, err := c.handlerProvider.GetHandler(requestName)
176 c.handleErrorResponse(err, writer)
180 response, err := handler.Handle(request)
183 c.handleErrorResponse(err, writer)
188 writer.WriteHeader(http.StatusNoContent)
189 c.logger.Infof("[E2 Manager -> Client] #NodebController.handleRequest - status response: %v", http.StatusNoContent)
193 result, err := response.Marshal()
196 c.handleErrorResponse(err, writer)
200 c.logger.Infof("[E2 Manager -> Client] #NodebController.handleRequest - response: %s", result)
201 writer.Header().Set(ContentType, ApplicationJson)
205 func (c *NodebController) validateRequestHeader(header *http.Header) error {
207 if header.Get(ContentType) != ApplicationJson {
208 c.logger.Errorf("#NodebController.validateRequestHeader - validation failure, incorrect content type")
210 return e2managererrors.NewHeaderValidationError()
215 func (c *NodebController) handleErrorResponse(err error, writer http.ResponseWriter) {
217 var errorResponseDetails models.ErrorResponse
222 case *e2managererrors.RnibDbError:
223 e2Error, _ := err.(*e2managererrors.RnibDbError)
224 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
225 httpError = http.StatusInternalServerError
226 case *e2managererrors.CommandAlreadyInProgressError:
227 e2Error, _ := err.(*e2managererrors.CommandAlreadyInProgressError)
228 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
229 httpError = http.StatusMethodNotAllowed
230 case *e2managererrors.HeaderValidationError:
231 e2Error, _ := err.(*e2managererrors.HeaderValidationError)
232 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
233 httpError = http.StatusUnsupportedMediaType
234 case *e2managererrors.WrongStateError:
235 e2Error, _ := err.(*e2managererrors.WrongStateError)
236 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
237 httpError = http.StatusBadRequest
238 case *e2managererrors.RequestValidationError:
239 e2Error, _ := err.(*e2managererrors.RequestValidationError)
240 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
241 httpError = http.StatusBadRequest
242 case *e2managererrors.InvalidJsonError:
243 e2Error, _ := err.(*e2managererrors.InvalidJsonError)
244 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
245 httpError = http.StatusBadRequest
246 case *e2managererrors.RmrError:
247 e2Error, _ := err.(*e2managererrors.RmrError)
248 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
249 httpError = http.StatusInternalServerError
250 case *e2managererrors.ResourceNotFoundError:
251 e2Error, _ := err.(*e2managererrors.ResourceNotFoundError)
252 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
253 httpError = http.StatusNotFound
254 case *e2managererrors.E2TInstanceAbsenceError:
255 e2Error, _ := err.(*e2managererrors.E2TInstanceAbsenceError)
256 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
257 httpError = http.StatusServiceUnavailable
258 case *e2managererrors.RoutingManagerError:
259 e2Error, _ := err.(*e2managererrors.RoutingManagerError)
260 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
261 httpError = http.StatusServiceUnavailable
263 e2Error := e2managererrors.NewInternalError()
264 errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
265 httpError = http.StatusInternalServerError
268 errorResponse, _ := json.Marshal(errorResponseDetails)
270 c.logger.Errorf("[E2 Manager -> Client] #NodebController.handleErrorResponse - http status: %d, error response: %+v", httpError, errorResponseDetails)
272 writer.Header().Set(ContentType, ApplicationJson)
273 writer.WriteHeader(httpError)
274 _, err = writer.Write(errorResponse)
277 func (c *NodebController) prettifyRequest(request *http.Request) string {
278 dump, _ := httputil.DumpRequest(request, true)
279 requestPrettyPrint := strings.Replace(string(dump), "\r\n", " ", -1)
280 return strings.Replace(requestPrettyPrint, "\n", "", -1)