Package org.exoplatform.commons.file.resource

Class FileSystemResourceProvider

java.lang.Object

org.exoplatform.commons.file.resource.FileSystemResourceProvider

All Implemented Interfaces:

BinaryProvider

public class FileSystemResourceProvider
extends Object
implements BinaryProvider

This class provide file system implementation of the File RDBMS API.

Field Summary

Fields

Modifier and Type	Field	Description
protected File	root

Constructor Summary

Constructors

Constructor	Description
FileSystemResourceProvider(String rootPath)
FileSystemResourceProvider(org.exoplatform.container.xml.InitParams initParams)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
boolean	exists(String name)
byte[]	getBytes(String name)
final File	getFile(String name)
String	getFilePath(String name)
String	getFilePath(FileInfo fileInfo)
String	getLocation()
File	getRoot()
InputStream	getStream(String name)
URL	getURL(String name)
int	hashCode()
long	lastModified(String name)
void	put(String name, byte[] data)
void	put(String name, InputStream data)	Write a file to the file system.
void	put(FileItem fileItem)
void	remove(String name)
boolean	remove(FileInfo fileInfo)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

root

protected File root

Constructor Details

FileSystemResourceProvider

public FileSystemResourceProvider(String rootPath)
                           throws Exception

Throws:

Exception

FileSystemResourceProvider

public FileSystemResourceProvider(org.exoplatform.container.xml.InitParams initParams)
                           throws Exception

Throws:

Exception

Method Details

getRoot

public File getRoot()

getFile

public final File getFile(String name)
                   throws IOException

Throws:

IOException

exists

public boolean exists(String name)
               throws IOException

Specified by:

exists in interface BinaryProvider

Throws:

IOException

lastModified

public long lastModified(String name)
                  throws IOException

Specified by:

lastModified in interface BinaryProvider

Throws:

IOException

getURL

public URL getURL(String name)

Specified by:

getURL in interface BinaryProvider

getBytes

public byte[] getBytes(String name)

Specified by:

getBytes in interface BinaryProvider

getStream

public InputStream getStream(String name)

Specified by:

getStream in interface BinaryProvider

getFilePath

public String getFilePath(FileInfo fileInfo)
                   throws IOException

Specified by:

getFilePath in interface BinaryProvider

Throws:

IOException

getFilePath

public String getFilePath(String name)
                   throws IOException

Specified by:

getFilePath in interface BinaryProvider

Throws:

IOException

remove

public void remove(String name)
            throws IOException

Specified by:

remove in interface BinaryProvider

Throws:

IOException

remove

public boolean remove(FileInfo fileInfo)
               throws IOException

Specified by:

remove in interface BinaryProvider

Throws:

IOException

put

public void put(String name,
 byte[] data)
         throws IOException

Specified by:

put in interface BinaryProvider

Throws:

IOException

put

public void put(String name,
 InputStream data)
         throws IOException

Write a file to the file system. The path is build with the root path, and from the checksum of the file. The folder levels are built from the checkum, and it is also used for the filename. This allows to never update a file, meaning there will be no concurrent issue when creating or updating a file. If a file with the same path already exists, it means that this is the same file and there is no need to update it. If a file with the same path does not exist, the file can be created since it is a nex file or it is an update with a different file binary. This implies that no deletion of old file versions are done on the fly. A scheduled job is needed for that.

Specified by:

put in interface BinaryProvider

Parameters:

name - file name.

data - inputStream

Throws:

IOException - ignals that an I/O exception of some sort has occurred.

put

public void put(FileItem fileItem)
         throws IOException

Specified by:

put in interface BinaryProvider

Throws:

IOException

getLocation

public String getLocation()

Specified by:

getLocation in interface BinaryProvider

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object