Package org.apache.lucene.store

Class HardlinkCopyDirectoryWrapper

java.lang.Object

org.apache.lucene.store.Directory

org.apache.lucene.store.FilterDirectory

org.apache.lucene.store.HardlinkCopyDirectoryWrapper

All Implemented Interfaces:

Closeable, AutoCloseable

public final class HardlinkCopyDirectoryWrapper
extends FilterDirectory

This directory wrapper overrides Directory.copyFrom(Directory, String, String, IOContext) in order to optionally use a hard-link instead of a full byte by byte file copy if applicable. Hard-links are only used if the underlying filesystem supports it and if the LinkPermission "hard" is granted.

NOTE: Using hard-links changes the copy semantics of Directory.copyFrom(Directory, String, String, IOContext). When hard-links are used changes to the source file will be reflected in the target file and vice-versa. Within Lucene, files are write once and should not be modified after they have been written. This directory should not be used in situations where files change after they have been written.

Field Summary

Fields inherited from class org.apache.lucene.store.FilterDirectory

in

Constructor Summary

Constructors

Constructor	Description
HardlinkCopyDirectoryWrapper(Directory in)	Creates a new HardlinkCopyDirectoryWrapper delegating to the given directory

Method Summary

Modifier and Type	Method	Description
void	copyFrom(Directory from, String srcFile, String destFile, IOContext context)	Copies an existing src file from directory from to a non-existent file dest in this directory.

Methods inherited from class org.apache.lucene.store.FilterDirectory

close, createOutput, createTempOutput, deleteFile, fileLength, getDelegate, getPendingDeletions, listAll, obtainLock, openInput, rename, sync, syncMetaData, toString, unwrap

Methods inherited from class org.apache.lucene.store.Directory

ensureOpen, getTempFileName, openChecksumInput

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

HardlinkCopyDirectoryWrapper

public HardlinkCopyDirectoryWrapper(Directory in)

Creates a new HardlinkCopyDirectoryWrapper delegating to the given directory

Method Details

copyFrom

public void copyFrom(Directory from,
 String srcFile,
 String destFile,
 IOContext context)
              throws IOException

Description copied from class: Directory

Copies an existing src file from directory from to a non-existent file dest in this directory.

Overrides:

copyFrom in class Directory

Throws:

IOException