Module io.helidon.webserver.staticcontent

Package io.helidon.webserver.staticcontent

Interface StaticContentService

All Superinterfaces:

HttpService, ServerLifecycle

public interface StaticContentService
extends HttpService

Serves 'static content' (files) from filesystem or using a classloader to the WebServer HttpRouting. It is possible to register it on the routing.

 // Serve content of attached '/static/pictures' on '/pics'
 Routing.builder()
        .register("/pics", StaticContentSupport.create("/static/pictures"))
        .build()
 

Content is served ONLY on HTTP GET method.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	StaticContentService.Builder<B extends StaticContentService.Builder<B>>	Fluent builder of the StaticContent detailed parameters.
static class	StaticContentService.ClassPathBuilder	Builder for class path based static content.
static class	StaticContentService.FileBasedBuilder<T extends StaticContentService.FileBasedBuilder<T>>	Builder for file based static content supports, such as file based and classpath based.
static class	StaticContentService.FileSystemBuilder	Builder for file system based static content.

Method Summary

Static Methods

Modifier and Type	Method	Description
static StaticContentService.ClassPathBuilder	builder(String resourceRoot)	Creates new builder with defined static content root as a class-loader resource.
static StaticContentService.ClassPathBuilder	builder(String resourceRoot, ClassLoader classLoader)	Creates new builder with defined static content root as a class-loader resource.
static StaticContentService.FileSystemBuilder	builder(Path root)	Creates new builder with defined static content root as a path to the file system.
static StaticContentService	create(String resourceRoot)	Creates new instance with defined static content root as a class-loader resource.
static StaticContentService	create(String resourceRoot, ClassLoader classLoader)	Creates new instance with defined static content root as a class-loader resource.
static StaticContentService	create(Path root)	Creates new instance with defined static content root as a path to the file system.

Methods inherited from interface io.helidon.webserver.http.HttpService

routing

Methods inherited from interface io.helidon.webserver.ServerLifecycle

afterStop, beforeStart

Method Details

builder

static StaticContentService.ClassPathBuilder builder(String resourceRoot)

Creates new builder with defined static content root as a class-loader resource. Builder provides ability to define more advanced configuration.

Current context classloader is used to load static content.

Parameters:

resourceRoot - a root resource path.

Returns:

a builder

Throws:

NullPointerException - if resourceRoot attribute is null

builder

static StaticContentService.ClassPathBuilder builder(String resourceRoot,
 ClassLoader classLoader)

Creates new builder with defined static content root as a class-loader resource. Builder provides ability to define more advanced configuration.

Parameters:

resourceRoot - a root resource path.

classLoader - a class-loader for the static content

Returns:

a builder

Throws:

NullPointerException - if resourceRoot attribute is null

builder

static StaticContentService.FileSystemBuilder builder(Path root)

Creates new builder with defined static content root as a path to the file system. Builder provides ability to define more advanced configuration.

Parameters:

root - a root path.

Returns:

a builder

Throws:

NullPointerException - if root attribute is null

create

static StaticContentService create(String resourceRoot)

Creates new instance with defined static content root as a class-loader resource.

Current context classloader is used to load static content.

Parameters:

resourceRoot - a root resource path.

Returns:

created instance

Throws:

NullPointerException - if resourceRoot attribute is null

create

static StaticContentService create(String resourceRoot,
 ClassLoader classLoader)

Creates new instance with defined static content root as a class-loader resource.

Parameters:

resourceRoot - a root resource path.

classLoader - a class-loader for the static content

Returns:

created instance

Throws:

NullPointerException - if resourceRoot attribute is null

create

static StaticContentService create(Path root)

Creates new instance with defined static content root as a path to the file system.

Parameters:

root - a root path.

Returns:

created instance

Throws:

NullPointerException - if root attribute is null