org.opencms.staticexport.CmsStaticExportResponseWrapper Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library 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 library 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.
*
* For further information about Alkacon Software GmbH & Co. KG, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.staticexport;
import java.io.IOException;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpServletResponseWrapper;
/**
* Response wrapper for static export requests, required to access the status code of the response.
*
* The {@link org.opencms.loader.I_CmsResourceLoader#export(org.opencms.file.CmsObject, org.opencms.file.CmsResource, javax.servlet.http.HttpServletRequest, HttpServletResponse)}
* method is called by the static export manager. Many implementations set the http status codes for the response.
* This wrapper enables the export manager to return the status code set on the response
* in {@link org.opencms.staticexport.CmsStaticExportManager#export(javax.servlet.http.HttpServletRequest, HttpServletResponse, org.opencms.file.CmsObject, CmsStaticExportData)}.
*
* @since 6.0.0
*/
public class CmsStaticExportResponseWrapper extends HttpServletResponseWrapper {
/** The status code. */
protected int m_status;
/**
* Creates a new export response wrapper.
*
* @param res the original response to wrap
*/
public CmsStaticExportResponseWrapper(HttpServletResponse res) {
super(res);
m_status = -1;
}
/**
* Returns the status code of this export response, if no status code was set so far,
* -1 is returned.
*
* @return the status code of this export response
*/
@Override
public int getStatus() {
return m_status;
}
/**
* @see javax.servlet.http.HttpServletResponse#sendError(int)
*/
@Override
public void sendError(int status) throws IOException {
m_status = status;
super.sendError(status);
}
/**
* @see javax.servlet.http.HttpServletResponse#sendError(int, java.lang.String)
*/
@Override
public void sendError(int status, String message) throws IOException {
m_status = status;
super.sendError(status, message);
}
/**
* @see javax.servlet.http.HttpServletResponseWrapper#setStatus(int)
*/
@Override
public void setStatus(int status) {
m_status = status;
super.setStatus(status);
}
/**
* @see javax.servlet.http.HttpServletResponseWrapper#setStatus(int, java.lang.String)
*/
@Override
public void setStatus(int status, String message) {
m_status = status;
super.setStatus(status, message);
}
}