io.muserver.handlers

Class ResourceHandlerBuilder

java.lang.Object

io.muserver.handlers.ResourceHandlerBuilder

All Implemented Interfaces:

MuHandlerBuilder<ResourceHandler>

public class ResourceHandlerBuilder
extends Object
implements MuHandlerBuilder<ResourceHandler>

Used to create a ResourceHandler for serving static files.

In order to serve from the filesystem during development, and from classpath and deploy time, see fileOrClasspath(String, String)

Constructor Summary

Constructors

Constructor and Description
ResourceHandlerBuilder()

Method Summary

Modifier and Type	Method and Description
ResourceHandler	build() Creates the handler
static ResourceHandlerBuilder	classpathHandler(String classpathRoot) Creates a handler that serves files from the classpath..
static ResourceHandlerBuilder	fileHandler(File baseDirectory) Creates a handler that serves files from the given directory.
static ResourceHandlerBuilder	fileHandler(Path path) Creates a handler that serves files from the given directory.
static ResourceHandlerBuilder	fileHandler(String directoryPath) Creates a handler that serves files from the given directory.
static ResourceHandlerBuilder	fileOrClasspath(String fileRootIfExists, String classpathRoot) Creates a resource handler that serves from the file system if the directory exists; otherwise from the class path.
ResourceHandlerBuilder	withDefaultFile(String defaultFile) Specifies the file to use when a request such as /web/ is made.
ResourceHandlerBuilder	withDirectoryListing(boolean enabled) Specifies whether or not to allow directory listing.
ResourceHandlerBuilder	withDirectoryListingCSS(String css) Specifies CSS to use for the HTML directory listing page, if directory listing is enabled.
ResourceHandlerBuilder	withDirectoryListingDateFormatter(DateTimeFormatter dateTimeFormatter) Specifies a custom date format for the "Last modified" column when directory listing is enabled.
ResourceHandlerBuilder	withExtensionToResourceType(Map<String,ResourceType> extensionToResourceType) Specify custom filename extension to mime-type mappings.
ResourceHandlerBuilder	withPathToServeFrom(String pathToServeFrom) Deprecated. Please use ContextHandlerBuilder.context(pathToServeFrom).addHandler(resourceHandler) instead.
ResourceHandlerBuilder	withResourceCustomizer(ResourceCustomizer resourceCustomizer) Registers a hook to intercept responses, allowing things such as response header customization based on the request.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceHandlerBuilder

public ResourceHandlerBuilder()

Method Detail

withExtensionToResourceType

public ResourceHandlerBuilder withExtensionToResourceType(Map<String,ResourceType> extensionToResourceType)

Specify custom filename extension to mime-type mappings. By default ResourceType.DEFAULT_EXTENSION_MAPPINGS are used.

Parameters:

extensionToResourceType - The mappings to use.

Returns:

This builder

withPathToServeFrom

@Deprecated
public ResourceHandlerBuilder withPathToServeFrom(String pathToServeFrom)

Deprecated. Please use ContextHandlerBuilder.context(pathToServeFrom).addHandler(resourceHandler) instead.

Specifies the path to serve the static from.

Parameters:

pathToServeFrom - A path that static data should be served from. Defaults to /

Returns:

This builder

withDefaultFile

public ResourceHandlerBuilder withDefaultFile(String defaultFile)

Specifies the file to use when a request such as /web/ is made. Defaults to index.html

Parameters:

defaultFile - The default file to use when a directory is requested, or null for no default.

Returns:

This builder

withDirectoryListing

public ResourceHandlerBuilder withDirectoryListing(boolean enabled)

Specifies whether or not to allow directory listing. This is disabled by default.

Note that directory listings will not show if there is a file in the directory that matches the withDefaultFile(String) setting. Set that to null if you do not want the default file (e.g. index.html) to display.

Parameters:

enabled - true to turn it on; false to disable it.

Returns:

This builder

withDirectoryListingDateFormatter

public ResourceHandlerBuilder withDirectoryListingDateFormatter(DateTimeFormatter dateTimeFormatter)

Specifies a custom date format for the "Last modified" column when directory listing is enabled.

Parameters:

dateTimeFormatter - A format object, or null to use the default

Returns:

This builder

withDirectoryListingCSS

public ResourceHandlerBuilder withDirectoryListingCSS(String css)

Specifies CSS to use for the HTML directory listing page, if directory listing is enabled.

Parameters:

css - CSS styles to use, or null for the default

Returns:

This builder

withResourceCustomizer

public ResourceHandlerBuilder withResourceCustomizer(ResourceCustomizer resourceCustomizer)

Registers a hook to intercept responses, allowing things such as response header customization based on the request.

Parameters:

resourceCustomizer - A class to intercept responses

Returns:

This builder

build

public ResourceHandler build()

Creates the handler

Specified by:

build in interface MuHandlerBuilder<ResourceHandler>

Returns:

The built handler

fileHandler

public static ResourceHandlerBuilder fileHandler(String directoryPath)

Creates a handler that serves files from the given directory.

Parameters:

directoryPath - The directory.

Returns:

A new builder.

fileHandler

public static ResourceHandlerBuilder fileHandler(File baseDirectory)

Creates a handler that serves files from the given directory.

Parameters:

baseDirectory - The directory.

Returns:

A new builder.

fileHandler

public static ResourceHandlerBuilder fileHandler(Path path)

Creates a handler that serves files from the given directory.

Parameters:

path - The directory.

Returns:

A new builder.

classpathHandler

public static ResourceHandlerBuilder classpathHandler(String classpathRoot)

Creates a handler that serves files from the classpath..

Parameters:

classpathRoot - A classpath directory, such as /web

Returns:

A new builder.

fileOrClasspath

public static ResourceHandlerBuilder fileOrClasspath(String fileRootIfExists,
                                                     String classpathRoot)

Creates a resource handler that serves from the file system if the directory exists; otherwise from the class path.

A common use case is for when you want to serve from the file path at development time (so you can update files without restarting) but at deploy time resources are packaged in an uber jar.

Parameters:

fileRootIfExists - A path to a directory holding static content, which may not exist, e.g. src/main/resources/web

classpathRoot - A classpath path to a directory holding static content, e.g. /web

Returns:

Returns a file-based resource handler builder or a classpath-based one.