com.kheops.jmap.server

Class WorkSpaceManager

java.lang.Object

com.kheops.jmap.server.WorkSpaceManager

public class WorkSpaceManager
extends java.lang.Object

This class is used to manage user workspaces.

Constructor Summary

Constructors

Constructor and Description
WorkSpaceManager(java.io.File rootPath) Creates a new workspace manager.

Method Summary

Modifier and Type	Method and Description
boolean	deleteUserWS(java.lang.String username) Deletes the workspace of the specified user.
boolean	emptyUserWS(java.lang.String username) This method empties the workspace of the specified user.
java.io.File	getRootPath() Returns the workspaces root path.
UserParameter	getUserParameter(java.lang.String userName, int projectId, java.lang.String parameterKey) Returns the UserParameter associated with the userName / projectId / parameterKey.
java.io.File	getUserWSDirectory(java.lang.String username) This method returns the workspace path of the specified user.
java.util.List<UserParameter>	loadUserParameter(java.lang.String userName, int projectId) Loads user parameters from user workspace / projectID.
boolean	saveUserParameter(java.util.List<UserParameter> userParameters, java.lang.String userName, int projectId) Saves user parameters to user_workspace / projectID / USER_PARAMETER_FILE.
void	setUserParameter(java.lang.String userName, int projectId, UserParameter userParameter) Saves a UserParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkSpaceManager

public WorkSpaceManager(java.io.File rootPath)
                 throws java.io.IOException

Creates a new workspace manager. The specified path is the root of the workspaces. It is created if it does not exist.

Parameters:

rootPath - the workspaces root path.

Throws:

java.io.IOException - if the path cannot be created

Method Detail

getRootPath

public java.io.File getRootPath()

Returns the workspaces root path.

Returns:

the workspaces root path.

getUserWSDirectory

public java.io.File getUserWSDirectory(java.lang.String username)

This method returns the workspace path of the specified user. It is created if it does not exist.

Parameters:

username - , the user name

Returns:

the workspace path of the specified user

emptyUserWS

public boolean emptyUserWS(java.lang.String username)

This method empties the workspace of the specified user. All files and directories are deleted.

Parameters:

username - , the user name

Returns:

true if and only if the workspace is successfully emptied, false otherwise

deleteUserWS

public boolean deleteUserWS(java.lang.String username)

Deletes the workspace of the specified user. All files and directories are deleted. The workspace directory for the user is also deleted.

Parameters:

username - , the user name

Returns:

true if and only if the workspace is successfully deleted, false otherwise

getUserParameter

public UserParameter getUserParameter(java.lang.String userName,
                                      int projectId,
                                      java.lang.String parameterKey)

Returns the UserParameter associated with the userName / projectId / parameterKey. null if not found.

Parameters:

userName - the user name

projectId - the project id or JMapServerRequest.SaveUserParameters.GLOBAL_PARAMETERS

parameterKey - the parameter key to search

Returns:

setUserParameter

public void setUserParameter(java.lang.String userName,
                             int projectId,
                             UserParameter userParameter)

Saves a UserParameter

Parameters:

userName - the user name

projectId - the project id or JMapServerRequest.SaveUserParameters.GLOBAL_PARAMETERS

userParameter - user parameter to save

saveUserParameter

public boolean saveUserParameter(java.util.List<UserParameter> userParameters,
                                 java.lang.String userName,
                                 int projectId)

Saves user parameters to user_workspace / projectID / USER_PARAMETER_FILE.

Parameters:

userParameters - list of UserParameter to be saved.

userName - user name used to get the directory where the user parameter file will be saved.

projectId - project ID used to get the directory where the user parameter file will be saved.

Returns:

whether or not the parameter list was saved..

loadUserParameter

public java.util.List<UserParameter> loadUserParameter(java.lang.String userName,
                                                       int projectId)

Loads user parameters from user workspace / projectID.

Parameters:

userName - user name used to get the directory where the user parameter file will be saved.

projectId - project ID used to get the directory where the user parameter file will be saved.

Returns:

a list of user parameter.