io.muserver.handlers

Class ResourceHandler

java.lang.Object

io.muserver.handlers.ResourceHandler

All Implemented Interfaces:

MuHandler

public class ResourceHandler
extends Object
implements MuHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceHandler.Builder

Constructor Summary

Constructors

Constructor and Description
ResourceHandler(ResourceProviderFactory resourceProviderFactory, String pathToServeFrom, String defaultFile, Map<String,ResourceType> extensionToResourceType, int bufferSizeInBytes)

Method Summary

Modifier and Type	Method and Description
static ResourceHandler.Builder	classpathHandler(String classpathRoot)
static ResourceHandler.Builder	fileHandler(File baseDirectory)
static ResourceHandler.Builder	fileHandler(Path path)
static ResourceHandler.Builder	fileHandler(String directoryPath)
static ResourceHandler.Builder	fileOrClasspath(String fileRootIfExists, String classpathRoot) Creates a resource handler that serves from the file system if the directory exists; otherwise from the class path.
boolean	handle(MuRequest request, MuResponse response)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceHandler

public ResourceHandler(ResourceProviderFactory resourceProviderFactory,
                       String pathToServeFrom,
                       String defaultFile,
                       Map<String,ResourceType> extensionToResourceType,
                       int bufferSizeInBytes)

Method Detail

handle

public boolean handle(MuRequest request,
                      MuResponse response)
               throws Exception

Specified by:

handle in interface MuHandler

Throws:

Exception

fileHandler

public static ResourceHandler.Builder fileHandler(String directoryPath)

fileHandler

public static ResourceHandler.Builder fileHandler(File baseDirectory)

fileHandler

public static ResourceHandler.Builder fileHandler(Path path)

classpathHandler

public static ResourceHandler.Builder classpathHandler(String classpathRoot)

fileOrClasspath

public static ResourceHandler.Builder 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.