org.jboss.virtual.VFS Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
* Copyright 2006, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.virtual;
import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.List;
import org.jboss.logging.Logger;
import org.jboss.virtual.plugins.vfs.helpers.WrappingVirtualFileHandlerVisitor;
import org.jboss.virtual.spi.ExceptionHandler;
import org.jboss.virtual.spi.VFSContext;
import org.jboss.virtual.spi.VFSContextFactory;
import org.jboss.virtual.spi.VFSContextFactoryLocator;
import org.jboss.virtual.spi.VirtualFileHandler;
import org.jboss.virtual.spi.TempStore;
import org.jboss.virtual.spi.registry.VFSRegistry;
/**
* Virtual File System
*
* @author Adrian Brock
* @author [email protected]
* @author Ales Justin
* @version $Revision: 1.1 $
*/
public class VFS
{
/** The log */
private static final Logger log = Logger.getLogger(VFS.class);
/** The VFS Context */
private final VFSContext context;
static
{
init();
}
/**
* Create a new VFS.
*
* @param context the context
* @throws IllegalArgumentException for a null context
*/
public VFS(VFSContext context)
{
if (context == null)
throw new IllegalArgumentException("Null name");
this.context = context;
}
/**
* Initialize VFS protocol handlers package property.
*/
@SuppressWarnings({"deprecation", "unchecked"})
public static void init()
{
String pkgs = System.getProperty("java.protocol.handler.pkgs");
if (pkgs == null || pkgs.trim().length() == 0)
{
pkgs = "org.jboss.virtual.protocol";
System.setProperty("java.protocol.handler.pkgs", pkgs);
}
else if (!pkgs.contains("org.jboss.virtual.protocol"))
{
pkgs += "|org.jboss.virtual.protocol";
System.setProperty("java.protocol.handler.pkgs", pkgs);
}
org.jboss.virtual.plugins.context.VfsArchiveBrowserFactory factory = org.jboss.virtual.plugins.context.VfsArchiveBrowserFactory.INSTANCE;
// keep this until AOP and HEM uses VFS internally instead of the stupid ArchiveBrowser crap.
org.jboss.util.file.ArchiveBrowser.factoryFinder.put("vfsfile", factory);
org.jboss.util.file.ArchiveBrowser.factoryFinder.put("vfszip", factory);
org.jboss.util.file.ArchiveBrowser.factoryFinder.put("vfsjar", factory);
org.jboss.util.file.ArchiveBrowser.factoryFinder.put("vfs", factory);
}
/**
* Get the vfs context.
*
* This is package protected method.
* Same as VirtualFile::getHandler.
*
* @return the vfs context
*/
VFSContext getContext()
{
return context;
}
/**
* Set exception handler.
*
* @param exceptionHandler the exception handler.
*/
public void setExceptionHandler(ExceptionHandler exceptionHandler)
{
context.setExceptionHandler(exceptionHandler);
}
/**
* Set temp store
*
* @param store the temp store
*/
public void setTempStore(TempStore store)
{
context.setTempStore(store);
}
/**
* Cleanup any resources tied to this file.
* e.g. vfs cache
*
* @param file the file
*/
static void cleanup(VirtualFile file)
{
VirtualFileHandler fileHandler = file.getHandler();
VFSContext context = fileHandler.getVFSContext();
try
{
context.cleanupTempInfo(fileHandler.getPathName());
}
catch (Exception e)
{
log.debug("Exception cleaning temp info, file=" + file, e);
}
try
{
VirtualFileHandler contextHandler = context.getRoot();
// the file is the context root, hence possible registry candidate
if (fileHandler.equals(contextHandler))
{
VFSRegistry registry = VFSRegistry.getInstance();
registry.removeContext(context);
TempStore store = context.getTempStore();
if (store != null)
{
store.clear();
}
}
}
catch (Exception e)
{
log.debug("Exception removing cached context, file=" + file, e);
}
}
/**
* Get the virtual file system for a root uri
*
* @param rootURI the root URI
* @return the virtual file system
* @throws IOException if there is a problem accessing the VFS
* @throws IllegalArgumentException if the rootURL is null
*/
public static VFS getVFS(URI rootURI) throws IOException
{
return getVFS(rootURI, false);
}
/**
* Get the virtual file system for a root uri
*
* @param rootURI the root URI
* @param createNew do we create a new context
* @return the virtual file system
* @throws IOException if there is a problem accessing the VFS
* @throws IllegalArgumentException if the rootURL is null
*/
private static VFS getVFS(URI rootURI, boolean createNew) throws IOException
{
VFSContextFactory factory = VFSContextFactoryLocator.getFactory(rootURI);
if (factory == null)
throw new IOException("No context factory for " + rootURI);
VFSRegistry registry = VFSRegistry.getInstance();
VFSContext context = registry.getContext(rootURI);
if (context != null && createNew == false)
return context.getVFS();
if (context != null)
{
registry.removeContext(context);
context.cleanup();
}
context = factory.getVFS(rootURI); // create new
VFSRegistry.getInstance().addContext(context);
return context.getVFS();
}
/**
* Create new root
*
* @param rootURI the root url
* @return the virtual file
* @throws IOException if there is a problem accessing the VFS
* @throws IllegalArgumentException if the rootURL
*/
public static VirtualFile createNewRoot(URI rootURI) throws IOException
{
VFS vfs = getVFS(rootURI, true);
return vfs.getRoot();
}
/**
* Get the root virtual file
*
* @param rootURI the root uri
* @return the virtual file
* @throws IOException if there is a problem accessing the VFS
* @throws IllegalArgumentException if the rootURL is null
*/
public static VirtualFile getRoot(URI rootURI) throws IOException
{
VFSRegistry registry = VFSRegistry.getInstance();
VirtualFile file = registry.getFile(rootURI);
return (file != null) ? file : createNewRoot(rootURI);
}
/**
* Get a virtual file
*
* @param rootURI the root uri
* @param name the path name
* @return the virtual file
* @throws IOException if there is a problem accessing the VFS
* @throws IllegalArgumentException if the rootURL or name is null
*/
@SuppressWarnings("deprecation")
public static VirtualFile getVirtualFile(URI rootURI, String name) throws IOException
{
VirtualFile root = getRoot(rootURI);
return root.findChild(name);
}
private static URI toURI(URL url) throws IOException
{
try
{
return VFSUtils.toURI(url);
}
catch (URISyntaxException e)
{
IOException ioe = new IOException();
ioe.initCause(e);
throw ioe;
}
}
/**
* Get the virtual file system for a root url
*
* @param rootURL the root url
* @return the virtual file system
* @throws IOException if there is a problem accessing the VFS
* @throws IllegalArgumentException if the rootURL is null
*/
public static VFS getVFS(URL rootURL) throws IOException
{
return getVFS(toURI(rootURL));
}
/**
* Create new root
*
* @param rootURL the root url
* @return the virtual file
* @throws IOException if there is a problem accessing the VFS
* @throws IllegalArgumentException if the rootURL
*/
public static VirtualFile createNewRoot(URL rootURL) throws IOException
{
return createNewRoot(toURI(rootURL));
}
/**
* Get the root virtual file
*
* @param rootURL the root url
* @return the virtual file
* @throws IOException if there is a problem accessing the VFS
* @throws IllegalArgumentException if the rootURL
*/
public static VirtualFile getRoot(URL rootURL) throws IOException
{
return getRoot(toURI(rootURL));
}
/**
* Get a virtual file
*
* @param rootURL the root url
* @param name the path name
* @return the virtual file
* @throws IOException if there is a problem accessing the VFS
* @throws IllegalArgumentException if the rootURL or name is null
*/
@SuppressWarnings("deprecation")
public static VirtualFile getVirtualFile(URL rootURL, String name) throws IOException
{
return getVirtualFile(toURI(rootURL), name);
}
/**
* Get the root file of this VFS
*
* @return the root
* @throws IOException for any problem accessing the VFS
*/
public VirtualFile getRoot() throws IOException
{
VirtualFileHandler handler = context.getRoot();
return handler.getVirtualFile();
}
/**
* Find a child from the root
*
* @param path the child path
* @return the child
* @throws IOException for any problem accessing the VFS (including the child does not exist)
* @throws IllegalArgumentException if the path is null
* @deprecated use getChild, and handle null if not found
*/
@Deprecated
public VirtualFile findChild(String path) throws IOException
{
if (path == null)
throw new IllegalArgumentException("Null path");
VirtualFileHandler handler = context.getRoot();
VirtualFileHandler result = context.getChild(handler, VFSUtils.fixName(path));
if (result == null)
{
List children = handler.getChildren(true);
throw new IOException("Child not found " + path + " for " + handler + ", available children: " + children);
}
return result.getVirtualFile();
}
/**
* Get a child
*
* @param path the child path
* @return the child or null if not found
* @throws IOException if a real problem occurs
*/
public VirtualFile getChild(String path) throws IOException
{
if (path == null)
throw new IllegalArgumentException("Null path");
VirtualFileHandler handler = context.getRoot();
VirtualFileHandler result = context.getChild(handler, VFSUtils.fixName(path));
return result != null ? result.getVirtualFile() : null;
}
/**
* Get the children
*
* @return the children
* @throws IOException for any problem accessing the virtual file system
*/
public List getChildren() throws IOException
{
return getRoot().getChildren(null);
}
/**
* Get the children
*
* @param filter to filter the children
* @return the children
* @throws IOException for any problem accessing the virtual file system
*/
public List getChildren(VirtualFileFilter filter) throws IOException
{
return getRoot().getChildren(filter);
}
/**
* Get all the children recursively
*
* This always uses {@link VisitorAttributes#RECURSE}
*
* @return the children
* @throws IOException for any problem accessing the virtual file system
*/
public List getChildrenRecursively() throws IOException
{
return getRoot().getChildrenRecursively(null);
}
/**
* Get all the children recursively
*
* This always uses {@link VisitorAttributes#RECURSE}
*
* @param filter to filter the children
* @return the children
* @throws IOException for any problem accessing the virtual file system
*/
public List getChildrenRecursively(VirtualFileFilter filter) throws IOException
{
return getRoot().getChildrenRecursively(filter);
}
/**
* Visit the virtual file system from the root
*
* @param visitor the visitor
* @throws IOException for any problem accessing the VFS
* @throws IllegalArgumentException if the visitor is null
*/
public void visit(VirtualFileVisitor visitor) throws IOException
{
VirtualFileHandler handler = context.getRoot();
if (handler.isLeaf() == false)
{
WrappingVirtualFileHandlerVisitor wrapper = new WrappingVirtualFileHandlerVisitor(visitor);
context.visit(handler, wrapper);
}
}
/**
* Visit the virtual file system
*
* @param file the file
* @param visitor the visitor
* @throws IOException for any problem accessing the VFS
* @throws IllegalArgumentException if the file or visitor is null
*/
protected void visit(VirtualFile file, VirtualFileVisitor visitor) throws IOException
{
if (file == null)
throw new IllegalArgumentException("Null file");
VirtualFileHandler handler = file.getHandler();
WrappingVirtualFileHandlerVisitor wrapper = new WrappingVirtualFileHandlerVisitor(visitor);
VFSContext handlerContext = handler.getVFSContext();
handlerContext.visit(handler, wrapper);
}
@Override
public String toString()
{
return context.toString();
}
@Override
public int hashCode()
{
return context.hashCode();
}
@Override
public boolean equals(Object obj)
{
if (obj == this)
return true;
if (obj == null || obj instanceof VFS == false)
return false;
VFS other = (VFS) obj;
return context.equals(other.context);
}
}