com.vaadin.server.VaadinServletResponse Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.server;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpServletResponseWrapper;
/**
* Wrapper for {@link HttpServletResponse}.
*
* @author Vaadin Ltd.
* @since 7.0
*
* @see VaadinResponse
* @see VaadinServletRequest
*/
public class VaadinServletResponse extends HttpServletResponseWrapper
implements VaadinResponse {
private final VaadinServletService vaadinService;
/**
* Wraps a http servlet response and an associated vaadin service.
*
* @param response
* the http servlet response to wrap
* @param vaadinService
* the associated vaadin service
*/
public VaadinServletResponse(HttpServletResponse response,
VaadinServletService vaadinService) {
super(response);
this.vaadinService = vaadinService;
}
/**
* Gets the original unwrapped HttpServletResponse.
*
* @return the unwrapped response
*/
public HttpServletResponse getHttpServletResponse() {
return this;
}
@Override
public void setCacheTime(long milliseconds) {
doSetCacheTime(this, milliseconds);
}
/**
* Perform the logic of {@link #setCacheTime(long)}.
*
* Warning: this is an internal function. It has been made public in
* Vaadin 8.20.0 to allow for internal extensions.
*/
public static void doSetCacheTime(VaadinResponse response, long milliseconds) {
if (milliseconds <= 0) {
response.setHeader("Cache-Control", "no-cache");
response.setHeader("Pragma", "no-cache");
response.setDateHeader("Expires", 0);
} else {
response.setHeader("Cache-Control",
"max-age=" + milliseconds / 1000);
response.setDateHeader("Expires",
System.currentTimeMillis() + milliseconds);
// Required to apply caching in some Tomcats
response.setHeader("Pragma", "cache");
}
}
@Override
public VaadinServletService getService() {
return vaadinService;
}
/**
* Gets the currently processed Vaadin servlet response. The current
* response is automatically defined when the request is started. The
* current response can not be used in e.g. background threads because of
* the way server implementations reuse response instances.
*
* @return the current Vaadin servlet response instance if available,
* otherwise null
* @since 8.1
*/
public static VaadinServletResponse getCurrent() {
VaadinResponse currentResponse = VaadinResponse.getCurrent();
if (currentResponse instanceof VaadinServletResponse) {
return (VaadinServletResponse) currentResponse;
} else {
return null;
}
}
}