io.micronaut.web.router.resource.StaticResourceConfiguration Maven / Gradle / Ivy
/*
* Copyright 2017-2019 original authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.micronaut.web.router.resource;
import io.micronaut.context.annotation.EachProperty;
import io.micronaut.context.exceptions.ConfigurationException;
import io.micronaut.core.io.ResourceLoader;
import io.micronaut.core.io.ResourceResolver;
import io.micronaut.core.util.CollectionUtils;
import io.micronaut.core.util.StringUtils;
import io.micronaut.core.util.Toggleable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
/**
* Stores configuration for the loading of static resources.
*
* @author James Kleeh
* @since 1.0
*/
@EachProperty(StaticResourceConfiguration.PREFIX)
public class StaticResourceConfiguration implements Toggleable {
/**
* The prefix for static resources configuration.
*/
public static final String PREFIX = "micronaut.router.static-resources";
/**
* The default enable value.
*/
@SuppressWarnings("WeakerAccess")
public static final boolean DEFAULT_ENABLED = true;
/**
* The default mapping value.
*/
@SuppressWarnings("WeakerAccess")
public static final String DEFAULT_MAPPING = "/**";
private boolean enabled = DEFAULT_ENABLED;
private List paths = Collections.emptyList();
private String mapping = DEFAULT_MAPPING;
private final ResourceResolver resourceResolver;
/**
* @param resourceResolver The {@linkplain ResourceResolver}
*/
public StaticResourceConfiguration(ResourceResolver resourceResolver) {
this.resourceResolver = resourceResolver;
}
/**
* @return Enable the static resources router
*/
@Override
public boolean isEnabled() {
return enabled;
}
/**
* @return The list of {@link ResourceLoader} available for the path
*/
public List getResourceLoaders() {
if (enabled) {
List loaders = new ArrayList<>(paths.size());
for (String path : paths) {
if (path.equals("classpath:")) {
throw new ConfigurationException("A path value of [classpath:] will allow access to class files!");
}
Optional loader = resourceResolver.getLoaderForBasePath(path);
if (loader.isPresent()) {
loaders.add(loader.get());
} else {
throw new ConfigurationException("Unrecognizable resource path: " + path);
}
}
return loaders;
}
return Collections.emptyList();
}
/**
* The static resource mapping.
* @return The mapping
*/
public String getMapping() {
return mapping;
}
/**
* Sets whether this specific mapping is enabled. Default value ({@value #DEFAULT_ENABLED}).
*
* @param enabled True if they are enabled.
*/
public void setEnabled(boolean enabled) {
this.enabled = enabled;
}
/**
* 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.
*
* @param paths The paths
*/
public void setPaths(List paths) {
if (CollectionUtils.isNotEmpty(paths)) {
this.paths = paths;
}
}
/**
* The path resources should be served from. Uses ant path matching. Default value ({@value #DEFAULT_MAPPING}).
*
* @param mapping The mapping
*/
public void setMapping(String mapping) {
if (StringUtils.isNotEmpty(mapping)) {
this.mapping = mapping;
}
}
}