io.inverno.mod.boot.internal.resource.FileResourceProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of inverno-boot Show documentation
Inverno boot module
There is a newer version: 1.11.0
/*
 * Copyright 2020 Jeremy KUHN
 *
 * 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.inverno.mod.boot.internal.resource;

import io.inverno.core.annotation.Bean;
import io.inverno.core.annotation.Bean.Visibility;
import io.inverno.mod.base.resource.AbstractResourceProvider;
import io.inverno.mod.base.resource.AsyncResourceProvider;
import io.inverno.mod.base.resource.FileResource;
import io.inverno.mod.base.resource.MediaTypeService;
import io.inverno.mod.base.resource.ResourceException;
import io.inverno.mod.base.resource.ResourceProvider;
import io.inverno.mod.base.resource.ResourceService;
import java.net.URI;
import java.util.Set;
import java.util.stream.Stream;

/**
 * 
 * {@link ResourceProvider} implementation used to resolve resources on the
 * file system (ie. {@code file:/path/to/resource}).
 * 
 * 
 * 
 * This implementation supports path patterns and can then resolve multiple
 * resources matching a given URI pattern.
 * 
 * 
 * {@code
 * FileResourceProvider provider = new FileResourceProvider();
 * 
 * // Returns: /path/test1/a, /path/test1/a/b, /path/test2/c...
 * Stream resources = provider.getResources(URI.create("file:/path/test?/{@literal **}/*");
 * }
 * 
 * @author Jeremy Kuhn
 * @since 1.0
 * 
 * @see FileResource
 * @see AsyncResourceProvider
 * @see ResourceService
 * @see PathPatternResolver
 */
@Bean(visibility = Visibility.PRIVATE)
public class FileResourceProvider extends AbstractResourceProvider implements AsyncResourceProvider {

	@Override
	public void setMediaTypeService(MediaTypeService mediaTypeService) {
		super.setMediaTypeService(mediaTypeService);
	}
	
	@Override
	public FileResource getResource(URI uri) throws NullPointerException, IllegalArgumentException, ResourceException {
		return new FileResource(uri, this.mediaTypeService);
	}
	
	@Override
	public Stream getResources(URI uri) throws NullPointerException, IllegalArgumentException, ResourceException {
		String pathPattern = FileResource.checkUri(uri).getPath();
		return PathPatternResolver.resolve(pathPattern, path -> new FileResource(path.toUri(), this.mediaTypeService));
	}
	
	@Override
	public Set getSupportedSchemes() {
		return Set.of(FileResource.SCHEME_FILE);
	}
}