Package io.micronaut.web.router.resource

Class StaticResourceConfiguration

java.lang.Object

io.micronaut.web.router.resource.StaticResourceConfiguration

All Implemented Interfaces:

Toggleable

@EachProperty("micronaut.router.static-resources")
public class StaticResourceConfiguration
extends Object
implements Toggleable

Stores configuration for the loading of static resources.

Since:

1.0

Author:

James Kleeh

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_ENABLED	The default enable value.
static final String	DEFAULT_MAPPING	The default mapping value.
static final String	PREFIX	The prefix for static resource configuration.

Constructor Summary

Constructors

Constructor	Description
StaticResourceConfiguration(ResourceResolver resourceResolver, @Nullable ServerContextPathProvider contextPathProvider)

Method Summary

Modifier and Type	Method	Description
String	getMapping()	The static resource mapping.
List<ResourceLoader>	getResourceLoaders()
boolean	isEnabled()
void	setEnabled(boolean enabled)	Sets whether this specific mapping is enabled.
void	setMapping(String mapping)	The path resources should be served from.
void	setPaths(List<String> paths)	A list of paths either starting with `classpath:` or `file:`.

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

The prefix for static resource configuration.

See Also:

• Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

• Constant Field Values

DEFAULT_MAPPING

public static final String DEFAULT_MAPPING

The default mapping value.

See Also:

• Constant Field Values

Constructor Details

StaticResourceConfiguration

public StaticResourceConfiguration(ResourceResolver resourceResolver,
 @Nullable
 @Nullable ServerContextPathProvider contextPathProvider)

Parameters:

resourceResolver - The ResourceResolver

contextPathProvider - The context path provider

Method Details

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Toggleable

Returns:

Enable the static resources router

getResourceLoaders

public List<ResourceLoader> getResourceLoaders()

Returns:

The list of ResourceLoader available for the path

getMapping

public String getMapping()

The static resource mapping.

Returns:

The mapping

setEnabled

public void setEnabled(boolean enabled)

Sets whether this specific mapping is enabled. Default value (true).

Parameters:

enabled - True if they are enabled.

setPaths

public void setPaths(List<String> paths)

A list of paths either starting with `classpath:` or `file:`. You can serve files from anywhere on disk or the classpath. For example to serve static resources from `src/main/resources/public`, you would use `classpath:public` as the path.

Parameters:

paths - The paths

setMapping

public void setMapping(String mapping)

The path resources should be served from. Uses ant path matching. Default value ("/**").

Parameters:

mapping - The mapping