ratpack.file.FileSystemBinding Maven / Gradle / Ivy
/*
* Copyright 2013 the original author or 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 ratpack.file;
import com.google.common.reflect.TypeToken;
import ratpack.api.Nullable;
import ratpack.file.internal.DefaultFileSystemBinding;
import ratpack.util.Types;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Objects;
/**
* A file system binding represents a file system location that is used to resolve relative paths.
*
* Every exchange has a file system binding available via its service, as every Ratpack app has a file system binding.
*
* The file system binding is used by asset serving handlers, among other places.
*
* @see ratpack.handling.Chain#files(ratpack.func.Action)
*/
public interface FileSystemBinding {
/**
* A type token for this type.
*
* @since 1.1
*/
TypeToken TYPE = Types.token(FileSystemBinding.class);
static FileSystemBinding root() {
return of(Paths.get(System.getProperty("user.dir")).getRoot());
}
static FileSystemBinding of(Path path) {
return new DefaultFileSystemBinding(Objects.requireNonNull(path, "path cannot be null"));
}
/**
* The actual point on the filesystem that this binding is bound to.
*
* @return The actual point on the filesystem that this binding is bound to.
*/
Path getFile();
/**
* Creates a file reference relative to the bind point denoted by the given relative path.
*
* Absolute paths are resolved relative to the bind point, not the filesystem root.
*
* @param path The relative path from this binding to the desired file
* @return The file
*/
@Nullable
Path file(String path);
/**
* Construct a new binding by using the given path as a relative path from this bind point.
*
* Absolute paths are resolved relative to the bind point, not the filesystem root.
*
* Prefer using {@link ratpack.handling.Context#file(String)}.
*
* @param path The relative path from this binding to the desired binding
* @return The binding
*/
FileSystemBinding binding(String path);
}