com.helger.photon.basic.app.io

Class WebFileIO

java.lang.Object

com.helger.photon.basic.app.io.WebFileIO

@ThreadSafe
public final class WebFileIO
extends Object

Abstract for accessing files inside the web application. It differentiates between the data path (where the runtime data is stored) and the servlet context path (for accessing files inside the web application). The default operations in this class work on the data path!

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
static IMutablePathRelativeIO	getDataIO()
static com.helger.commons.io.file.FileOperationManager	getFileOpMgr()
static IPathRelativeIO	getServletContextIO()
static void	initPaths(File aDataPath, File aServletContextPath, boolean bCheckFileAccess)
static boolean	isInited()
static void	resetPaths() Reset the base paths - no matter if they were initialized or not.
static void	setFileOpMgr(com.helger.commons.io.file.FileOperationManager aFileOpMgr) Set the global file operation manager to be used.

Methods inherited from class java.lang.Object

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

Method Detail

setFileOpMgr

public static void setFileOpMgr(@Nonnull
                                com.helger.commons.io.file.FileOperationManager aFileOpMgr)

Set the global file operation manager to be used.

Parameters:

aFileOpMgr - The file operation manager. May not be null.

getFileOpMgr

@Nonnull
public static com.helger.commons.io.file.FileOperationManager getFileOpMgr()

Returns:

The global file operation manager. Never null.

initPaths

public static void initPaths(@Nonnull
                             File aDataPath,
                             @Nonnull
                             File aServletContextPath,
                             boolean bCheckFileAccess)

resetPaths

public static void resetPaths()

Reset the base paths - no matter if they were initialized or not.

isInited

public static boolean isInited()

Returns:

true if the base path was initialized, false otherwise

getDataIO

@Nonnull
public static IMutablePathRelativeIO getDataIO()

Returns:

data IO provider.

Throws:

IllegalStateException - if no data path was provided. Call initPaths(File, File, boolean) first.

getServletContextIO

@Nonnull
public static IPathRelativeIO getServletContextIO()

Returns:

The servlet context IO provider. This is read-only because it makes no sense to modify the contents of the servlet context directory.

Throws:

IllegalStateException - if no servlet context path was provided. Call initPaths(File, File, boolean) first.