com.act.web.includeservletasstring.IncludeServletAsString.java Source code

Introduction

Here is the source code for com.act.web.includeservletasstring.IncludeServletAsString.java

Source

/*
 * Copyright 2006, XpertNet SARL, and individual contributors as indicated by
 * the contributors.txt. This is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of the License,
 * or (at your option) any later version. This software 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 Lesser General Public License for more details. You should have
 * received a copy of the GNU Lesser General Public License along with this
 * software; if not, write to the Free Software Foundation, Inc., 51 Franklin
 * St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site:
 * http://www.fsf.org. @author jeremi @author sdumitriu
 */

package com.act.web.includeservletasstring;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import javax.servlet.RequestDispatcher;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

/**
 * @author LBlaze
 */
public class IncludeServletAsString {

    private static final Log log = LogFactory.getLog(IncludeServletAsString.class);

    /**
     * Creates a new instance of IncludeServletAsString
     */
    private IncludeServletAsString() {
    }

    static public String invokeServletAndReturnAsString(String url, HttpServletRequest servletRequest,
            HttpServletResponse servletResponse) throws IOException, ServletException {

        if (log.isDebugEnabled()) {
            log.debug("Including url \"" + url + "\"...");
        }

        RequestDispatcher requestDispatcher = servletRequest.getRequestDispatcher(url);

        if (requestDispatcher == null) {
            IllegalArgumentException iae = new IllegalArgumentException(
                    "Failed to get RequestDispatcher for url: " + url);
            log.error(iae.getMessage(), iae);
            throw iae;
        }

        BufferedResponse bufferedResponse = new BufferedResponse(servletResponse);

        requestDispatcher.include(servletRequest, bufferedResponse);

        byte[] buffer = bufferedResponse.getBufferAsByteArray();
        if (log.isDebugEnabled()) {
            log.debug("Buffer returned with " + buffer.length + " bytes.");
        }

        String bufferString = new String(buffer, servletResponse.getCharacterEncoding());

        return bufferString;
    }

}