public class MockDirectoryWrapper extends BaseDirectoryWrapper
LuceneTestCase.newDirectory()
are tracked
to ensure they are closed by the test.
Modifier and Type | Class and Description |
---|---|
static class |
MockDirectoryWrapper.Failure
Objects that represent fail-able conditions.
|
static class |
MockDirectoryWrapper.FakeIOException
Use this when throwing fake
IOException ,
e.g. |
static class |
MockDirectoryWrapper.Throttling
Enum for controlling hard disk throttling.
|
isOpen
in
Constructor and Description |
---|
MockDirectoryWrapper(Random random,
Directory delegate) |
Modifier and Type | Method and Description |
---|---|
void |
clearCrash() |
void |
close()
Closes the store.
|
void |
copyFrom(Directory from,
String src,
String dest,
IOContext context)
Copies the file src in from to this directory under the new
file name dest.
|
void |
crash()
Simulates a crash of OS or machine by overwriting
unsynced files.
|
IndexOutput |
createOutput(String name,
IOContext context)
Creates a new, empty file in the directory with the given name.
|
void |
deleteFile(String name)
Removes an existing file in the directory.
|
boolean |
didTryToDelete(String fileName)
Returns true if
deleteFile(java.lang.String) was called with this
fileName, but the virus checker prevented the deletion. |
protected void |
ensureOpen() |
void |
failOn(MockDirectoryWrapper.Failure fail)
add a Failure object to the list of objects to be evaluated
at every potential failure point
|
long |
fileLength(String name)
Returns the length of a file in the directory.
|
boolean |
getAssertNoDeleteOpenFile() |
boolean |
getEnableVirusScanner()
Returns true if the virus scanner is enabled
|
long |
getFileHandleCount()
returns current open file handle count
|
int |
getInputCloneCount() |
long |
getMaxSizeInBytes() |
long |
getMaxUsedSizeInBytes()
Returns the peek actual storage used (bytes) in this
directory.
|
boolean |
getNoDeleteOpenFile() |
Set<String> |
getOpenDeletedFiles() |
double |
getRandomIOExceptionRate() |
double |
getRandomIOExceptionRateOnOpen() |
long |
getRecomputedActualSizeInBytes()
Like getRecomputedSizeInBytes(), but, uses actual file
lengths rather than buffer allocations (which are
quantized up to nearest
RAMOutputStream.BUFFER_SIZE (now 1024) bytes.
|
long |
getRecomputedSizeInBytes()
Provided for testing purposes.
|
String[] |
listAll()
Returns an array of strings, one for each entry in the directory.
|
Lock |
obtainLock(String name)
Returns an obtained
Lock . |
ChecksumIndexInput |
openChecksumInput(String name,
IOContext context)
Returns a stream reading an existing file, computing checksum as it reads
|
IndexInput |
openInput(String name,
IOContext context)
Returns a stream reading an existing file.
|
void |
removeIndexInput(IndexInput in,
String name) |
void |
removeIndexOutput(IndexOutput out,
String name) |
void |
renameFile(String source,
String dest)
Renames
source to dest as an atomic operation,
where dest does not yet exist in the directory. |
void |
resetMaxUsedSizeInBytes() |
void |
setAllowRandomFileNotFoundException(boolean value)
If set to true (the default), when we throw random
IOException on openInput or createOutput, we may
sometimes throw FileNotFoundException or
NoSuchFileException.
|
void |
setAllowReadingFilesStillOpenForWrite(boolean value)
If set to true, you can open an inputstream on a file
that is still open for writes.
|
void |
setAssertNoDeleteOpenFile(boolean value)
Trip a test assert if there is an attempt
to delete an open file.
|
void |
setAssertNoUnrefencedFilesOnClose(boolean v) |
void |
setEnableVirusScanner(boolean value)
If set to true (the default), deleteFile sometimes
fails because a virus scanner is open.
|
void |
setFailOnCreateOutput(boolean v) |
void |
setFailOnOpenInput(boolean v) |
void |
setMaxSizeInBytes(long maxSize) |
void |
setNoDeleteOpenFile(boolean value)
Emulate windows whereby deleting an open file is not
allowed (raise IOException).
|
void |
setPreventDoubleWrite(boolean value)
If set to true, we throw an IOException if the same
file is opened by createOutput, ever.
|
void |
setRandomIOExceptionRate(double rate)
If 0.0, no exceptions will be thrown.
|
void |
setRandomIOExceptionRateOnOpen(double rate)
If 0.0, no exceptions will be thrown during openInput
and createOutput.
|
void |
setThrottling(MockDirectoryWrapper.Throttling throttling) |
void |
setTrackDiskUsage(boolean v) |
void |
setUseSlowOpenClosers(boolean v)
Add a rare small sleep to catch race conditions in open/close
|
void |
setVerboseClone(boolean v)
If set to true, we print a fake exception
with filename and stacktrace on every indexinput clone()
|
long |
sizeInBytes() |
void |
sync(Collection<String> names)
Ensure that any writes to these files are moved to
stable storage.
|
String |
toString() |
getCheckIndexOnClose, getCrossCheckTermVectorsOnClose, isOpen, setCheckIndexOnClose, setCrossCheckTermVectorsOnClose
getDelegate, unwrap
public int getInputCloneCount()
public void setVerboseClone(boolean v)
public void setTrackDiskUsage(boolean v)
public void setPreventDoubleWrite(boolean value)
public void setAllowRandomFileNotFoundException(boolean value)
public void setAllowReadingFilesStillOpenForWrite(boolean value)
public boolean getEnableVirusScanner()
public void setEnableVirusScanner(boolean value)
public void setThrottling(MockDirectoryWrapper.Throttling throttling)
public void setUseSlowOpenClosers(boolean v)
You can enable this if you need it.
public void sync(Collection<String> names) throws IOException
Directory
sync
in class FilterDirectory
IOException
public void renameFile(String source, String dest) throws IOException
Directory
source
to dest
as an atomic operation,
where dest
does not yet exist in the directory.
Notes: This method is used by IndexWriter to publish commits.
It is ok if this operation is not truly atomic, for example
both source
and dest
can be visible temporarily.
It is just important that the contents of dest
appear
atomically, or an exception is thrown.
renameFile
in class FilterDirectory
IOException
public final long sizeInBytes() throws IOException
IOException
public void crash() throws IOException
IOException
public void clearCrash()
public void setMaxSizeInBytes(long maxSize)
public long getMaxSizeInBytes()
public long getMaxUsedSizeInBytes()
public void resetMaxUsedSizeInBytes() throws IOException
IOException
public void setNoDeleteOpenFile(boolean value)
public boolean getNoDeleteOpenFile()
public void setAssertNoDeleteOpenFile(boolean value)
public boolean getAssertNoDeleteOpenFile()
public void setRandomIOExceptionRate(double rate)
public double getRandomIOExceptionRate()
public void setRandomIOExceptionRateOnOpen(double rate)
public double getRandomIOExceptionRateOnOpen()
public long getFileHandleCount()
public void deleteFile(String name) throws IOException
Directory
deleteFile
in class FilterDirectory
IOException
public boolean didTryToDelete(String fileName)
deleteFile(java.lang.String)
was called with this
fileName, but the virus checker prevented the deletion.public void setFailOnCreateOutput(boolean v)
public IndexOutput createOutput(String name, IOContext context) throws IOException
Directory
createOutput
in class FilterDirectory
IOException
public void setFailOnOpenInput(boolean v)
public IndexInput openInput(String name, IOContext context) throws IOException
Directory
Throws FileNotFoundException
or NoSuchFileException
if the file does not exist.
openInput
in class FilterDirectory
IOException
public final long getRecomputedSizeInBytes() throws IOException
IOException
public final long getRecomputedActualSizeInBytes() throws IOException
IOException
public void setAssertNoUnrefencedFilesOnClose(boolean v)
public void close() throws IOException
Directory
close
in interface Closeable
close
in interface AutoCloseable
close
in class BaseDirectoryWrapper
IOException
public void removeIndexOutput(IndexOutput out, String name)
public void removeIndexInput(IndexInput in, String name)
public void failOn(MockDirectoryWrapper.Failure fail)
public String[] listAll() throws IOException
Directory
listAll
in class FilterDirectory
IOException
- in case of IO errorpublic long fileLength(String name) throws IOException
Directory
FileNotFoundException
or NoSuchFileException
if the file does not exist.
fileLength
in class FilterDirectory
name
- the name of the file for which to return the length.IOException
- if there was an IO error while retrieving the file's
length.public Lock obtainLock(String name) throws IOException
Directory
Lock
.obtainLock
in class FilterDirectory
name
- the name of the lock fileLockObtainFailedException
- (optional specific exception) if the lock could
not be obtained because it is currently held elsewhere.IOException
- if any i/o error occurs attempting to gain the lockpublic String toString()
toString
in class FilterDirectory
public final ChecksumIndexInput openChecksumInput(String name, IOContext context) throws IOException
Directory
openChecksumInput
in class Directory
IOException
public final void copyFrom(Directory from, String src, String dest, IOContext context) throws IOException
Directory
If you want to copy the entire source directory to the destination one, you can do so like this:
Directory to; // the directory to copy to for (String file : dir.listAll()) { to.copyFrom(dir, file, newFile, IOContext.DEFAULT); // newFile can be either file, or a new name }
NOTE: this method does not check whether dest exist and will overwrite it if it does.
copyFrom
in class Directory
IOException
protected final void ensureOpen() throws AlreadyClosedException
ensureOpen
in class Directory
AlreadyClosedException
- if this Directory is closedCopyright © 2000–2015 The Apache Software Foundation. All rights reserved.