com.vaadin.server.BootstrapPageResponse Maven / Gradle / Ivy
/*
* Vaadin Framework 7
*
* 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 java.util.Map;
import org.jsoup.nodes.Document;
import com.vaadin.ui.UI;
/**
* A representation of a bootstrap page being generated. The bootstrap page
* contains of the full DOM of the HTML document as well as the HTTP headers
* that will be included in the corresponding HTTP response.
*
* @author Vaadin Ltd
* @since 7.0.0
*/
public class BootstrapPageResponse extends BootstrapResponse {
private final Map headers;
private final Document document;
/**
* Crate a new bootstrap page response.
*
* @see BootstrapResponse#BootstrapResponse(BootstrapHandler, VaadinRequest,
* VaadinSession, Class)
*
* @param handler
* the bootstrap handler that is firing the event
* @param request
* the Vaadin request for which the bootstrap page should be
* generated
* @param session
* the service session for which the bootstrap page should be
* generated
* @param uiClass
* the class of the UI that will be displayed on the page
* @param document
* the DOM document making up the HTML page
* @param headers
* a map into which header data can be added
* @param uiProvider
* the UI provider for the bootstrap
*/
public BootstrapPageResponse(BootstrapHandler handler,
VaadinRequest request, VaadinSession session,
Class uiClass, Document document,
Map headers, UIProvider uiProvider) {
super(handler, request, session, uiClass, uiProvider);
this.headers = headers;
this.document = document;
}
/**
* Sets a header value that will be added to the HTTP response. If the
* header had already been set, the new value overwrites the previous one.
*
* @see VaadinResponse#setHeader(String, String)
*
* @param name
* the name of the header
* @param value
* the header value
*/
public void setHeader(String name, String value) {
headers.put(name, value);
}
/**
* Properly formats a timestamp as a date in a header that will be included
* in the HTTP response. If the header had already been set, the new value
* overwrites the previous one.
*
* @see #setHeader(String, String)
* @see VaadinResponse#setDateHeader(String, long)
*
* @param name
* the name of the header
* @param timestamp
* the number of milliseconds since epoch
*/
public void setDateHeader(String name, long timestamp) {
headers.put(name, Long.valueOf(timestamp));
}
/**
* Gets the document node representing the root of the DOM hierarchy that
* will be used to generate the HTML page. Changes to the document will be
* reflected in the HTML.
*
* @return the document node
*/
public Document getDocument() {
return document;
}
}