org.frameworkset.util.io.VfsResource Maven / Gradle / Ivy
Show all versions of bboss-util Show documentation
/*
* Copyright 2002-2018 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
*
* https://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 org.frameworkset.util.io;
import org.frameworkset.util.VfsUtils;
import org.frameworkset.util.annotations.Nullable;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.net.URL;
/**
* JBoss VFS based {@link Resource} implementation.
*
* As of Spring 4.0, this class supports VFS 3.x on JBoss AS 6+
* (package {@code org.jboss.vfs}) and is in particular compatible with
* JBoss AS 7 and WildFly 8+.
*
* @author Ales Justin
* @author Juergen Hoeller
* @author Costin Leau
* @author Sam Brannen
* @since 3.0
*/
public class VfsResource extends AbstractResource {
private final Object resource;
/**
* Create a new {@code VfsResource} wrapping the given resource handle.
* @param resource a {@code org.jboss.vfs.VirtualFile} instance
* (untyped in order to avoid a static dependency on the VFS API)
*/
public VfsResource(Object resource) {
org.frameworkset.util.Assert.notNull(resource, "VirtualFile must not be null");
this.resource = resource;
}
@Override
public InputStream getInputStream() throws IOException {
return VfsUtils.getInputStream(this.resource);
}
@Override
public boolean exists() {
return VfsUtils.exists(this.resource);
}
@Override
public boolean isReadable() {
return VfsUtils.isReadable(this.resource);
}
@Override
public URL getURL() throws IOException {
try {
return VfsUtils.getURL(this.resource);
}
catch (Exception ex) {
throw new NestedIOException("Failed to obtain URL for file " + this.resource, ex);
}
}
@Override
public URI getURI() throws IOException {
try {
return VfsUtils.getURI(this.resource);
}
catch (Exception ex) {
throw new NestedIOException("Failed to obtain URI for " + this.resource, ex);
}
}
@Override
public File getFile() throws IOException {
return VfsUtils.getFile(this.resource);
}
@Override
public long contentLength() throws IOException {
return VfsUtils.getSize(this.resource);
}
@Override
public long lastModified() throws IOException {
return VfsUtils.getLastModified(this.resource);
}
@Override
public Resource createRelative(String relativePath) throws IOException {
if (!relativePath.startsWith(".") && relativePath.contains("/")) {
try {
return new VfsResource(VfsUtils.getChild(this.resource, relativePath));
}
catch (IOException ex) {
// fall back to getRelative
}
}
return new VfsResource(VfsUtils.getRelative(new URL(getURL(), relativePath)));
}
@Override
public String getFilename() {
return VfsUtils.getName(this.resource);
}
@Override
public String getDescription() {
return "VFS resource [" + this.resource + "]";
}
@Override
public boolean equals(@Nullable Object other) {
return (this == other || (other instanceof VfsResource &&
this.resource.equals(((VfsResource) other).resource)));
}
@Override
public int hashCode() {
return this.resource.hashCode();
}
}