org.apache.catalina.ssi.ResponseIncludeWrapper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 2004 The Apache Software Foundation
*
* 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.
*/
// Portions Copyright [2019-2021] Payara Foundation and/or affiliates
package org.apache.catalina.ssi;
import jakarta.servlet.ServletContext;
import jakarta.servlet.ServletOutputStream;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.servlet.http.HttpServletResponseWrapper;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.text.SimpleDateFormat;
import java.util.Locale;
import java.util.TimeZone;
/**
* A HttpServletResponseWrapper, used from
* SSIServletExternalResolver
*
* @author Bip Thelin
* @author David Becker
* @version $Revision: 1.3 $, $Date: 2007/02/13 19:16:20 $
*/
public class ResponseIncludeWrapper extends HttpServletResponseWrapper {
/**
* The names of some headers we want to capture.
*/
private static final String CONTENT_TYPE = "content-type";
private static final String LAST_MODIFIED = "last-modified";
private static final String RFC1123_PATTERN = "EEE, dd MMM yyyy HH:mm:ss z";
private static final ThreadLocal RFC1123_FORMAT =
new ThreadLocal() {
@Override
protected SimpleDateFormat initialValue() {
// rfc 1123 pattern format
SimpleDateFormat f = new SimpleDateFormat(RFC1123_PATTERN, Locale.US);
f.setTimeZone(TimeZone.getTimeZone("GMT"));
return f;
}
};
private final SimpleDateFormat rfc1123Format;
protected long lastModified = -1;
private String contentType = null;
/**
* Our ServletOutputStream
*/
protected ServletOutputStream captureServletOutputStream;
protected ServletOutputStream servletOutputStream;
protected PrintWriter printWriter;
private final ServletContext context;
private final HttpServletRequest request;
/**
* Initialize our wrapper with the current HttpServletResponse and
* ServletOutputStream.
*
* @param context The servlet context
* @param request The HttpServletResponse to use
* @param response The response to use
* @param captureServletOutputStream The ServletOutputStream to use
*/
public ResponseIncludeWrapper(ServletContext context,
HttpServletRequest request, HttpServletResponse response,
ServletOutputStream captureServletOutputStream) {
super(response);
this.context = context;
this.request = request;
this.captureServletOutputStream = captureServletOutputStream;
this.rfc1123Format = RFC1123_FORMAT.get();
}
/**
* Flush the servletOutputStream or printWriter ( only one will be non-null )
* This must be called after a requestDispatcher.include, since we can't
* assume that the included servlet flushed its stream.
*/
public void flushOutputStreamOrWriter() throws IOException {
if (servletOutputStream != null) {
servletOutputStream.flush();
}
if (printWriter != null) {
printWriter.flush();
}
}
/**
* Return a printwriter, throws and exception if a OutputStream already
* been returned.
*
* @return a PrintWriter object
* @exception java.io.IOException
* if the outputstream already been called
*/
@Override
public PrintWriter getWriter() throws java.io.IOException {
if (servletOutputStream == null) {
if (printWriter == null) {
setCharacterEncoding(getCharacterEncoding());
printWriter = new PrintWriter(
new OutputStreamWriter(captureServletOutputStream,
getCharacterEncoding()));
}
return printWriter;
}
throw new IllegalStateException();
}
/**
* Return a OutputStream, throws and exception if a printwriter already
* been returned.
*
* @return a OutputStream object
* @exception java.io.IOException
* if the printwriter already been called
*/
@Override
public ServletOutputStream getOutputStream() throws java.io.IOException {
if (printWriter == null) {
if (servletOutputStream == null) {
servletOutputStream = captureServletOutputStream;
}
return servletOutputStream;
}
throw new IllegalStateException();
}
/**
* Returns the value of the last-modified header field. The
* result is the number of milliseconds since January 1, 1970 GMT.
*
* @return the date the resource referenced by this
* ResponseIncludeWrapper was last modified, or -1 if not
* known.
*/
public long getLastModified() {
if (lastModified == -1) {
// javadocs say to return -1 if date not known, if you want another
// default, put it here
return -1;
}
return lastModified;
}
/**
* Sets the value of the last-modified header field.
*
* @param lastModified The number of milliseconds since January 1, 1970 GMT.
*/
public void setLastModified(long lastModified) {
this.lastModified = lastModified;
((HttpServletResponse) getResponse()).setDateHeader(LAST_MODIFIED,
lastModified);
}
/**
* Returns the value of the content-type header field.
*
* @return the content type of the resource referenced by this
* ResponseIncludeWrapper, or null if not known.
*/
@Override
public String getContentType() {
if (contentType == null) {
String url = request.getRequestURI();
String mime = context.getMimeType(url);
if (mime != null)
{
setContentType(mime);
}
else
{
// return a safe value
setContentType("application/x-octet-stream");
}
}
return contentType;
}
/**
* Sets the value of the content-type header field.
*
* @param mime a mime type
*/
@Override
public void setContentType(String mime) {
contentType = mime;
if (contentType != null) {
getResponse().setContentType(contentType);
}
}
@Override
public void addDateHeader(String name, long value) {
super.addDateHeader(name, value);
String lname = name.toLowerCase(Locale.ENGLISH);
if (lname.equals(LAST_MODIFIED)) {
lastModified = value;
}
}
@Override
public void addHeader(String name, String value) {
super.addHeader(name, value);
String lname = name.toLowerCase(Locale.ENGLISH);
if (lname.equals(LAST_MODIFIED)) {
try {
lastModified = rfc1123Format.parse(value).getTime();
} catch (Throwable ignore) { }
} else if (lname.equals(CONTENT_TYPE)) {
contentType = value;
}
}
@Override
public void setDateHeader(String name, long value) {
super.setDateHeader(name, value);
String lname = name.toLowerCase(Locale.ENGLISH);
if (lname.equals(LAST_MODIFIED)) {
lastModified = value;
}
}
@Override
public void setHeader(String name, String value) {
super.setHeader(name, value);
String lname = name.toLowerCase(Locale.ENGLISH);
if (lname.equals(LAST_MODIFIED)) {
try {
lastModified = rfc1123Format.parse(value).getTime();
} catch (Throwable ignore) { }
}
else if (lname.equals(CONTENT_TYPE))
{
contentType = value;
}
}
}