Module io.helidon.webserver.staticcontent

Package io.helidon.webserver.staticcontent

Interface StaticContentService

All Superinterfaces:

HttpService, ServerLifecycle

@Deprecated(forRemoval=true,
            since="4.1.5")
public interface StaticContentService
extends HttpService

Deprecated, for removal: This API element is subject to removal in a future version.

static content has been refactored to use server feature, with a new service, using new configuration approach, use StaticContentFeature instead, or if specific services are desired, kindly use StaticContentFeature.createService(ClasspathHandlerConfig) and/or StaticContentFeature.createService(FileSystemHandlerConfig)

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>>	Deprecated, for removal: This API element is subject to removal in a future version. replaced with FileSystemHandlerConfig and ClasspathHandlerConfig
static class	StaticContentService.ClassPathBuilder	Deprecated, for removal: This API element is subject to removal in a future version. Builder for class path based static content.
static class	StaticContentService.FileBasedBuilder<T extends StaticContentService.FileBasedBuilder<T>>	Deprecated, for removal: This API element is subject to removal in a future version. Builder for file based static content supports, such as file based and classpath based.
static class	StaticContentService.FileSystemBuilder	Deprecated, for removal: This API element is subject to removal in a future version. Builder for file system based static content.

Method Summary

Modifier and Type	Method	Description
static StaticContentService.ClassPathBuilder	builder(String resourceRoot)	Deprecated, for removal: This API element is subject to removal in a future version. use ClasspathHandlerConfig.builder() instead
static StaticContentService.ClassPathBuilder	builder(String resourceRoot, ClassLoader classLoader)	Deprecated, for removal: This API element is subject to removal in a future version. use ClasspathHandlerConfig.builder() instead
static StaticContentService.FileSystemBuilder	builder(Path root)	Deprecated, for removal: This API element is subject to removal in a future version. use FileSystemHandlerConfig.builder() instead
static StaticContentService	create(String resourceRoot)	Deprecated, for removal: This API element is subject to removal in a future version. use ClasspathHandlerConfig.builder() and StaticContentFeature.createService(ClasspathHandlerConfig) instead
static StaticContentService	create(String resourceRoot, ClassLoader classLoader)	Deprecated, for removal: This API element is subject to removal in a future version. use ClasspathHandlerConfig.builder() and StaticContentFeature.createService(ClasspathHandlerConfig) instead
static StaticContentService	create(Path root)	Deprecated, for removal: This API element is subject to removal in a future version. use FileSystemHandlerConfig.builder() and StaticContentFeature.createService(FileSystemHandlerConfig) instead

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

routing

Methods inherited from interface io.helidon.webserver.ServerLifecycle

afterStart, afterStop, beforeStart

Method Details

builder

@Deprecated(forRemoval=true,
            since="4.1.5")
static StaticContentService.ClassPathBuilder builder(String resourceRoot)

Deprecated, for removal: This API element is subject to removal in a future version.

use ClasspathHandlerConfig.builder() instead

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

@Deprecated(forRemoval=true,
            since="4.1.5")
static StaticContentService.ClassPathBuilder builder(String resourceRoot,
 ClassLoader classLoader)

Deprecated, for removal: This API element is subject to removal in a future version.

use ClasspathHandlerConfig.builder() instead

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

@Deprecated(forRemoval=true,
            since="4.1.5")
static StaticContentService.FileSystemBuilder builder(Path root)

Deprecated, for removal: This API element is subject to removal in a future version.

use FileSystemHandlerConfig.builder() instead

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

@Deprecated(forRemoval=true,
            since="4.1.5")
static StaticContentService create(String resourceRoot)

Deprecated, for removal: This API element is subject to removal in a future version.

use ClasspathHandlerConfig.builder() and StaticContentFeature.createService(ClasspathHandlerConfig) instead

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

@Deprecated(forRemoval=true,
            since="4.1.5")
static StaticContentService create(String resourceRoot,
 ClassLoader classLoader)

Deprecated, for removal: This API element is subject to removal in a future version.

use ClasspathHandlerConfig.builder() and StaticContentFeature.createService(ClasspathHandlerConfig) instead

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

@Deprecated(forRemoval=true,
            since="4.1.5")
static StaticContentService create(Path root)

Deprecated, for removal: This API element is subject to removal in a future version.

use FileSystemHandlerConfig.builder() and StaticContentFeature.createService(FileSystemHandlerConfig) instead

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