com.vaadin.flow.internal

Class ResponseWriter

java.lang.Object

com.vaadin.flow.internal.ResponseWriter

All Implemented Interfaces:

Serializable

public class ResponseWriter
extends Object
implements Serializable

The class that handles writing the response data into the response.

For internal use only. May be renamed or removed in a future release.

Since:

1.0.

Author:

Vaadin Ltd

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ResponseWriter() Deprecated. Use ResponseWriter(DeploymentConfiguration) instead.
ResponseWriter(DeploymentConfiguration deploymentConfiguration) Create a response writer with the given deployment configuration.
ResponseWriter(int bufferSize) Deprecated. This constructor is never used internally and might be removed.

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptsBrotliResource(HttpServletRequest request) Returns whether it is ok to serve a Brotli version of the given resource.
protected boolean	acceptsGzippedResource(HttpServletRequest request) Returns whether it is ok to serve a gzipped version of the given resource.
void	writeResponseContents(String filenameWithPath, URL resourceUrl, HttpServletRequest request, HttpServletResponse response) Writes the contents and content type (if available) of the given resourceUrl to the response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResponseWriter

@Deprecated
public ResponseWriter()

Deprecated. Use ResponseWriter(DeploymentConfiguration) instead.

Create a response writer with buffer size equal to DEFAULT_BUFFER_SIZE.

ResponseWriter

@Deprecated
public ResponseWriter(int bufferSize)

Deprecated. This constructor is never used internally and might be removed.

Creates a response writer with custom buffer size.

This will always mark us as compatibility mode and not accept loading resources from the classpath. To enable compressed resources use ResponseWriter(DeploymentConfiguration).

Parameters:

bufferSize - custom buffer size

ResponseWriter

public ResponseWriter(DeploymentConfiguration deploymentConfiguration)

Create a response writer with the given deployment configuration.

Parameters:

deploymentConfiguration - the deployment configuration to use, not null

Method Detail

writeResponseContents

public void writeResponseContents(String filenameWithPath,
                                  URL resourceUrl,
                                  HttpServletRequest request,
                                  HttpServletResponse response)
                           throws IOException

Writes the contents and content type (if available) of the given resourceUrl to the response.

WARNING: note that this should not be used for a resourceUrl that represents a directory! For security reasons, the directory contents should not be ever written into the response, and the implementation which is used for setting the content length relies on URLConnection.getContentLengthLong() method which returns incorrect values for directories.

Parameters:

filenameWithPath - the name of the file being sent

resourceUrl - the URL to the file, reported by the servlet container

request - the request object to read from

response - the response object to write to

Throws:

IOException - if the servlet container threw an exception while locating the resource

acceptsGzippedResource

protected boolean acceptsGzippedResource(HttpServletRequest request)

Returns whether it is ok to serve a gzipped version of the given resource.

If this method returns true, the browser is ok with receiving a gzipped version of the resource. In other cases, an uncompressed file must be sent.

Parameters:

request - the request for the resource

Returns:

true if the servlet should attempt to serve a gzipped version of the resource, false otherwise

acceptsBrotliResource

protected boolean acceptsBrotliResource(HttpServletRequest request)

Returns whether it is ok to serve a Brotli version of the given resource.

If this method returns true, the browser is ok with receiving a Brotli version of the resource. In other cases, an uncompressed or gzipped file must be sent.

Parameters:

request - the request for the resource

Returns:

true if the servlet should attempt to serve a Brotli version of the resource, false otherwise