com.controlj.addon.weather.util.ResponseWriter.java Source code

Introduction

Here is the source code for com.controlj.addon.weather.util.ResponseWriter.java

Source

/*
 * Copyright (c) 2011 Automated Logic Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.controlj.addon.weather.util;

import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.Map;

/**
 *
 */
public class ResponseWriter {
    private static final String ERROR_LIST = "errors";
    private HttpServletResponse resp;
    private JSONObject jsonRoot;

    public ResponseWriter(HttpServletResponse resp) {
        this.resp = resp;
        this.jsonRoot = new JSONObject();
    }

    public void putStringChild(String parentName, String fieldName, String value) {
        try {
            JSONObject child = getOrCreateObject(parentName);
            child.put(fieldName, value);
        } catch (JSONException e) {
            Logging.println("Error encoding json int value", e);
        }
    }

    public void putString(String fieldName, String value) {
        try {
            jsonRoot.put(fieldName, value);
        } catch (JSONException e) {
            Logging.println("Error encoding json string value of '" + value + "'", e);
        }
    }

    public void appendToArray(String arrayName, Map<String, Object> values) {
        try {
            JSONArray array = getOrCreateArray(arrayName);
            JSONObject next = new JSONObject(values);
            array.put(next);
        } catch (JSONException e) {
            Logging.println("Error adding to JSON array", e);
        }
    }

    public void appendToArray(String arrayName, String value) {
        try {
            JSONArray array = getOrCreateArray(arrayName);
            array.put(value);
        } catch (JSONException e) {
            Logging.println("Error adding string to JSON array", e);
        }
    }

    public void appendToArray(String arrayName, String[] values) {
        try {
            JSONArray array = getOrCreateArray(arrayName);
            JSONArray next = new JSONArray();
            for (String value : values) {
                next.put(value);
            }
            array.put(next);
        } catch (JSONException e) {
            Logging.println("Error adding to JSON array", e);
        }
    }

    public void appendToArray(String arrayName, Map<String, Object>[] values) {
        try {
            JSONArray array = getOrCreateArray(arrayName);
            JSONArray next = new JSONArray();
            for (Map<String, Object> value : values) {
                next.put(new JSONObject(value));
            }
            array.put(next);
        } catch (JSONException e) {
            Logging.println("Error adding to JSON array", e);
        }
    }

    public boolean hasErrors() {
        return jsonRoot.has(ERROR_LIST);
    }

    public void addValidationError(String fieldName, String message) {
        try {
            JSONArray errors = getOrCreateArray(ERROR_LIST);
            JSONObject error = new JSONObject();
            error.put("errortype", "validation");
            error.put("field", fieldName);
            error.put("message", message);
            errors.put(error);
        } catch (JSONException e) {
            Logging.println("Error trying to write out errors with JSON", e);
        }
    }

    public void addError(String message) {
        try {
            JSONArray errors = getOrCreateArray(ERROR_LIST);
            JSONObject error = new JSONObject();
            error.put("errortype", "general");
            error.put("message", message);
            errors.put(error);
        } catch (JSONException e) {
            Logging.println("Error trying to write out errors with JSON", e);
        }
    }

    public void write() throws IOException {
        resp.setContentType("application/json");
        try {
            jsonRoot.write(resp.getWriter());
        } catch (JSONException e) {
            throw (IOException) new IOException("Error writing JSON").initCause(e);
        }
    }

    private JSONArray getOrCreateArray(String arrayName) throws JSONException {
        JSONArray result;
        if (jsonRoot.has(arrayName)) {
            result = (JSONArray) jsonRoot.get(arrayName);
        } else {
            result = new JSONArray();
            jsonRoot.put(arrayName, result);
        }
        return result;
    }

    private JSONObject getOrCreateObject(String childName) throws JSONException {
        JSONObject result;
        if (jsonRoot.has(childName)) {
            result = (JSONObject) jsonRoot.get(childName);
        } else {
            result = new JSONObject();
            jsonRoot.put(childName, result);
        }
        return result;
    }

}