org.structr.rest.RestMethodResult.java Source code

Introduction

Here is the source code for org.structr.rest.RestMethodResult.java

Source

/**
 * Copyright (C) 2010-2016 Structr GmbH
 *
 * This file is part of Structr <http://structr.org>.
 *
 * Structr is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * Structr is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Structr.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.structr.rest;

import com.google.gson.Gson;
import com.google.gson.JsonIOException;
import java.io.IOException;
import java.io.Writer;
import java.util.LinkedHashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.lang3.StringUtils;
import org.structr.core.GraphObject;
import org.structr.core.Result;

/**
 * Encapsulates the result of a REST HTTP method call, i.e. headers, response
 * code etc.
 *
 *
 */
public class RestMethodResult {

    private static final Logger logger = Logger.getLogger(RestMethodResult.class.getName());

    private List<GraphObject> content = null;
    private Map<String, String> headers = null;
    private int responseCode = 0;
    private String message = null;
    private boolean serializeSingleObjectAsCollection = false;
    private boolean serializeAsPrimitiveArray = false;

    public RestMethodResult(final int responseCode) {
        this.headers = new LinkedHashMap<>();
        this.responseCode = responseCode;
    }

    public RestMethodResult(final int responseCode, final String message) {
        headers = new LinkedHashMap<>();
        this.message = message;
        this.responseCode = responseCode;
    }

    public RestMethodResult(final int responseCode, final boolean serializeSingleObjectAsCollection) {
        this.headers = new LinkedHashMap<>();
        this.responseCode = responseCode;
        this.serializeSingleObjectAsCollection = serializeSingleObjectAsCollection;
    }

    public void addHeader(final String key, final String value) {
        headers.put(key, value);
    }

    public void addContent(final GraphObject graphObject) {

        if (this.content == null) {
            this.content = new LinkedList<>();
        }

        this.content.add(graphObject);
    }

    public void commitResponse(final Gson gson, final HttpServletResponse response) {

        // set headers
        for (Entry<String, String> header : headers.entrySet()) {
            response.setHeader(header.getKey(), header.getValue());
        }

        // set  response code
        response.setStatus(responseCode);

        try {

            Writer writer = response.getWriter();
            if (content != null) {

                // create result set
                Result result = new Result(this.content, this.content.size(),
                        this.content.size() > 1 || serializeSingleObjectAsCollection, serializeAsPrimitiveArray);

                // serialize result set
                gson.toJson(result, writer);
            }

            if (content == null) {

                writer.append(jsonMessage(responseCode, message));

            }

            // add newline
            writer.append("\n");

            //writer.flush();
            //writer.close();
        } catch (JsonIOException | IOException t) {

            logger.log(Level.WARNING, "Unable to commit HttpServletResponse", t);
        }
    }

    public void serializeAsPrimitiveArray(final boolean value) {

        this.serializeAsPrimitiveArray = value;

    }

    public Map<String, String> getHeaders() {
        return headers;
    }

    public List<GraphObject> getContent() {
        return content;
    }

    public static String jsonError(final int code, final String message) {

        return jsonMessage(code, message, "error");

    }

    public static String jsonMessage(final int code, final String message) {

        return jsonMessage(code, message, "message");

    }

    public static String jsonMessage(final int code, final String message, final String messageKey) {

        StringBuilder buf = new StringBuilder(100);

        buf.append("{\n");
        buf.append("  \"code\" : ").append(code);

        if (message != null) {

            buf.append(",\n  \"").append(messageKey).append("\" : \"")
                    .append(StringUtils.replace(message, "\"", "\\\"")).append("\"\n");

        } else {

            buf.append("\n");

        }

        buf.append("}\n");

        return buf.toString();
    }

}