com.opensymphony.xwork2.util.FileManager Maven / Gradle / Ivy
Go to download
XWork is an command-pattern framework that is used to power WebWork
as well as other applications. XWork provides an Inversion of Control
container, a powerful expression language, data type conversion,
validation, and pluggable configuration.
/*
* Copyright (c) 2002-2003 by OpenSymphony
* All rights reserved.
*/
package com.opensymphony.xwork2.util;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.zip.ZipEntry;
import java.util.jar.JarFile;
/**
* FileManager
*
* This class was brought in from oscore trunk revision 147.
*
* @author Jason Carreira
* Created May 7, 2003 8:44:26 PM
*/
public class FileManager {
//~ Static fields/initializers /////////////////////////////////////////////
private static Map files = Collections.synchronizedMap(new HashMap());
protected static boolean reloadingConfigs = true;
private static final String JAR_FILE_NAME_PREFIX = "jar:file:";
private static final String JAR_FILE_NAME_SEPARATOR = "!/";
//~ Constructors ///////////////////////////////////////////////////////////
private FileManager() {
}
//~ Methods ////////////////////////////////////////////////////////////////
public static void setReloadingConfigs(boolean reloadingConfigs) {
FileManager.reloadingConfigs = reloadingConfigs;
}
public static boolean isReloadingConfigs() {
return reloadingConfigs;
}
public static boolean fileNeedsReloading(String fileName) {
Revision revision = files.get(fileName);
if (revision == null) {
// no revision yet and we keep the revision history, so
// return whether the file needs to be loaded for the first time
return reloadingConfigs;
}
return revision.needsReloading();
}
/**
* Loads opens the named file and returns the InputStream
*
* @param fileName - the name of the file to open
* @return an InputStream of the file contents or null
* @throws IllegalArgumentException if there is no file with the given file name
*/
public static InputStream loadFile(String fileName, Class clazz) {
URL fileUrl = ClassLoaderUtil.getResource(fileName, clazz);
return loadFile(fileUrl);
}
/**
* Loads opens the named file and returns the InputStream
*
* @param fileUrl - the URL of the file to open
* @return an InputStream of the file contents or null
* @throws IllegalArgumentException if there is no file with the given file name
*/
public static InputStream loadFile(URL fileUrl) {
return loadFile(fileUrl, true);
}
/**
* Loads opens the named file and returns the InputStream
*
* @param fileUrl - the URL of the file to open
* @param openStream - if true, open an InputStream to the file and return it
* @return an InputStream of the file contents or null
* @throws IllegalArgumentException if there is no file with the given file name
*/
public static InputStream loadFile(URL fileUrl, boolean openStream) {
if (fileUrl == null) {
return null;
}
String fileName = fileUrl.toString();
InputStream is = null;
if (openStream) {
try {
is = fileUrl.openStream();
if (is == null) {
throw new IllegalArgumentException("No file '" + fileName + "' found as a resource");
}
} catch (IOException e) {
throw new IllegalArgumentException("No file '" + fileName + "' found as a resource");
}
}
if (isReloadingConfigs()) {
if (!fileName.startsWith(JAR_FILE_NAME_PREFIX)) {
File file = new File(fileUrl.getFile());
long lastModified;
if (!file.exists() || !file.canRead()) {
file = null;
}
if (file != null) {
lastModified = file.lastModified();
files.put(fileName, new FileRevision(file, lastModified));
} else {
// Never expire a non-file resource
files.put(fileName, new FileRevision());
}
} else {
// File within a Jar
// Find separator index of jar filename and filename within jar
int separatorIndex = fileName.indexOf(JAR_FILE_NAME_SEPARATOR);
// Split file name
String jarFileName =
fileName.substring(JAR_FILE_NAME_PREFIX.length(),
separatorIndex);
String fileNameInJar =
fileName.substring(
separatorIndex + JAR_FILE_NAME_SEPARATOR.length());
ZipEntry entry;
JarFile jarFile;
try {
jarFile = new JarFile(jarFileName);
entry = jarFile.getEntry(fileNameInJar);
}
catch(IOException e) {
entry = null;
}
if (entry != null) {
files.put(fileName,
new JarEntryRevision(jarFileName,
fileNameInJar,
entry.getTime()));
} else {
// Never expire a non-file resource
files.put(fileName, new Revision());
}
}
}
return is;
}
//~ Inner Classes //////////////////////////////////////////////////////////
private static class Revision {
public Revision() {
}
public boolean needsReloading() {
return false;
}
}
private static class FileRevision extends Revision {
private File file;
private long lastModified;
public FileRevision() {
}
public FileRevision(File file, long lastUpdated) {
if (file == null) {
throw new IllegalArgumentException("File cannot be null");
}
this.file = file;
this.lastModified = lastUpdated;
}
public File getFile() {
return file;
}
public void setLastModified(long lastModified) {
this.lastModified = lastModified;
}
public long getLastModified() {
return lastModified;
}
public boolean needsReloading() {
return (this.lastModified < this.file.lastModified());
}
}
private static class JarEntryRevision
extends Revision {
private String jarFileName;
private String fileNameInJar;
private long lastModified;
public JarEntryRevision(String jarFileName,
String fileNameInJar,
long lastModified) {
if ((jarFileName == null) || (fileNameInJar == null)) {
throw new IllegalArgumentException(
"JarFileName and FileNameInJar cannot be null");
}
this.jarFileName = jarFileName;
this.fileNameInJar = fileNameInJar;
this.lastModified = lastModified;
}
public boolean needsReloading()
{
ZipEntry entry;
try {
JarFile jarFile = new JarFile(this.jarFileName);
entry = jarFile.getEntry(this.fileNameInJar);
}
catch(IOException e) {
entry = null;
}
if (entry != null) {
return (this.lastModified < entry.getTime());
}
else {
return false;
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy