/*
* JBoss, Home of Professional Open Source.
* Copyright 2008, Red Hat Middleware LLC, and individual contributors
* as indicated by the @author tags. See the copyright.txt file 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.deployers.vfs.spi.structure.modified;
import java.io.IOException;
import java.net.URISyntaxException;
import org.jboss.deployers.structure.spi.DeploymentContext;
import org.jboss.deployers.structure.spi.main.MainDeployerInternals;
import org.jboss.deployers.vfs.spi.structure.VFSDeploymentContext;
import org.jboss.logging.Logger;
import org.jboss.vfs.VirtualFile;
/**
* AbstractStructureModificationChecker.
*
* @param <T> exact cache value type
* @author <a href="mailto:ales.justin@jboss.org">Ales Justin</a>
*/
public abstract class AbstractStructureModificationChecker<T> implements StructureModificationChecker
{
/** The log */
protected Logger log = Logger.getLogger(getClass());
/** The main deployer structure */
private MainDeployerInternals mainDeployer;
/** The root filter */
private ModificationCheckerFilter rootFilter;
/** The structure cache */
private volatile StructureCache<T> cache;
protected AbstractStructureModificationChecker()
{
}
protected AbstractStructureModificationChecker(MainDeployerInternals mainDeployer)
{
if (mainDeployer == null)
throw new IllegalArgumentException("Null main deployer");
this.mainDeployer = mainDeployer;
}
/**
* Get root filter.
*
* Use DefaultRootFilter if no explicit config
*
* @return root filter
*/
protected ModificationCheckerFilter getRootFilter()
{
if (rootFilter == null)
rootFilter = new DefaultRootFilter();
return rootFilter;
}
/**
* Set root filter.
*
* @param rootFilter the root filter
*/
public void setRootFilter(ModificationCheckerFilter rootFilter)
{
if (rootFilter == null)
throw new IllegalArgumentException("Null root filter");
this.rootFilter = rootFilter;
}
/**
* Get the structure cache.
*
* Use DefaultStructureCache if no explict config.
*
* @return the structure cache
*/
protected StructureCache<T> getCache()
{
if (cache == null)
cache = new DefaultStructureCache<T>();
return cache;
}
/**
* Set the structure cache.
*
* @param cache the structure cache
*/
public void setCache(StructureCache<T> cache)
{
this.cache = cache;
}
/**
* Get main deployer structure.
*
* @return the main deployer structure
*/
protected MainDeployerInternals getMainDeployerInternals()
{
if (mainDeployer == null)
throw new IllegalArgumentException("Null main deployer structure");
return mainDeployer;
}
/**
* Get deployment context.
*
* @param name the deployment context name
* @return vfs deployment context or null if doesn't exist or not vfs based
*/
protected VFSDeploymentContext getDeploymentContext(String name)
{
DeploymentContext deploymentContext = getMainDeployerInternals().getDeploymentContext(name);
if (deploymentContext == null || deploymentContext instanceof VFSDeploymentContext == false)
return null;
return (VFSDeploymentContext) deploymentContext;
}
public boolean hasStructureBeenModified(String name, VirtualFile root) throws IOException
{
return hasStructureBeenModified(root, getDeploymentContext(name));
}
public boolean hasStructureBeenModified(VirtualFile root) throws IOException
{
VFSDeploymentContext deploymentContext = null;
try
{
String name = root.toURI().toString();
deploymentContext = getDeploymentContext(name);
}
catch (URISyntaxException ignore)
{
}
if(deploymentContext == null)
{
log.trace("Falling back to root name: " + root);
deploymentContext = getDeploymentContext(root.getName());
}
return hasStructureBeenModified(root, deploymentContext);
}
protected boolean hasStructureBeenModified(VirtualFile root, VFSDeploymentContext deploymentContext) throws IOException
{
if (root == null)
throw new IllegalArgumentException("Null root");
if (deploymentContext == null)
return false;
// skip vfs deployment context lookup accepted by filter
if (getRootFilter().accepts(root))
{
boolean result = hasRootBeenModified(root);
if (result || getRootFilter().checkRootOnly(root))
{
if (result)
getCache().invalidateCache(root);
return result;
}
}
boolean result = hasDeploymentContextBeenModified(root, deploymentContext);
if (result)
{
getCache().invalidateCache(root);
}
return result;
}
/**
* Check the root for modification.
*
* @param root the root to check
* @return true if modified, false otherwise
* @throws IOException for any error
*/
protected abstract boolean hasRootBeenModified(VirtualFile root) throws IOException;
/**
* Has structure been modified.
*
* @param root the client root
* @param deploymentContext the deployment context
* @return true if modifed, false otherwise
* @throws IOException for any error
*/
protected abstract boolean hasDeploymentContextBeenModified(VirtualFile root, VFSDeploymentContext deploymentContext) throws IOException;
public void addStructureRoot(VirtualFile root)
{
if (root == null)
throw new IllegalArgumentException("Null root");
getCache().initializeCache(root);
}
public void removeStructureRoot(VirtualFile root)
{
if (root == null)
throw new IllegalArgumentException("Null root");
getCache().removeCache(root);
}
/**
* Default root check constraints.
*/
private static class DefaultRootFilter implements ModificationCheckerFilter
{
public boolean accepts(VirtualFile file)
{
return ! file.isDirectory();
}
public boolean checkRootOnly(VirtualFile root)
{
return true; // no point in checking entries
}
}
}