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

Methods

Modifier and Type	Method and Description
static com.helger.commons.state.ISuccessIndicator	createDirectory(String sRelativePath, boolean bRecursive) Create the appropriate directory if it is not existing
static boolean	existsDir(String sRelativePath) Check if a directory relative to the base path exists
static boolean	existsFile(String sRelativePath) Check if a file relative to the base path exists
static String	getBasePath()
static File	getBasePathFile()
static IPathRelativeIO	getDataIO()
static File	getFile(String sRelativePath) Get a File relative to the base path.
static com.helger.commons.io.file.FileOperationManager	getFileOpMgr()
static InputStream	getInputStream(String sRelativePath) Get the InputStream relative to the base path
static OutputStream	getOutputStream(String sRelativePath, com.helger.commons.io.EAppend eAppend) Get the OutputStream relative to the base path
static Reader	getReader(String sRelativePath, Charset aCharset) Get the Reader relative to the base path
static String	getRelativeFilename(File aAbsoluteFile) Get the relative file name for the passed absolute file.
static com.helger.commons.io.resource.FileSystemResource	getResource(String sRelativePath) Get the file system resource relative to the base path
static IPathRelativeIO	getServletContextIO()
static Writer	getWriter(String sRelativePath, Charset aCharset, com.helger.commons.io.EAppend eAppend) Get the Writer relative to the base path
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 IPathRelativeIO getDataIO()

Returns:

data IO provider.

Throws:

IllegalStateException - if no servlet context path was provided

getServletContextIO

@Nonnull
public static IPathRelativeIO getServletContextIO()

Returns:

The servlet context IO provider.

Throws:

IllegalStateException - if no servlet context path was provided

getBasePathFile

@Nonnull
public static File getBasePathFile()

Returns:

The storage base path.

Throws:

IllegalStateException - if no base path was provided

getBasePath

@Nonnull
@Nonempty
public static String getBasePath()

Returns:

The absolute base path that is used

Throws:

IllegalStateException - if no base path was provided

getFile

@Nonnull
public static File getFile(@Nonnull
                   String sRelativePath)

Get a File relative to the base path.

Parameters:

sRelativePath - the relative path

Returns:

The "absolute" File and never null.

Throws:

IllegalStateException - if no base path was provided

See Also:

getBasePathFile()

existsFile

public static boolean existsFile(@Nonnull
                 String sRelativePath)

Check if a file relative to the base path exists

Parameters:

sRelativePath - the relative path

Returns:

true if the File is a file and exists, false otherwise.

Throws:

IllegalStateException - if no base path was provided

See Also:

getBasePathFile()

existsDir

public static boolean existsDir(@Nonnull
                String sRelativePath)

Check if a directory relative to the base path exists

Parameters:

sRelativePath - the relative path

Returns:

true if the File is a directory and exists, false otherwise.

Throws:

IllegalStateException - if no base path was provided

See Also:

getBasePathFile()

getResource

@Nonnull
public static com.helger.commons.io.resource.FileSystemResource getResource(@Nonnull
                                                                    String sRelativePath)

Get the file system resource relative to the base path

Parameters:

sRelativePath - the relative path

Returns:

The "absolute" FileSystemResource and never null.

Throws:

IllegalStateException - if no base path was provided

See Also:

getBasePathFile()

getInputStream

@Nullable
public static InputStream getInputStream(@Nonnull
                                  String sRelativePath)

Get the InputStream relative to the base path

Parameters:

sRelativePath - the relative path

Returns:

null if the path does not exist

Throws:

IllegalStateException - if no base path was provided

See Also:

getBasePathFile()

getReader

@Nullable
public static Reader getReader(@Nonnull
                        String sRelativePath,
                        @Nonnull
                        Charset aCharset)

Get the Reader relative to the base path

Parameters:

sRelativePath - the relative path

aCharset - The charset to use. May not be null.

Returns:

null if the path does not exist

Throws:

IllegalStateException - if no base path was provided

See Also:

getBasePathFile()

getOutputStream

@Nullable
public static OutputStream getOutputStream(@Nonnull
                                    String sRelativePath,
                                    @Nonnull
                                    com.helger.commons.io.EAppend eAppend)

Get the OutputStream relative to the base path

Parameters:

sRelativePath - the relative path

eAppend - Append or truncate mode. May not be null.

Returns:

null if the path is not writable

See Also:

getBasePathFile()

getWriter

@Nullable
public static Writer getWriter(@Nonnull
                        String sRelativePath,
                        @Nonnull
                        Charset aCharset,
                        @Nonnull
                        com.helger.commons.io.EAppend eAppend)

Get the Writer relative to the base path

Parameters:

sRelativePath - the relative path

aCharset - The charset to use. May not be null.

eAppend - Append or truncate mode. May not be null.

Returns:

null if the path is not writable

See Also:

getBasePathFile()

createDirectory

@Nonnull
public static com.helger.commons.state.ISuccessIndicator createDirectory(@Nonnull
                                                                 String sRelativePath,
                                                                 boolean bRecursive)

Create the appropriate directory if it is not existing

Parameters:

sRelativePath - the relative path

bRecursive - if true all missing parent directories will be created

Returns:

Success indicator. Never null.

See Also:

getBasePathFile()

getRelativeFilename

@Nullable
public static String getRelativeFilename(@Nonnull
                                  File aAbsoluteFile)

Get the relative file name for the passed absolute file.

Parameters:

aAbsoluteFile - The non-null absolute file to make relative.

Returns:

null if the passed file is not a child of the data directory.