Metacat

/**

 *  '$RCSfile$'

 *    Purpose: A Class that implements administrative methods 

 *  Copyright: 2008 Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *    Authors: Michael Daigle

 * 

 *   '$Author: daigle $'

 *     '$Date: 2008-07-06 21:25:34 -0700 (Sun, 06 Jul 2008) $'

 * '$Revision: 4080 $'

 *

 * This program 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 2 of the License, or

 * (at your option) any later version.

 *

 * This program 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 this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat.util;

import java.io.IOException;

import java.util.Vector;

import javax.servlet.ServletContext;

import javax.servlet.ServletException;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import org.apache.log4j.Logger;

public class RequestUtil {

	private static Logger logMetacat = Logger.getLogger(RequestUtil.class);

	/**

	 * private constructor - all methods are static so there is no

     * no need to instantiate.

	 */

	private RequestUtil() {}

	/**

	 * Forward a request that was received by this servlet on to another JSP

	 * page or servlet to continue handling the request.

	 * 

	 * @param request

	 *            to be forwarded

	 * @param response

	 *            that can be used for writing output to the client

	 * @param destination

	 *            the context-relative URL to which the request is forwarded

	 */

	public static void forwardRequest(HttpServletRequest request,

			HttpServletResponse response, String destination)

			throws IOException, ServletException {

		logMetacat.debug("Forwarding request to " + destination);

		ServletContext servletContext = request.getSession()

				.getServletContext();

		servletContext.getRequestDispatcher(destination).forward(request,

				response);

	}

	/**

	 * Add a list of errors to the request. The pages will pick up the errors

	 * and display them where appropriate.

	 * 

	 * @param request

	 *            the request that will get forwarded

	 * @param errorVector

	 *            a list of error strings

	 */

	public static void setRequestErrors(HttpServletRequest request,

			Vector<String> errorVector) {

		request.setAttribute("formErrors", "true");

		request.setAttribute("processingErrors", errorVector);

	}

	/**

	 * Add a list of form errors to the request. The pages will pick up the

	 * errors and display them where appropriate.

	 * 

	 * @param request

	 *            the request that will get forwarded

	 * @param errorVector

	 *            a list of form error strings

	 */

	public static void setRequestFormErrors(HttpServletRequest request,

			Vector<String> errorVector) {

		request.setAttribute("formErrors", "true");

		request.setAttribute("formFieldErrors", errorVector);

	}

	/**

	 * Add a list of success messages to the request. The pages will pick up the

	 * messages and display them where appropriate.

	 * 

	 * @param request

	 *            the request that will get forwarded

	 * @param errorVector

	 *            a list of success message strings

	 */

	public static void setRequestSuccess(HttpServletRequest request,

			Vector<String> successVector) {

		request.setAttribute("formSuccess", "true");

		request.setAttribute("processingSuccess", successVector);

	}

	/**

	 * Add a list of general messages to the request. The pages will pick up the

	 * messages and display them where appropriate.

	 * 

	 * @param request

	 *            the request that will get forwarded

	 * @param errorVector

	 *            a list of general message strings

	 */

	public static void setRequestMessage(HttpServletRequest request,

			Vector<String> messageVector) {

		request.setAttribute("formMessage", "true");

		request.setAttribute("processingMessage", messageVector);

	}

	/**

	 * Add a list of general messages to the request. The pages will pick up the

	 * messages and display them where appropriate.

	 * 

	 * @param request

	 *            the request that will get forwarded

	 * @param errorVector

	 *            a list of general message strings

	 */

	public static void clearRequestMessages(HttpServletRequest request) {

		request.setAttribute("formMessage", null);

		request.setAttribute("formSuccess", null);

		request.setAttribute("formErrors", null);

		request.setAttribute("processingMessage", null);

		request.setAttribute("processingSuccess", null);

		request.setAttribute("formFieldErrors", null);

		request.setAttribute("processingErrors", null);

	}

	/**

	 * Add the user's login id to the session on this request

	 * 

	 * @param request

	 *            the request that will get forwarded

	 * @param userId

	 *            the user's login id

	 */

	public static void setUserId(HttpServletRequest request, String userId) {

		request.getSession().setAttribute("userId", userId);

	}

}