com.helger.photon.basic.security.login

Class LoggedInUserStorage

java.lang.Object

com.helger.photon.basic.security.login.LoggedInUserStorage

@ThreadSafe
public final class LoggedInUserStorage
extends Object

This class encapsulates the file IO base directory for the current user

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_DIRECTORY The name of the default base directory relative to the WebFileIO where the data is referenced

Method Summary

Methods

Modifier and Type	Method and Description
static String	getBaseDirectory()
static File	getUserdataDirectory()
static File	getUserdataDirectory(String sUserID)
static void	setBaseDirectory(String sBaseDirectory) Set the base directory to be used.

Methods inherited from class java.lang.Object

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

Field Detail

BASE_DIRECTORY

public static final String BASE_DIRECTORY

The name of the default base directory relative to the WebFileIO where the data is referenced

See Also:

Constant Field Values

Method Detail

getBaseDirectory

@Nonnull
public static String getBaseDirectory()

Returns:

The base directory to be used. By default BASE_DIRECTORY is used.

setBaseDirectory

public static void setBaseDirectory(@Nonnull
                    String sBaseDirectory)

Set the base directory to be used.

Parameters:

sBaseDirectory - The new base directory. May not be null but maybe empty.

getUserdataDirectory

@Nonnull
public static File getUserdataDirectory()

Returns:

The base directory for all user-related data of the current user

getUserdataDirectory

@Nonnull
public static File getUserdataDirectory(@Nonnull@Nonempty
                                String sUserID)

Parameters:

sUserID - the ID of the user for which the user data is requested. May neither be null nor empty.

Returns:

The base directory for all user-related data