PageContext.java

/**
 * Copyright 2010 Marko Lavikainen
 *
 * 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 net.contextfw.web.application;

import java.util.Locale;

import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import net.contextfw.web.application.lifecycle.PageScoped;

/**
 * This class contains functionality to access basic servlet resources and make basic
 * controls.
 * 
 */
@PageScoped
public class PageContext {

    private transient HttpServlet servlet;
    private transient HttpServletRequest request;
    private transient HttpServletResponse response;

    private final String requestURI;
    private final String queryString;
    private String redirectUrl;
    private String errorMsg;
    private Integer errorCode;
    private boolean reload = false;
    
    private Locale locale;

    /**
     * Reloads current page
     * 
     * <p>
     *  This method has effect only during page update.  
     * </p>
     */
    public void reload() {
        reload = true;
    }
    
    /**
     * Redirects page to new location
     * 
     * @param url
     *  The new URL
     */
    public void redirect(String url) {
        this.redirectUrl = url;
    }
    
    /**
     * Sends a server error.
     * 
     * <p>
     *  Usable only on init phase
     * </p>
     * 
     * @param code
     *  Http response code
     */
    public void sendError(int code) {
        sendError(code, null);
    }
    
    /**
     * Sends a server error with a message.
     * 
     * <p>
     *  Usable only on init phase
     * </p>
     * 
     * @param code
     *  Http response code
     * @param msg
     *  Message
     */
    public void sendError(int code, String msg) {
        this.errorCode = code;
        this.errorMsg = msg;
    }

    public void setServlet(HttpServlet servlet) {
        this.servlet = servlet;
    }

    /**
     * Gets current servlet used for the request
     */
    public HttpServlet getServlet() {
        return servlet;
    }

    public void setRequest(HttpServletRequest request) {
        this.request = request;
    }

    /**
     * Gets current request
     */
    public HttpServletRequest getRequest() {
        return request;
    }

    public void setResponse(HttpServletResponse response) {
        this.response = response;
    }
    
    /**
     * Gets current response for the request
     */
    public HttpServletResponse getResponse() {
        return response;
    }

    public PageContext(HttpServlet servlet, HttpServletRequest request, HttpServletResponse response) {
        super();
        this.servlet = servlet;
        this.request = request;
        this.response = response;
        
        requestURI = request.getRequestURI();
        queryString = request.getQueryString();
    }


    public String getRedirectUrl() {
        return redirectUrl;
    }
    public String getErrorMsg() {
        return errorMsg;
    }
    public Integer getErrorCode() {
        return errorCode;
    }

    public boolean isReload() {
        return reload;
    }

    /**
     * Returns the original request URI when page was initialized
     * 
     * @return
     *   The original request URI
     * 
     */
    public String getRequestURI() {
        return requestURI;
    }

    /**
     * Returns the original query string when page was initialized
     * 
     * @return
     *   The original query string
     * 
     */
    public String getQueryString() {
        return queryString;
    }

    public Locale getLocale() {
        return locale;
    }

    public void setLocale(Locale locale) {
        this.locale = locale;
    }
}