CommonLibrary(util/rest-client) code upload.
[vfc/nfvo/wfengine.git] / rest-client / src / main / java / org / openo / baseservice / roa / util / restclient / RestfulResponse.java
1 /*
2  * Copyright (c) 2016, Huawei Technologies Co., Ltd.
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.openo.baseservice.roa.util.restclient;
18
19 import java.util.Map;
20
21 /**
22  * Response for RestFul requests.<br/>
23  * <p>
24  * </p>
25  * 
26  * @author
27  * @version SDNO 0.5 28-May-2016
28  */
29 public class RestfulResponse {
30
31     private String responseContent;
32
33     private int status = -1;
34
35     private Map<String, String> respHeaderMap = null;
36
37     /**
38      * <br/>
39      * 
40      * @return
41      * @since SDNO 0.5
42      */
43     public int getStatus() {
44         return status;
45     }
46
47     /**
48      * <br/>
49      * 
50      * @param status
51      * @since SDNO 0.5
52      */
53     public void setStatus(final int status) {
54         this.status = status;
55     }
56
57     /**
58      * <br/>
59      * 
60      * @return
61      * @since SDNO 0.5
62      */
63     public Map<String, String> getRespHeaderMap() {
64         return respHeaderMap;
65     }
66
67     /**
68      * <br/>
69      * 
70      * @param header
71      * @since SDNO 0.5
72      */
73     public void setRespHeaderMap(final Map<String, String> header) {
74         this.respHeaderMap = header;
75     }
76
77     /**
78      * Get response header value as integer.<br/>
79      * 
80      * @param key header param name.
81      * @return header param value as integer. (-1 if error)
82      * @since SDNO 0.5
83      */
84     public int getRespHeaderInt(final String key) {
85         if(respHeaderMap != null) {
86             final String result = respHeaderMap.get(key);
87             if(result != null) {
88                 return Integer.parseInt(result);
89             }
90         }
91         return -1;
92     }
93
94     /**
95      * Get response header value as long.<br/>
96      * 
97      * @param key header param name.
98      * @return value as long. -1 if no value.
99      * @since SDNO 0.5
100      */
101     public long getRespHeaderLong(final String key) {
102         if(respHeaderMap != null) {
103             final String result = respHeaderMap.get(key);
104             if(result != null) {
105                 return Long.parseLong(result);
106             }
107         }
108         return -1;
109     }
110
111     /**
112      * Get http header as string.<br/>
113      * 
114      * @param key header name.
115      * @return header value.
116      * @since SDNO 0.5
117      */
118     public String getRespHeaderStr(final String key) {
119         if(respHeaderMap != null) {
120             return respHeaderMap.get(key);
121         }
122         return null;
123     }
124
125     /**
126      * <br/>
127      * 
128      * @return
129      * @since SDNO 0.5
130      */
131     public String getResponseContent() {
132         return responseContent;
133     }
134
135     /**
136      * <br/>
137      * 
138      * @param responseString
139      * @since SDNO 0.5
140      */
141     public void setResponseJson(final String responseString) {
142         this.responseContent = responseString;
143     }
144 }