Merge "Created media folders for ResourceDictionary"
[ccsdk/cds.git] / ms / blueprintsprocessor / modules / inbounds / resource-api / src / main / kotlin / org / onap / ccsdk / cds / blueprintsprocessor / resource / api / ResourceExceptionHandler.kt
1 /*
2  * Copyright © 2019 Bell Canada
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package org.onap.ccsdk.cds.blueprintsprocessor.resource.api
18
19 import com.fasterxml.jackson.annotation.JsonFormat
20 import com.fasterxml.jackson.annotation.JsonInclude
21 import com.fasterxml.jackson.annotation.JsonTypeInfo
22 import com.fasterxml.jackson.annotation.JsonTypeName
23 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintProcessorException
24 import org.onap.ccsdk.cds.controllerblueprints.core.data.ErrorCode
25 import org.slf4j.LoggerFactory
26 import org.springframework.http.HttpStatus
27 import org.springframework.http.ResponseEntity
28 import org.springframework.orm.jpa.JpaObjectRetrievalFailureException
29 import org.springframework.dao.EmptyResultDataAccessException
30 import org.springframework.dao.IncorrectResultSizeDataAccessException
31 import org.springframework.web.server.ServerWebInputException
32 import org.springframework.web.bind.annotation.ExceptionHandler
33 import org.springframework.web.bind.annotation.RestControllerAdvice
34 import java.io.Serializable
35 import java.util.*
36
37 /**
38  * Handle exceptions in Resolution API and provide relevant HTTP status codes and messages
39  *
40  * @author Serge Simard
41  * @version 1.0
42  */
43 @RestControllerAdvice("org.onap.ccsdk.cds.blueprintsprocessor.resource.api")
44 open class ResourceExceptionHandler {
45
46     private val log = LoggerFactory.getLogger(ExceptionHandler::class.toString())
47
48     private val debugMsg = "Resolution_Service_Error_Message"
49
50     @ExceptionHandler
51     fun resolutionResultsServiceExceptionHandler(e: BluePrintProcessorException): ResponseEntity<ErrorMessage> {
52         val errorCode = ErrorCode.BLUEPRINT_PATH_MISSING
53         return returnError(e, errorCode)
54     }
55
56     @ExceptionHandler
57     fun resolutionResultsServiceExceptionHandler(e: ServerWebInputException): ResponseEntity<ErrorMessage> {
58         val errorCode = ErrorCode.INVALID_REQUEST_FORMAT
59         return returnError(e, errorCode)
60     }
61
62     @ExceptionHandler
63     fun resolutionResultsServiceExceptionHandler(e: IncorrectResultSizeDataAccessException): ResponseEntity<ErrorMessage> {
64         val errorCode = ErrorCode.DUPLICATE_DATA
65         return returnError(e, errorCode)
66     }
67
68     @ExceptionHandler
69     fun resolutionResultsServiceExceptionHandler(e: EmptyResultDataAccessException): ResponseEntity<ErrorMessage> {
70         val errorCode = ErrorCode.RESOURCE_NOT_FOUND
71         return returnError(e, errorCode)
72     }
73
74     @ExceptionHandler
75     fun resolutionResultsServiceExceptionHandler(e: JpaObjectRetrievalFailureException): ResponseEntity<ErrorMessage> {
76         val errorCode = ErrorCode.RESOURCE_NOT_FOUND
77         return returnError(e, errorCode)
78     }
79
80     @ExceptionHandler
81     fun resolutionResultsServiceExceptionHandler(e: Exception): ResponseEntity<ErrorMessage> {
82         val errorCode = ErrorCode.GENERIC_FAILURE
83         return returnError(e, errorCode)
84     }
85
86     fun returnError(e: Exception, errorCode: ErrorCode): ResponseEntity<ErrorMessage> {
87         log.error(e.message, e)
88         val errorMessage =
89             ErrorMessage(errorCode.message(e.message!!),
90                 errorCode.value,
91                 debugMsg)
92         return ResponseEntity(errorMessage, HttpStatus.resolve(errorCode.httpCode)!!)
93     }
94
95     @ExceptionHandler
96     fun ResolutionResultsServiceExceptionHandler(e: ResolutionException): ResponseEntity<ErrorMessage> {
97         log.error(e.message, e)
98         return ResponseEntity(ErrorMessage(e.message, e.code, debugMsg), HttpStatus.resolve(e.code))
99     }
100 }
101
102 @JsonInclude(JsonInclude.Include.NON_NULL)
103 @JsonTypeName("errorMessage")
104 @JsonTypeInfo(include = JsonTypeInfo.As.WRAPPER_OBJECT, use = JsonTypeInfo.Id.NAME)
105 class ErrorMessage(var message: String?, var code: Int?, var debugMessage: String?) : Serializable {
106     @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
107     var timestamp = Date()
108 }