express.middleware

Class FileProviderOptions

java.lang.Object

express.middleware.FileProviderOptions

public class FileProviderOptions
extends Object

Author:

Simon R.

Options-Class for FileProvider

Constructor Summary

Constructors

Constructor and Description
FileProviderOptions()

Method Summary

Modifier and Type	Method and Description
DotFiles	getDotFiles()
String[]	getExtensions()
long	getMaxAge()
boolean	isFallBackSearching()
boolean	isLastModified()
void	setDotFiles(DotFiles dotFiles) Set how ".foo" file will be handled.
FileProviderOptions	setExtensions(String... extensions) Set the extension from the file which can be accessed outside.
FileProviderOptions	setFallBackSearching(boolean fallBackSearching) Activate the fallback-search.
FileProviderOptions	setHandler(HttpRequestHandler handler) Add an alternate request-handler which will be fired before the file will be send.
FileProviderOptions	setLastModified(boolean lastModified) Set the Last-Modified header to the last modified date of the file on the OS.
FileProviderOptions	setMaxAge(long maxAge) Set the max-age property of the Cache-Control header in milliseconds or a string in ms format.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileProviderOptions

public FileProviderOptions()

Method Detail

getExtensions

public String[] getExtensions()

Returns:

The current allowed extensions.

setExtensions

public FileProviderOptions setExtensions(String... extensions)

Set the extension from the file which can be accessed outside. By default all extensions are allowed.

Parameters:

extensions - The extensions.

Returns:

This instance.

isFallBackSearching

public boolean isFallBackSearching()

Returns:

If the fallback-search is activated.

setFallBackSearching

public FileProviderOptions setFallBackSearching(boolean fallBackSearching)

Activate the fallback-search. E.g. if an request to /js/code.js was made but the requested resource cannot be found. It will be looked for an file called code and return it.

Default is false.

Parameters:

fallBackSearching - If you want to activate the file-fallback-search.

Returns:

This instance.

isLastModified

public boolean isLastModified()

Returns:

If the last modified date of the file on the OS will be send.

setLastModified

public FileProviderOptions setLastModified(boolean lastModified)

Set the Last-Modified header to the last modified date of the file on the OS. Default is true.

Parameters:

lastModified - If you want to send the last modified date of the file on the OS.

Returns:

This instance.

getMaxAge

public long getMaxAge()

Returns:

The current maxAge of of the Cache-Control header.

setMaxAge

public FileProviderOptions setMaxAge(long maxAge)

Set the max-age property of the Cache-Control header in milliseconds or a string in ms format.

Default is 0.

Parameters:

maxAge - The new maxAge value.

Returns:

This instance.

setHandler

public FileProviderOptions setHandler(HttpRequestHandler handler)

Add an alternate request-handler which will be fired before the file will be send.

Parameters:

handler - The HttpRequest handler.

Returns:

This instance.

getDotFiles

public DotFiles getDotFiles()

Returns:

How Dot-files will be currently handled.

setDotFiles

public void setDotFiles(DotFiles dotFiles)

Set how ".foo" file will be handled. Ignore: Act if these files don't exists, response with 404 Deny: Deny the file, response with 303 and do nothing. Allow: No special treatment for this files.

Parameters:

dotFiles - The handling type.