Package org.openremote.container.web.file

Class FileServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

org.openremote.container.web.file.AbstractFileServlet

org.openremote.container.web.file.FileServlet

All Implemented Interfaces:

jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable

public class FileServlet
extends AbstractFileServlet

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.openremote.container.web.file.AbstractFileServlet

AbstractFileServlet.Range, AbstractFileServlet.RedirectException

Field Summary

Fields

Modifier and Type	Field	Description
protected final String[]	alreadyZippedExtensions
static final long	DEFAULT_EXPIRE_SECONDS
protected final boolean	devMode
static final long	EXPIRES_SECONDS_CACHE_JS
protected final Map<String,String>	mimeTypes
protected final Map<String,Integer>	mimeTypesExpireSeconds
protected final String[]	requiredRoles
protected final io.undertow.server.handlers.resource.ResourceManager	resourceManager

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
FileServlet(boolean devMode, io.undertow.server.handlers.resource.ResourceManager resourceManager, String[] requiredRoles, Map<String,String> mimeTypes, Map<String,Integer> mimeTypesExpireSeconds, String[] alreadyZippedExtensions)

Method Summary

Modifier and Type	Method	Description
protected String	getContentType(jakarta.servlet.http.HttpServletRequest request, String fileName)	Returns the content type associated with the given HTTP servlet request and file.
protected long	getExpireTime(jakarta.servlet.http.HttpServletRequest request, String fileName)	Returns how long the resource may be cached by the client before it expires, in seconds.
protected String	getExtension(String fileName)
protected Resource	getResource(jakarta.servlet.http.HttpServletRequest request)	Returns the file associated with the given HTTP servlet request.
boolean	isSecured()
protected void	service(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
protected String	setContentHeaders(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Resource resource, List<AbstractFileServlet.Range> ranges)	Set content headers.

Methods inherited from class org.openremote.container.web.file.AbstractFileServlet

coalesce, doGet, doHead, handleFileNotFound, setCacheHeaders, setNoCacheHeaders, stream, stream

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doOptions, doPost, doPut, doTrace, getLastModified, init, service

Methods inherited from class jakarta.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_EXPIRE_SECONDS

public static final long DEFAULT_EXPIRE_SECONDS

See Also:

• Constant Field Values

EXPIRES_SECONDS_CACHE_JS

public static final long EXPIRES_SECONDS_CACHE_JS

See Also:

• Constant Field Values

devMode

protected final boolean devMode

resourceManager

protected final io.undertow.server.handlers.resource.ResourceManager resourceManager

requiredRoles

protected final String[] requiredRoles

mimeTypes

protected final Map<String,String> mimeTypes

mimeTypesExpireSeconds

protected final Map<String,Integer> mimeTypesExpireSeconds

alreadyZippedExtensions

protected final String[] alreadyZippedExtensions

Constructor Details

FileServlet

public FileServlet(boolean devMode,
 io.undertow.server.handlers.resource.ResourceManager resourceManager,
 String[] requiredRoles,
 Map<String,String> mimeTypes,
 Map<String,Integer> mimeTypesExpireSeconds,
 String[] alreadyZippedExtensions)

Method Details

isSecured

public boolean isSecured()

service

protected void service(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
                throws jakarta.servlet.ServletException,
IOException

Overrides:

service in class jakarta.servlet.http.HttpServlet

Throws:

jakarta.servlet.ServletException

IOException

getResource

protected Resource getResource(jakarta.servlet.http.HttpServletRequest request)
                        throws AbstractFileServlet.RedirectException

Description copied from class: AbstractFileServlet

Returns the file associated with the given HTTP servlet request. If this method throws IllegalArgumentException, then the servlet will return a HTTP 400 error. If this method returns null, or if File.isFile() returns false, then the servlet will invoke AbstractFileServlet.handleFileNotFound(HttpServletRequest, HttpServletResponse).

Specified by:

getResource in class AbstractFileServlet

Parameters:

request - The involved HTTP servlet request.

Returns:

The Resource associated with the given HTTP servlet request.

Throws:

AbstractFileServlet.RedirectException

getExpireTime

protected long getExpireTime(jakarta.servlet.http.HttpServletRequest request,
 String fileName)

Description copied from class: AbstractFileServlet

Returns how long the resource may be cached by the client before it expires, in seconds.

The default implementation returns 30 days in seconds.

Overrides:

getExpireTime in class AbstractFileServlet

Parameters:

request - The involved HTTP servlet request.

fileName - The involved file name.

Returns:

The client cache expire time in seconds (not milliseconds!).

getContentType

protected String getContentType(jakarta.servlet.http.HttpServletRequest request,
 String fileName)

Description copied from class: AbstractFileServlet

Returns the content type associated with the given HTTP servlet request and file.

The default implementation delegates File.getName() to ServletContext.getMimeType(String) with a fallback default value of application/octet-stream.

Overrides:

getContentType in class AbstractFileServlet

Parameters:

request - The involved HTTP servlet request.

fileName - The involved file name.

Returns:

The content type associated with the given HTTP servlet request and file.

setContentHeaders

protected String setContentHeaders(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 Resource resource,
 List<AbstractFileServlet.Range> ranges)

Description copied from class: AbstractFileServlet

Set content headers.

Overrides:

setContentHeaders in class AbstractFileServlet

getExtension

protected String getExtension(String fileName)