Update logging Rest API
[platform-oam.git] / logging-rest-library / src / main / java / com / logging / rest / example / springbootswagger2 / controller / JsonResponse.java
1 /*-
2  * ===============LICENSE_START=======================================================
3  * Acumos
4  * ===================================================================================
5  * Copyright (C) 2017 AT&T Intellectual Property & Tech Mahindra. All rights reserved.
6  * ===================================================================================
7  * This Acumos software file is distributed by AT&T and Tech Mahindra
8  * under the Apache License, Version 2.0 (the "License");
9  * you may not use this file except in compliance with the License.
10  * You may obtain a copy of the License at
11  *  
12  *      http://www.apache.org/licenses/LICENSE-2.0
13  *  
14  * This file is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  * ===============LICENSE_END=========================================================
19  */
20
21 package com.logging.rest.example.springbootswagger2.controller;
22
23
24 /**
25 * This class represents a common format set for the response send to the client.
26 * Getters and setters encapsulate the fields of a class by making them accessible 
27 * only through its public methods and keep the values themselves private.
28 * @JsonProperty(name), tells Jackson ObjectMapper to map the JSON property name to the annotated Java field's name.
29 */
30
31 import java.io.Serializable;
32
33 import com.fasterxml.jackson.annotation.JsonProperty;
34
35 public class JsonResponse<T> implements Serializable {
36
37         private static final long serialVersionUID = -2934104266393591755L;
38
39         /**
40          * Json property status.
41          */
42         @JsonProperty(value = JSONTags.TAG_RESPONSE_STATUS)
43         private Boolean status;
44
45         /**
46          * Json property statusCode.
47          */
48         @JsonProperty(value = JSONTags.TAG_RESPONSE_STATUS_CODE)
49         private int statusCode;
50         
51         /**
52          * Json property responseDetail.
53          */
54         @JsonProperty(value = JSONTags.TAG_RESPONSE_DETAIL)
55         private String responseDetail;
56
57         /**
58          * Json property responseCode.
59          */
60         @JsonProperty(value = JSONTags.TAG_RESPONSE_CODE)
61         private String responseCode;
62
63         /**
64          * Json property responseBody. It represents the type of generic object.
65          */
66         @JsonProperty(value = JSONTags.TAG_RESPONSE_BODY)
67         private T responseBody;
68         
69         /**
70          * Json property content. It represents the type of generic object.
71          */
72         @JsonProperty(value = JSONTags.TAG_RESPONSE_CONTENT)
73         private T content;
74         
75         public Boolean getStatus() {
76                 return status;
77         }
78
79         public void setStatus(Boolean status) {
80                 this.status = status;
81         }
82
83         public String getResponseDetail() {
84                 return responseDetail;
85         }
86
87         public void setResponseDetail(String responseDetail) {
88                 this.responseDetail = responseDetail;
89         }
90
91         /**
92          * Json property errorCode.
93          */
94         @JsonProperty(value = JSONTags.TAG_ERROR_CODE)
95         private String errorCode;
96
97         public String getErrorCode() {
98                 return errorCode;
99         }
100
101         public void setErrorCode(String errorCode) {
102                 this.errorCode = errorCode;
103         }
104                 
105         public String getResponseCode() {
106                 return responseCode;
107         }
108
109         public void setResponseCode(String responseCode) {
110                 this.responseCode = responseCode;
111         }
112
113         public T getResponseBody() {
114                 return responseBody;
115         }
116
117         public void setResponseBody(T responseBody) {
118                 this.responseBody = responseBody;
119         }
120
121         public T getContent() {
122                 return content;
123         }
124
125         public void setContent(T responseBody) {
126                 this.content = responseBody;
127         }
128
129         public int getStatusCode() {
130                 return statusCode;
131         }
132
133         public void setStatusCode(int statusCode) {
134                 this.statusCode = statusCode;
135         }
136 }