org.dmonix.servlet.ResponseBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of simple-servlet-framework Show documentation
A really simple servlet framework
The newest version!
/**
 *  Copyright 2016 Peter Nerg
 *
 *  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.dmonix.servlet;

import com.google.gson.Gson;
import javascalautils.Try;

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

import static javascalautils.OptionCompanion.Some;
import static javax.servlet.http.HttpServletResponse.*;

/**
 * Interface for building the response to be sent to the client.
 *
 * @author Peter Nerg
 * @since 1.0
 */
public interface ResponseBuilder {
    Gson gson = new Gson();

    /**
     * Creates an empty response with only a response code
     *
     * @param responseCode
     *            The HTTP response code
     * @return The response object
     */
    default Response EmptyResponse(int responseCode) {
        return new Response(responseCode, "");
    }

    /**
     * Creates an empty response with only 200 - OK
     *
     * @return The response object
     * @since 1.3
     */
    default Response OKResponse() {
        return EmptyResponse(SC_OK);
    }

    /**
     * Creates an empty response with only 202 - Accepted
     *
     * @return The response object
     */
    default Response AcceptedResponse() {
        return EmptyResponse(SC_ACCEPTED);
    }

    /**
     * Creates an empty response with only 201 - Created
     *
     * @return The response object
     */
    default Response CreatedResponse() {
        return EmptyResponse(SC_CREATED);
    }

    /**
     * Creates a response where the provided object will be converted to json. 

     * Will by default use the charset UTF-8
     * @param object
     *            The response object/message
     * @return The response object
     */
    default Response ObjectResponse(Object object) {
        return ObjectResponse(object, "UTF-8");
    }

    /**
     * Creates a response where the provided object will be converted to json.
     *
     * @param object
     *            The response object/message
     * @param charEncoding The character encoding to use
     * @return The response object
     */
    default Response ObjectResponse(Object object, String charEncoding) {
        return new Response(SC_OK, gson.toJson(object), Some("application/json;charset="+charEncoding), Some(charEncoding));
    }

    /**
     * Creates an error response with a error code. 

     * If the throwable is of type {@link JSONServletException} then the Response for that exception is used, else
     * an internal error code is returned using the message from the exception as response body.
     * @param throwable The underlying issue
     * @return The response object
     * @see #ErrorResponse(int, String)
     */
    default Response ErrorResponse(Throwable throwable) {
        if(throwable instanceof JSONServletException)
            return ((JSONServletException)throwable).response;
        else
            return ErrorResponse(SC_INTERNAL_SERVER_ERROR, throwable.getMessage());
    }

    /**
     * Creates an error with a provided error code
     *
     * @param responseCode
     *            The HTTP response code
     * @param message The message
     * @return The response object
     */
    default Response ErrorResponse(int responseCode, String message) {
        return new Response(responseCode, message);
    }

    /**
     * Creates an error with a 404 - Not found
     *
     * @param message The message
     * @return The response object
     */
    default Response ErrorResponseNotFound(String message) {
        return ErrorResponse(SC_NOT_FOUND, message);
    }

    /**
     * Creates an error with code 400 and the message that the path is missing
     * @return The response object
     */
    default Response ErrorResponseMissingPath() {
        return ErrorResponse(SC_BAD_REQUEST, "Missing path");
    }

    /**
     * Creates an error with code 403 and the message that the path already exists.
     * @param path The path which already existed
     * @return The response object
     */
    default Response ErrorResponseResourceAlreadyExists(String path) {
        return ErrorResponse(SC_FORBIDDEN, "The resource depicted by ["+path+"] already exists");
    }

    /**
     * Creates an error with code 405 stating the operation is not supported.
     * @return The response object
     */
    default Response ErrorResponseUnsupportedOperation() {
        return ErrorResponse(SC_METHOD_NOT_ALLOWED, "Method not allowed");
    }

    /**
     * Creates an error with code 401 stating the operation/user was not authorized.
     * @param message The message for the response
     * @return The response object
     * @since 1.5
     */
    default Response ErrorResponseUnauthorized(String message) {
        return ErrorResponse(SC_UNAUTHORIZED, message);
    }

    /**
     * Write the response to the client.
     *
     * @param resp The HTTP servlet response object
     * @param response The response object, either successful or failed
     * @throws IOException Any exception during processing
     */
    default void writeResponse(HttpServletResponse resp, Try response) throws IOException {
        //orNull will never happen as we've set a recover function
        writeResponse(resp, response.recover(this::ErrorResponse).orNull());
    }

    /**
     * Write the response to the client.
     *
     * @param resp The HTTP servlet response object
     * @param response The response object to be sent to the client
     * @throws IOException Any exception during processing
     */
    default void writeResponse(HttpServletResponse resp, Response response) throws IOException {
        //set the response code, e.g. 200
        resp.setStatus(response.responseCode);

        //set all headers
        response.headers().forEach(resp::setHeader);

        //set the optional content-type
        response.mediaType.forEach(resp::setContentType);

        //set the optional char-encoding
        response.charEncoding.forEach(resp::setCharacterEncoding);

        //add any optional cookies
        response.cookies().forEach(resp::addCookie);

        //write any body data
        resp.getWriter().write(response.message);
    }

}