1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/*
* Copyright 2016 Huawei Technologies Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onap.vfc.nfvo.multivimproxy.common.util.response;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;
import net.sf.json.JSONObject;
/**
*
* Response utility class.<br>
* <p>
* </p>
*
* @author
* @version VFC 1.0 Sep 10, 2016
*/
public final class ResponseUtil {
private ResponseUtil() {
}
/**
* Roa request common return function, default return code 200 <br/>
*
* @param retCode
* The request return code
* @param msg
* The request message
* @return JSONObject The response for http request
* @since VFC 1.0
*/
public static JSONObject genHttpResponse(int retCode, String msg) {
return genHttpResponse(createCodeMap(-1, retCode), msg, null);
}
/**
* Roa request common return function, default return code 200<br/>
*
* @param retCode
* The request return code
* @param msg
* The request message
* @param map
* Other request info of this request
* @return JSONObject The response for http request
* @since VFC 1.0
*/
public static JSONObject genHttpResponse(int retCode, String msg, Map<String, Object> map) {
return genHttpResponse(createCodeMap(-1, retCode), msg, map);
}
/**
* Roa request common return method <br/>
*
* @param httpStatusCode
* The http response code
* @param retCode
* The http request return code
* @param msg
* The message of request
* @return JSONObject The response for http request
* @since VFC 1.0
*/
public static JSONObject genHttpResponse(int httpStatusCode, int retCode, String msg) {
return genHttpResponse(createCodeMap(httpStatusCode, retCode), msg, null);
}
/**
*
* Roa request common return method.<br>
*
* @param codeMap
* @param msg, The message of request
* @param map, Other message of request
* @return
* @since VFC 1.0
*/
public static JSONObject genHttpResponse(Map<String, Integer> codeMap, String msg,
Map<String, Object> map) {
JSONObject object = new JSONObject();
object.put("msg", msg);
if(null != map) {
Iterator<Entry<String, Object>> ite = map.entrySet().iterator();
if(ite.hasNext()) {
Map.Entry<String, Object> entry = ite.next();
object.put(entry.getKey(), entry.getValue().toString());
}
}
return object;
}
/**
* Create code map to maintenance the relationship between return code and
* http status code <br/>
*
* @param httpStatusCode
* The http response code
* @param retCode
* The http request return code
* @return Map
* @since VFC 1.0
*/
private static Map<String, Integer> createCodeMap(int httpStatusCode, int retCode) {
Map<String, Integer> codeMap = new HashMap<>(5);
codeMap.put("httpStatusCode", httpStatusCode);
codeMap.put("retCode", retCode);
return codeMap;
}
}
|
