com.inubit.research.server.config

Interface StructuralConfig

All Known Implementing Classes:

DirectoryConfig

public interface StructuralConfig

Interface for any kind of configurations that aim at representing directory structures for process model repositories.

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
StructuralConfig	createUserHome(SingleUser user) Create a user home
java.util.Set<java.lang.String>	getModelIDs(java.lang.String path, boolean recursive) Get all model IDs belonging to a specific path.
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.
java.util.Set<java.lang.String>	listPaths() List all paths
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
void	setPath(java.lang.String id, java.lang.String path, SingleUser user) Set the path of a model

Method Detail

getPathForModel

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

Get the path of a model

Parameters:

id - the model's ID

Returns:

the path

addModel

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

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

Parameters:

id - the model's ID

path - the path of the model

user - the user the model is added for

setPath

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

Set the path of a model

Parameters:

id - the model's id

path - the new path

user - the user that requests the change of the path

moveDirectory

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

Move a complete directory to another path

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

void remove(java.lang.String id)

Remove a certain model

Parameters:

id - the model's ID

removeDirectory

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

Remove a complete directory with all its models

Parameters:

path - the path of the directory

user - the user that requests deletion

listSharedPaths

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

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

Parameters:

user - the user

Returns:

the set of all accessable paths

getSharedModels

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

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

Parameters:

user - the user

Returns:

the set of model IDs

createUserHome

StructuralConfig createUserHome(SingleUser user)

Create a user home

Parameters:

user - the user

Returns:

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

getUserHome

java.lang.String getUserHome(SingleUser user)

Get the path of the user's home.

Parameters:

user - the user

Returns:

the home path

listUserHome

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

List all paths belonging to the user's home

Parameters:

user - the user

Returns:

the list of paths

listPaths

java.util.Set<java.lang.String> listPaths()

List all paths

Returns:

the list of paths

getModelIDs

java.util.Set<java.lang.String> getModelIDs(java.lang.String path,
                                            boolean recursive)

Get all model IDs belonging to a specific path. It can be configured whether subdirectories should be listed recursively.

Parameters:

path - the path of the directory

recursive -

• if true, models in subdirectories will also be returned
• if false, only this directory's content will be returned

Returns:

the set of model IDs