Package com.github.fmjsjx.libnetty.http.server.middleware

Class ServeStatic.Options

java.lang.Object

com.github.fmjsjx.libnetty.http.server.middleware.ServeStatic.Options

Enclosing class:

ServeStatic

public static class ServeStatic.Options
extends java.lang.Object

The options of ServeStatic.

Since:

1.1

Constructor Summary

Constructors

Constructor	Description
Options()

Method Summary

Modifier and Type	Method	Description
ServeStatic.Options	addHeaders(java.util.function.Consumer<io.netty.handler.codec.http.HttpHeaders> addHeaders)	Set the function set custom headers on response.
ServeStatic.Options	cacheControl(java.lang.String cacheControl)	Set cacheControl.
ServeStatic.Options	etag(boolean etag)	Set if E-TAG is enabled or not.
ServeStatic.Options	etagGenerator(ServeStatic.EtagGenerator etagGenerator)	Set the function to generate E-TAGs.
ServeStatic.Options	index(java.lang.String index)	Set index.
ServeStatic.Options	indexes(java.lang.String... indexes)	Set multiply indexes.
ServeStatic.Options	lastModified(boolean lastModified)	Set if header last-modified is enabled or not.
ServeStatic.Options	redirectDirectory(boolean redirectDirectory)	Set if redirect to trailing "/" when the pathname is a directory or not.
ServeStatic.Options	showHidden()	Allow clients to access hidden files.
ServeStatic.Options	showHidden(boolean showHidden)	Set if clients are allowed to access hidden files.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Options

public Options()

Method Detail

index

public ServeStatic.Options index(java.lang.String index)

Set index.

Parameters:

index - the filename of the index

Returns:

this Options

indexes

public ServeStatic.Options indexes(java.lang.String... indexes)

Set multiply indexes.

Parameters:

indexes - the array contains the filenames of the indexes

Returns:

this Options

showHidden

public ServeStatic.Options showHidden()

Allow clients to access hidden files.

The default is false.

Returns:

this Options

showHidden

public ServeStatic.Options showHidden(boolean showHidden)

Set if clients are allowed to access hidden files.

The default is false.

Parameters:

showHidden - true to allow clients to access hidden files

Returns:

this Options

redirectDirectory

public ServeStatic.Options redirectDirectory(boolean redirectDirectory)

Set if redirect to trailing "/" when the pathname is a directory or not.

The default is true.

Parameters:

redirectDirectory - false to disable

Returns:

this Options

cacheControl

public ServeStatic.Options cacheControl(java.lang.String cacheControl)

Set cacheControl.

The default is "no-cache".

Parameters:

cacheControl - the value of the cache-control

Returns:

this Options

etag

public ServeStatic.Options etag(boolean etag)

Set if E-TAG is enabled or not.

The default is true.

Parameters:

etag - false to disable E-TEG feature

Returns:

this Options

etagGenerator

public ServeStatic.Options etagGenerator(ServeStatic.EtagGenerator etagGenerator)

Set the function to generate E-TAGs.

The default is ServeStatic.EtagGenerator.BASIC.

Parameters:

etagGenerator - the function to generate E-TAGs

Returns:

this Options

lastModified

public ServeStatic.Options lastModified(boolean lastModified)

Set if header last-modified is enabled or not.

The default is true.

Parameters:

lastModified - false to disable last-modified header

Returns:

this Options

addHeaders

public ServeStatic.Options addHeaders(java.util.function.Consumer<io.netty.handler.codec.http.HttpHeaders> addHeaders)

Set the function set custom headers on response.

Parameters:

addHeaders - the function set custom headers on response

Returns:

this Options

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object