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

Class ServeStatic

java.lang.Object

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

All Implemented Interfaces:

Middleware, java.util.function.BiFunction<HttpRequestContext,MiddlewareChain,java.util.concurrent.CompletionStage<HttpResult>>

public class ServeStatic
extends java.lang.Object
implements Middleware

A Middleware serves static resources.

Since:

1.1

See Also:

Middleware, MiddlewareChain

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ServeStatic.EtagGenerator	Function to generates E-TAGs.
static class	ServeStatic.Options	The options of ServeStatic.

Constructor Summary

Constructors

Constructor	Description
ServeStatic(ServeStatic.Options options, java.lang.String... pathLocationMappings)	Constructs a new ServeStatic with the multiply locationMappings and the specified ServeStatic.Options.
ServeStatic(java.lang.String path, java.lang.String locationMapping)	Constructs a new ServeStatic with the specified path and locationMapping.
ServeStatic(java.lang.String path, java.lang.String locationMapping, ServeStatic.Options options)	Constructs a new ServeStatic with the specified path, locationMapping and ServeStatic.Options.
ServeStatic(java.lang.String path1, java.lang.String locationMapping1, java.lang.String path2, java.lang.String locationMapping2, ServeStatic.Options options)	Constructs a new ServeStatic with the multiply paths, locationMappings and the specified ServeStatic.Options.
ServeStatic(java.util.LinkedHashMap<java.lang.String,java.lang.String> locationMappings, ServeStatic.Options options)	Constructs a new ServeStatic with the multiply locationMappings and the specified ServeStatic.Options.

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletionStage<HttpResult>	apply(HttpRequestContext ctx, MiddlewareChain next)	Apply this Middleware to the given HttpRequestContext.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.BiFunction

andThen

Methods inherited from interface com.github.fmjsjx.libnetty.http.server.middleware.Middleware

close, onServerClosed

Constructor Detail

ServeStatic

public ServeStatic(java.lang.String path,
                   java.lang.String locationMapping)

Constructs a new ServeStatic with the specified path and locationMapping.

Parameters:

path - the URI prefix path

locationMapping - the location mapping of the resources

ServeStatic

public ServeStatic(java.lang.String path,
                   java.lang.String locationMapping,
                   ServeStatic.Options options)

Constructs a new ServeStatic with the specified path, locationMapping and ServeStatic.Options.

Parameters:

path - the URI prefix path

locationMapping - the location mapping of the resources

options - the options

ServeStatic

public ServeStatic(java.lang.String path1,
                   java.lang.String locationMapping1,
                   java.lang.String path2,
                   java.lang.String locationMapping2,
                   ServeStatic.Options options)

Constructs a new ServeStatic with the multiply paths, locationMappings and the specified ServeStatic.Options.

Parameters:

path1 - the first URI prefix path

locationMapping1 - the first location mapping of the resources

path2 - the second URI prefix path

locationMapping2 - the second location mapping of the resources

options - the options

ServeStatic

public ServeStatic(ServeStatic.Options options,
                   java.lang.String... pathLocationMappings)

Constructs a new ServeStatic with the multiply locationMappings and the specified ServeStatic.Options.

Parameters:

options - the options

pathLocationMappings - the array contains the URI prefix paths and the location mappings, the length of array must be even

ServeStatic

public ServeStatic(java.util.LinkedHashMap<java.lang.String,java.lang.String> locationMappings,
                   ServeStatic.Options options)

Constructs a new ServeStatic with the multiply locationMappings and the specified ServeStatic.Options.

Parameters:

locationMappings - the map contains the URI prefix paths and the location mappings

options - the options

Method Detail

apply

public java.util.concurrent.CompletionStage<HttpResult> apply(HttpRequestContext ctx,
                                                              MiddlewareChain next)

Description copied from interface: Middleware

Apply this Middleware to the given HttpRequestContext.

Specified by:

apply in interface java.util.function.BiFunction<HttpRequestContext,MiddlewareChain,java.util.concurrent.CompletionStage<HttpResult>>

Specified by:

apply in interface Middleware

Parameters:

ctx - the HttpRequestContext object of the current HTTP request

next - the MiddlewareChain for invoking the next Middleware

Returns:

a CompletionStage<HttpResult>