com.agapsys.rcf.ActionResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rcf-core Show documentation
REST Controller Framework for java back-end applications
There is a newer version: 0.1.0-20170604
/*
 * Copyright 2016 Agapsys Tecnologia Ltda-ME.
 *
 * 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 com.agapsys.rcf;

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

public class ActionResponse extends ServletExchange {

    private final ActionResponse wrappedResponse;
    
    private ActionRequest request;

    // Generic constructor
    ActionResponse(ActionResponse wrappedResponse, HttpServletRequest servletRequest, HttpServletResponse servletResponse) {
        super(servletRequest, servletResponse);
        this.wrappedResponse = wrappedResponse;
        if (wrappedResponse != null)
            request = wrappedResponse.request;
    }

    ActionResponse(HttpServletRequest serlvetRequest, HttpServletResponse servletResponse) {
        this(null, serlvetRequest, servletResponse);
    }

    protected ActionResponse(ActionResponse wrappedResponse) {
        this(wrappedResponse, wrappedResponse.getServletRequest(), wrappedResponse.getServletResponse());
    }

    protected final ActionResponse getWrappedResponse() {
        return wrappedResponse;
    }

    /**
     * Adds a cookie.
     *
     * @param name cookie name
     * @param value cookie value
     * @param maxAge an integer specifying the maximum age of the cookie in seconds; if negative, means the cookie is not stored; if zero, deletes the cookie
     * @param path cookie path (usually {@linkplain HttpServletRequest#getContextPath()})
     * @return this
     */
    public final ActionResponse addCookie(String name, String value, int maxAge, String path) {
        if (path == null || !path.startsWith("/"))
            throw new IllegalArgumentException("Invalid path: " + path);

        Cookie cookie = new Cookie(name, value);
        cookie.setPath(path);
        cookie.setMaxAge(maxAge);
        getServletResponse().addCookie(cookie);
        return this;
    }

    /**
     * Adds a cookie for request context path.
     *
     * @param name cookie name
     * @param value cookie value
     * @param maxAge an integer specifying the maximum age of the cookie in seconds; if negative, means the cookie is not stored; if zero, deletes the cookie
     * @return this
     */
    public final ActionResponse addCookie(String name, String value, int maxAge) {
        addCookie(name, value, maxAge, getServletRequest().getContextPath());
        return this;
    }

    /**
     * Removes a cookie.
     *
     * @param name name of the cookie to be removed
     * @param path cookie path ((usually {@linkplain HttpServletRequest#getContextPath()})
     * @return this
     */
    public final ActionResponse removeCookie(String name, String path) {
        addCookie(name, null, 0, path);
        return this;
    }

    public final ActionResponse setHeader(String name, String value) {
        getServletResponse().setHeader(name, value);
        return this;
    }

    public final ActionResponse addHeader(String name, String value) {
        getServletResponse().addHeader(name, value);
        return this;
    }

    /**
     * Removes a cookie for request context path.
     *
     * @param name name of the cookie to be removed
     * @return this
     */
    public final ActionResponse removeCookie(String name) {
        removeCookie(name, getServletRequest().getContextPath());
        return this;
    }

    public final ActionResponse sendTemporaryRedirect(String location) throws IOException {
        getServletResponse().sendRedirect(location);
        return this;
    }

    public final ActionResponse sendPermanentRedirect(String location) throws IOException {
        setStatus(HttpServletResponse.SC_MOVED_PERMANENTLY);
        addHeader("Location", location);
        return this;
    }

    public final ActionResponse setStatus(int status) throws IOException {
        getServletResponse().setStatus(status);
        return this;
    }

    final void _setRequest(ActionRequest request) {
        this.request = request;
    }
    
    public final ActionRequest getRequest() {
        return request;
    }
}