Module io.helidon.webserver

Package io.helidon.webserver

Class StaticContentSupport

java.lang.Object

io.helidon.webserver.StaticContentSupport

All Implemented Interfaces:

Service

@Deprecated(since="2.3.0",
            forRemoval=true)
public class StaticContentSupport
extends Object
implements Service

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

please use module helidon-webserver-static-content

Serves 'static content' (files) from filesystem or using a classloader to the WebServer Routing. 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	Class	Description
static class	StaticContentSupport.Builder	Deprecated, for removal: This API element is subject to removal in a future version. Fluent builder of the StaticContent detailed parameters.

Method Summary

Modifier and Type	Method	Description
static StaticContentSupport.Builder	builder(String resourceRoot)	Deprecated, for removal: This API element is subject to removal in a future version. Creates new builder with defined static content root as a class-loader resource.
static StaticContentSupport.Builder	builder(String resourceRoot, ClassLoader classLoader)	Deprecated, for removal: This API element is subject to removal in a future version. Creates new builder with defined static content root as a class-loader resource.
static StaticContentSupport.Builder	builder(Path root)	Deprecated, for removal: This API element is subject to removal in a future version. Creates new builder with defined static content root as a path to the file system.
static StaticContentSupport	create(String resourceRoot)	Deprecated, for removal: This API element is subject to removal in a future version. Creates new instance with defined static content root as a class-loader resource.
static StaticContentSupport	create(String resourceRoot, ClassLoader classLoader)	Deprecated, for removal: This API element is subject to removal in a future version. Creates new instance with defined static content root as a class-loader resource.
static StaticContentSupport	create(Path root)	Deprecated, for removal: This API element is subject to removal in a future version. Creates new instance with defined static content root as a path to the file system.
void	update(Routing.Rules routing)	Deprecated, for removal: This API element is subject to removal in a future version. Updates Routing.Rules with handlers representing this service.

Methods inherited from class java.lang.Object

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

Method Detail

update

public void update(Routing.Rules routing)

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

Description copied from interface: Service

Updates Routing.Rules with handlers representing this service.

Specified by:

update in interface Service

Parameters:

routing - a routing rules to update

builder

public static StaticContentSupport.Builder builder(String resourceRoot)

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

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

public static StaticContentSupport.Builder builder(String resourceRoot,
                                                   ClassLoader classLoader)

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

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

public static StaticContentSupport.Builder builder(Path root)

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

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

public static StaticContentSupport create(String resourceRoot)

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

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

public static StaticContentSupport create(String resourceRoot,
                                          ClassLoader classLoader)

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

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

public static StaticContentSupport create(Path root)

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

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