de.intarsys.tools.locator.FileLocator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of isrt Show documentation
Show all versions of isrt Show documentation
The basic runtime tools and interfaces for intarsys components.
/*
* Copyright (c) 2007, intarsys consulting GmbH
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* - Neither the name of intarsys nor the names of its contributors may be used
* to endorse or promote products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package de.intarsys.tools.locator;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.FilenameFilter;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Reader;
import java.io.Writer;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.logging.Level;
import de.intarsys.tools.file.FileTools;
import de.intarsys.tools.locking.ILock;
import de.intarsys.tools.locking.ILockLevel;
import de.intarsys.tools.locking.ILockSupport;
import de.intarsys.tools.logging.LogTools;
import de.intarsys.tools.randomaccess.IRandomAccess;
import de.intarsys.tools.randomaccess.RandomAccessFile;
import de.intarsys.tools.stream.StreamTools;
import de.intarsys.tools.stream.TempFileOutputStream;
/**
* File based implementation of {@link ILocator}.
*/
public class FileLocator extends CommonLocator implements ILockSupport {
class FileLocatorLock implements ILock {
private java.io.RandomAccessFile ra;
public boolean acquire(Object owner, ILockLevel level) {
try {
ra = new java.io.RandomAccessFile(getFile(), "r");
return true;
} catch (FileNotFoundException e) {
return false;
}
}
public void release(Object owner) {
StreamTools.close(ra);
}
}
/**
* The file referenced by the locator
*/
private File file;
/**
* The encoding of the designated source
*/
private String encoding;
/**
* Flag if the resource is out of synch
*/
private boolean outOfSynch;
/**
* flag if we synchronize synchronously with every check
*/
private boolean synchSynchronous = false;
/**
* Timestamp of last modification to the resource.
*/
private long lastModified = 0;
/**
* flag if output is created initially in a temporary file
*/
private boolean useTempFile = false;
private File canonicalFile;
public FileLocator(File file) {
super();
this.file = file;
}
public FileLocator(String path) {
this(new File(path));
}
@Override
public void delete() throws IOException {
if (getFile() == null) {
return;
}
getFile().delete();
}
/*
* (non-Javadoc)
*
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
public boolean equals(Object obj) {
if (!(obj instanceof FileLocator)) {
return false;
}
return getCanonicalFile()
.equals(((FileLocator) obj).getCanonicalFile());
}
/*
* (non-Javadoc)
*
* @see de.intarsys.tools.locator.ILocator#exists()
*/
public boolean exists() {
return getFile().exists();
}
/**
* The canonical file represented by this.
*
* @return The canonical file represented by this.
*/
public File getCanonicalFile() {
if (canonicalFile == null) {
try {
canonicalFile = getFile().getCanonicalFile();
} catch (IOException e) {
canonicalFile = getFile();
}
}
return canonicalFile;
}
/*
* (non-Javadoc)
*
* @see de.intarsys.tools.locator.ILocator#getChild(java.lang.String)
*/
public ILocator getChild(String name) {
File childfile = new File(getFile(), name);
FileLocator result = new FileLocator(childfile);
result.setSynchSynchronous(isSynchSynchronous());
return result;
}
/**
* The encoding of the file.
*
* @return Returns the encoding.
*/
protected String getEncoding() {
return encoding;
}
/**
* Answer the file represented by this.
*
* @return The canonical file represented by this.
*/
public File getFile() {
return file;
}
/*
* (non-Javadoc)
*
* @see de.intarsys.tools.locator.ILocator#getFullName()
*/
public String getFullName() {
if (getFile() == null) {
return "unknown";
}
return getFile().getAbsolutePath();
}
/*
* (non-Javadoc)
*
* @see de.intarsys.tools.locator.ILocator#getInputStream()
*/
public InputStream getInputStream() throws IOException {
// trigger timestamp reading
getLastModified();
return new FileInputStream(getFile());
}
/**
* Answer the timestamp of the last modification.
*
* @return the timestamp of the last modification.
*/
protected long getLastModified() {
if (lastModified == 0) {
if (file.exists()) {
lastModified = file.lastModified();
}
}
return lastModified;
}
@Override
public long getLength() throws IOException {
return file.length();
}
/*
* (non-Javadoc)
*
* @see de.intarsys.tools.locator.ILocator#getLocalName()
*/
public String getLocalName() {
if (getFile() == null) {
return "unknown";
}
return FileTools.getBaseName(getFile());
}
public ILock getLock() {
return new FileLocatorLock();
}
/*
* (non-Javadoc)
*
* @see de.intarsys.tools.locator.ILocator#getOutputStream()
*/
public OutputStream getOutputStream() throws IOException {
// trigger timestamp reading
getLastModified();
if (!getFile().getParentFile().exists()) {
getFile().getParentFile().mkdirs();
}
if (isUseTempFile()) {
return new TempFileOutputStream(getFile(), "tmp_", "." + getType());
}
return new FileOutputStream(getFile());
}
/*
* (non-Javadoc)
*
* @see de.intarsys.tools.locator.ILocator#getParent()
*/
public ILocator getParent() {
File parentFile = FileTools.getParentFile(getFile());
if (parentFile == null) {
return null;
}
FileLocator result = new FileLocator(parentFile);
result.setSynchSynchronous(isSynchSynchronous());
return result;
}
/*
* (non-Javadoc)
*
* @see de.intarsys.tools.locator.ILocator#getRandomAccess()
*/
public IRandomAccess getRandomAccess() throws IOException {
// trigger timestamp reading
getLastModified();
if (isUseTempFile()) {
throw new UnsupportedOperationException(
"no random access to temp file");
}
return new RandomAccessFile(getFile());
}
/*
* (non-Javadoc)
*
* @see de.intarsys.tools.locator.ILocator#getReader()
*/
public Reader getReader() throws IOException {
// trigger timestamp reading
getLastModified();
if ((getEncoding() == null) || getEncoding().equals("")) {
return new InputStreamReader(getInputStream());
}
return new InputStreamReader(getInputStream(), getEncoding());
}
/*
* (non-Javadoc)
*
* @see de.intarsys.tools.locator.ILocator#getReader(java.lang.String)
*/
public Reader getReader(String newEncoding) throws IOException {
// trigger timestamp reading
getLastModified();
if ((newEncoding == null) || newEncoding.equals("")) {
return getReader();
}
return new InputStreamReader(getInputStream(), newEncoding);
}
/*
* (non-Javadoc)
*
* @see de.intarsys.tools.locator.ILocator#getType()
*/
public String getType() {
if (getFile() == null) {
return "";
}
return FileTools.getExtension(getFile());
}
/*
* (non-Javadoc)
*
* @see de.intarsys.tools.locator.ILocator#getTypedName()
*/
public String getTypedName() {
if (getFile() == null) {
return "unknown";
}
return getFile().getName();
}
/*
* (non-Javadoc)
*
* @see de.intarsys.tools.locator.ILocator#getWriter()
*/
public Writer getWriter() throws IOException {
// trigger timestamp reading
getLastModified();
if ((getEncoding() == null) || getEncoding().equals("")) {
return new OutputStreamWriter(getOutputStream());
}
return new OutputStreamWriter(getOutputStream(), getEncoding());
}
/*
* (non-Javadoc)
*
* @see de.intarsys.tools.locator.ILocator#getWriter(java.lang.String)
*/
public Writer getWriter(String newEncoding) throws IOException {
// trigger timestamp reading
getLastModified();
if ((newEncoding == null) || newEncoding.equals("")) {
return getWriter();
}
return new OutputStreamWriter(getOutputStream(), newEncoding);
}
/*
* (non-Javadoc)
*
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
try {
return getFile().getCanonicalFile().hashCode();
} catch (IOException e) {
return 17;
}
}
/*
* (non-Javadoc)
*
* @see de.intarsys.tools.locator.ILocator#isDirectory()
*/
public boolean isDirectory() {
return getFile().isDirectory();
}
/*
* (non-Javadoc)
*
* @see de.intarsys.tools.component.ISynchronizable#isOutOfSynch()
*/
public synchronized boolean isOutOfSynch() {
if (isSynchSynchronous()) {
synch();
}
return outOfSynch;
}
/*
* (non-Javadoc)
*
* @see de.intarsys.tools.locator.ILocator#isReadOnly()
*/
@Override
public boolean isReadOnly() {
if (super.isReadOnly()) {
return true;
}
IRandomAccess r = null;
try {
if (!getFile().exists()) {
if (getFile().createNewFile()) {
getFile().delete();
return false;
}
return true;
}
r = getRandomAccess();
if (r == null || r.isReadOnly()) {
return true;
}
return false;
} catch (IOException e) {
return true;
} finally {
StreamTools.close(r);
}
}
/*
* (non-Javadoc)
*
* @see de.intarsys.tools.component.ISynchronizable#isSynchSynchronous()
*/
public boolean isSynchSynchronous() {
return synchSynchronous;
}
/**
* true if temp file should be used.
*
* @return true if temp file should be used.
*/
public boolean isUseTempFile() {
return useTempFile;
}
/*
* (non-Javadoc)
*
* @see de.intarsys.tools.locator.ILocator#listLocators(de.intarsys.tools.locator.ILocatorNameFilter)
*/
public ILocator[] listLocators(final ILocatorNameFilter filter)
throws IOException {
if (!getFile().exists()) {
throw new FileNotFoundException(getFile().getName() + " not found");
}
if (!getFile().isDirectory()) {
throw new IOException(getFile().getName() + " not a directory");
}
File[] candidates;
if (filter == null) {
candidates = getFile().listFiles();
} else {
candidates = getFile().listFiles(new FilenameFilter() {
public boolean accept(File dir, String current) {
return filter.accept(FileLocator.this, current);
}
});
}
if (candidates == null) {
throw new IOException("error listing resources");
}
ILocator[] result = new ILocator[candidates.length];
for (int i = 0; i < result.length; i++) {
FileLocator l = new FileLocator(candidates[i].getPath());
l.setSynchSynchronous(isSynchSynchronous());
l.setEncoding(getEncoding());
result[i] = l;
}
return result;
}
@Override
public void rename(String newName) throws IOException {
if (getFile() == null) {
return;
}
File parent = getFile().getParentFile();
if (parent == null) {
parent = getFile().getAbsoluteFile().getParentFile();
}
File newFile;
if (parent == null) {
newFile = new File(newName);
} else {
newFile = new File(parent, newName);
}
FileTools.renameFile(getFile(), newFile);
file = newFile;
canonicalFile = null;
lastModified = 0;
}
protected void setEncoding(String encoding) {
this.encoding = encoding;
}
/**
* @param synchSynchronous
*/
public void setSynchSynchronous(boolean synchSynchronous) {
this.synchSynchronous = synchSynchronous;
}
/**
* @param useTempFile
*/
public void setUseTempFile(boolean useTempFile) {
this.useTempFile = useTempFile;
}
/*
* (non-Javadoc)
*
* @see de.intarsys.tools.component.ISynchronizable#synch()
*/
public synchronized void synch() {
if (getFile() == null) {
return;
}
if ((getLastModified() != getFile().lastModified())) {
LogTools.getLogger(this.getClass()).log(Level.FINEST,
"'" + getFullName() + "' out of synch!");
outOfSynch = true;
}
}
/*
* (non-Javadoc)
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return getFile().toString();
}
/*
* (non-Javadoc)
*
* @see de.intarsys.tools.locator.ILocator#toURL()
*/
public URL toURL() {
try {
return new URL("file", null, getFullName() + "/");
} catch (MalformedURLException e) {
return null;
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy