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 com.helger.commons.io.relative.IFileRelativeIO	getDataIO()
static com.helger.commons.io.relative.IPathRelativeIO	getServletContextIO()
static void	initPaths(File aDataPath, String sServletContextPath, boolean bCheckFileAccess)
static boolean	isInited()
static void	resetPaths() Reset the base paths - no matter if they were initialized or not.

Methods inherited from class java.lang.Object

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

Method Detail

initPaths

public static void initPaths(@Nonnull
                             File aDataPath,
                             @Nonnull @Nonempty
                             String sServletContextPath,
                             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 com.helger.commons.io.relative.IFileRelativeIO getDataIO()

Returns:

data IO provider.

Throws:

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

getServletContextIO

@Nonnull
public static com.helger.commons.io.relative.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, String, boolean) first.