minor, use envelope for rest API reponse
Project: http://git-wip-us.apache.org/repos/asf/kylin/repo Commit: http://git-wip-us.apache.org/repos/asf/kylin/commit/7742b31d Tree: http://git-wip-us.apache.org/repos/asf/kylin/tree/7742b31d Diff: http://git-wip-us.apache.org/repos/asf/kylin/diff/7742b31d Branch: refs/heads/KYLIN-2428 Commit: 7742b31d85e4256556c52d3bf0b485ef20151508 Parents: 722efb8 Author: Hongbin Ma <mahong...@apache.org> Authored: Thu Feb 9 10:47:21 2017 +0800 Committer: Hongbin Ma <mahong...@apache.org> Committed: Thu Feb 9 10:47:21 2017 +0800 ---------------------------------------------------------------------- .../rest/controller/EncodingController.java | 11 ++-- .../kylin/rest/response/EnvelopeResponse.java | 58 ++++++++++++++++++++ 2 files changed, 62 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/kylin/blob/7742b31d/server-base/src/main/java/org/apache/kylin/rest/controller/EncodingController.java ---------------------------------------------------------------------- diff --git a/server-base/src/main/java/org/apache/kylin/rest/controller/EncodingController.java b/server-base/src/main/java/org/apache/kylin/rest/controller/EncodingController.java index 2f532e2..b95394c 100644 --- a/server-base/src/main/java/org/apache/kylin/rest/controller/EncodingController.java +++ b/server-base/src/main/java/org/apache/kylin/rest/controller/EncodingController.java @@ -23,6 +23,8 @@ import java.util.Map; import java.util.Set; import org.apache.kylin.metadata.datatype.DataType; +import org.apache.kylin.rest.response.EnvelopeResponse; +import org.apache.kylin.rest.service.EncodingService; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; @@ -34,8 +36,6 @@ import org.springframework.web.bind.annotation.ResponseBody; import com.google.common.collect.Maps; import com.google.common.collect.Sets; -import org.apache.kylin.rest.service.EncodingService; - @Controller @RequestMapping(value = "/encodings") public class EncodingController extends BasicController { @@ -52,7 +52,7 @@ public class EncodingController extends BasicController { */ @RequestMapping(value = "valid_encodings", method = { RequestMethod.GET }) @ResponseBody - public Map<String, Object> getValidEncodings() { + public EnvelopeResponse getValidEncodings() { Set<String> allDatatypes = Sets.newHashSet(); allDatatypes.addAll(DataType.DATETIME_FAMILY); @@ -65,9 +65,6 @@ public class EncodingController extends BasicController { datatypeValidEncodings.put(dataTypeStr, encodingService.getValidEncodings(DataType.getType(dataTypeStr))); } - Map<String, Object> ret = Maps.newHashMap(); - ret.put("code", "000"); - ret.put("data", datatypeValidEncodings); - return ret; + return new EnvelopeResponse(EnvelopeResponse.CODE_SUCCESS, datatypeValidEncodings, ""); } } http://git-wip-us.apache.org/repos/asf/kylin/blob/7742b31d/server-base/src/main/java/org/apache/kylin/rest/response/EnvelopeResponse.java ---------------------------------------------------------------------- diff --git a/server-base/src/main/java/org/apache/kylin/rest/response/EnvelopeResponse.java b/server-base/src/main/java/org/apache/kylin/rest/response/EnvelopeResponse.java new file mode 100644 index 0000000..564db70 --- /dev/null +++ b/server-base/src/main/java/org/apache/kylin/rest/response/EnvelopeResponse.java @@ -0,0 +1,58 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.apache.kylin.rest.response; + +public class EnvelopeResponse { + + public final static String CODE_SUCCESS = "000"; + + private String code; + private Object data; + private String msg; + + public EnvelopeResponse(String code, Object data, String msg) { + this.code = code; + this.data = data; + this.msg = msg; + } + + public String getCode() { + return code; + } + + public void setCode(String code) { + this.code = code; + } + + public Object getData() { + return data; + } + + public void setData(Object data) { + this.data = data; + } + + public String getMsg() { + return msg; + } + + public void setMsg(String msg) { + this.msg = msg; + } +}
