IFileReader

All Known Implementing Classes:: FileReader

public interface IFileReader

An interface for the operations of reading a file. This primarily exists to make testing easier.

Method Summary

Modifier and Type

Method

Description

ReentrantLock

getCacheLock()

This returns the ReentrantLock that is used around the LRUCache to allow access to the cache from other classes.

Map<String,byte[]>

getLruCache()

Returns the LRU (least-recently-used) cache that is filled when using readFile(String)

byte[]

readFile(String path)

Reads a file from disk.

Method Details
- readFile
  
  byte[] readFile(String path) throws IOException
  
  Reads a file from disk.
  
  Throws:
  
  ForbiddenUseException - if the requested path includes bad file patterns, mainly ones to escape from the intended directories (like ".." or "/", etc)
  
  IllegalArgumentException - if the path is blank
  
  IOException
- getCacheLock
  
  ReentrantLock getCacheLock()
  
  This returns the ReentrantLock that is used around the LRUCache to allow access to the cache from other classes. This is used in the WebFramework class when accessing the cache for static files.
- getLruCache
  
  Map<String,byte[]> getLruCache()
  
  Returns the LRU (least-recently-used) cache that is filled when using readFile(String)