com.inubit.research.server.config

Class DirectoryConfig

java.lang.Object

com.inubit.research.server.config.FileSystemConfig

com.inubit.research.server.config.DirectoryConfig

All Implemented Interfaces:

StructuralConfig

public class DirectoryConfig
extends FileSystemConfig
implements StructuralConfig

Configuration for directories that can not be configured using access configurations. On accessability checks always false is returned.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_FILE_NAME
static java.lang.String	USER_HOME_ROOT_PATH

Fields inherited from class com.inubit.research.server.config.FileSystemConfig

models, name, node, parent, subdirectories

Method Summary

Modifier and Type	Method and Description
void	addModel(java.lang.String id, java.lang.String path, SingleUser user) Add a model at a certain path, for a certain user
DirectoryConfig	createUserHome(SingleUser user) Create a user home
void	divestRight(java.lang.String id, AccessType at, java.util.Set<User> users)
static DirectoryConfig	forDirectory(java.io.File dir)
java.lang.String	getPathForModel(java.lang.String id) Get the path of a model
java.util.Set<java.lang.String>	getSharedModels(User user) Get all models a user has shared access.
java.lang.String	getUserHome(SingleUser user) Get the path of the user's home.
void	grantRight(java.lang.String id, AccessType at, java.util.Set<User> users)
boolean	isAnnotatableByUser(User user)
boolean	isAnnotatableByUser(User user, java.lang.String id)
boolean	isOwner(SingleUser user)
boolean	isReadableByUser(User user)
boolean	isReadableByUser(User user, java.lang.String id)
boolean	isWriteableByUser(User user)
boolean	isWriteableByUser(User user, java.lang.String id)
java.util.Set<java.lang.String>	listSharedPaths(User user) List the paths for which a user has shared access at least to one model
java.util.Set<java.lang.String>	listUserHome(SingleUser user) List all paths belonging to the user's home
boolean	moveDirectory(java.lang.String dirPath, java.lang.String targetPath, SingleUser user) Move a complete directory to another path
void	remove(java.lang.String id) Remove a certain model
void	removeDirectory(java.lang.String path, SingleUser user) Remove a complete directory with all its models
boolean	setOwner(java.lang.String id, SingleUser owner, SingleUser user)
void	setPath(java.lang.String id, java.lang.String path, SingleUser user) Set the path of a model

Methods inherited from class com.inubit.research.server.config.FileSystemConfig

createDirConfig, createSubDir, getDirConfigForModel, getDirConfigForPath, getModelConfig, getModelIDs, getModelIDs, getPath, listPaths

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inubit.research.server.config.StructuralConfig

getModelIDs, listPaths

Field Detail

DEFAULT_FILE_NAME

public static final java.lang.String DEFAULT_FILE_NAME

See Also:

Constant Field Values

USER_HOME_ROOT_PATH

public static final java.lang.String USER_HOME_ROOT_PATH

See Also:

Constant Field Values

Method Detail

getPathForModel

public java.lang.String getPathForModel(java.lang.String id)

Description copied from interface: StructuralConfig

Get the path of a model

Specified by:

getPathForModel in interface StructuralConfig

Parameters:

id - the model's ID

Returns:

the path

addModel

public void addModel(java.lang.String id,
                     java.lang.String path,
                     SingleUser user)

Description copied from interface: StructuralConfig

Add a model at a certain path, for a certain user

Specified by:

addModel in interface StructuralConfig

Parameters:

id - the model's ID

path - the path of the model

user - the user the model is added for

setPath

public void setPath(java.lang.String id,
                    java.lang.String path,
                    SingleUser user)

Description copied from interface: StructuralConfig

Set the path of a model

Specified by:

setPath in interface StructuralConfig

Parameters:

id - the model's id

path - the new path

user - the user that requests the change of the path

setOwner

public boolean setOwner(java.lang.String id,
                        SingleUser owner,
                        SingleUser user)

moveDirectory

public boolean moveDirectory(java.lang.String dirPath,
                             java.lang.String targetPath,
                             SingleUser user)

Description copied from interface: StructuralConfig

Move a complete directory to another path

Specified by:

moveDirectory in interface StructuralConfig

Parameters:

dirPath - the path of the directory that will be moved

targetPath - the path were the directory will be moved to

user - the user that requests the movement of the directory

Returns:

• true, if movement was successful
• false, otherwise

remove

public void remove(java.lang.String id)

Description copied from interface: StructuralConfig

Remove a certain model

Specified by:

remove in interface StructuralConfig

Parameters:

id - the model's ID

removeDirectory

public void removeDirectory(java.lang.String path,
                            SingleUser user)

Description copied from interface: StructuralConfig

Remove a complete directory with all its models

Specified by:

removeDirectory in interface StructuralConfig

Parameters:

path - the path of the directory

user - the user that requests deletion

getUserHome

public java.lang.String getUserHome(SingleUser user)

Description copied from interface: StructuralConfig

Get the path of the user's home.

Specified by:

getUserHome in interface StructuralConfig

Parameters:

user - the user

Returns:

the home path

listUserHome

public java.util.Set<java.lang.String> listUserHome(SingleUser user)

Description copied from interface: StructuralConfig

List all paths belonging to the user's home

Specified by:

listUserHome in interface StructuralConfig

Parameters:

user - the user

Returns:

the list of paths

listSharedPaths

public java.util.Set<java.lang.String> listSharedPaths(User user)

Description copied from interface: StructuralConfig

List the paths for which a user has shared access at least to one model

Specified by:

listSharedPaths in interface StructuralConfig

Parameters:

user - the user

Returns:

the set of all accessable paths

getSharedModels

public java.util.Set<java.lang.String> getSharedModels(User user)

Description copied from interface: StructuralConfig

Get all models a user has shared access. These are all the models accessable by the given user except of those he is owner of

Specified by:

getSharedModels in interface StructuralConfig

Parameters:

user - the user

Returns:

the set of model IDs

createUserHome

public DirectoryConfig createUserHome(SingleUser user)

Description copied from interface: StructuralConfig

Create a user home

Specified by:

createUserHome in interface StructuralConfig

Parameters:

user - the user

Returns:

the configuration of the user home.
REMARK: It depends if the returned value is necessary.

grantRight

public void grantRight(java.lang.String id,
                       AccessType at,
                       java.util.Set<User> users)

divestRight

public void divestRight(java.lang.String id,
                        AccessType at,
                        java.util.Set<User> users)

isReadableByUser

public boolean isReadableByUser(User user)

Specified by:

isReadableByUser in class FileSystemConfig

isReadableByUser

public boolean isReadableByUser(User user,
                                java.lang.String id)

Specified by:

isReadableByUser in class FileSystemConfig

isWriteableByUser

public boolean isWriteableByUser(User user)

Specified by:

isWriteableByUser in class FileSystemConfig

isWriteableByUser

public boolean isWriteableByUser(User user,
                                 java.lang.String id)

Specified by:

isWriteableByUser in class FileSystemConfig

isAnnotatableByUser

public boolean isAnnotatableByUser(User user)

Specified by:

isAnnotatableByUser in class FileSystemConfig

isAnnotatableByUser

public boolean isAnnotatableByUser(User user,
                                   java.lang.String id)

Specified by:

isAnnotatableByUser in class FileSystemConfig

isOwner

public boolean isOwner(SingleUser user)

Specified by:

isOwner in class FileSystemConfig

forDirectory

public static DirectoryConfig forDirectory(java.io.File dir)
                                    throws java.lang.Exception

Throws:

java.lang.Exception