com.inubit.research.server.manager

Class FileSystemLocation

java.lang.Object

com.inubit.research.server.manager.FileSystemLocation

All Implemented Interfaces:

Location, UserHomeable

public class FileSystemLocation
extends java.lang.Object
implements Location, UserHomeable

A file system location

Nested Class Summary

Nested classes/interfaces inherited from interface com.inubit.research.server.manager.Location

Location.LocationType

Field Summary

Fields inherited from interface com.inubit.research.server.manager.Location

SHARED_PATH_PREFIX

Constructor Summary

Constructors

Constructor and Description
FileSystemLocation(java.io.File baseDir)
FileSystemLocation(java.lang.String baseDir) Create new FileSystemLocation for the given directory

Method Summary

Modifier and Type	Method and Description
void	addModelToFolder(java.lang.String id, java.lang.String path, SingleUser user)
boolean	checkConnection() Checks if this location is currently available.
ServerModel	createNewModel(java.io.File modelFile, java.lang.String path, java.lang.String id, SingleUser user, java.lang.String comment) Create new model
void	createUserHome(SingleUser user)
java.lang.String	getAtticPath(SingleUser user) Get path to the attic directory
java.util.Map<java.lang.String,java.util.List<ServerModel>>	getIndex(java.util.Set<java.lang.String> usedIDs, boolean forceRefresh) Get index of this location.
DirectoryMetaDataHandler	getMetaDataHandler() Get meta data handler for this location
java.util.Set<java.lang.String>	getModelIDs(java.lang.String path, boolean recursive)
java.util.Map<java.lang.String,AccessType>	getModelsForUser(SingleUser user) Get all models belonging to a certain user withing this location
java.lang.String	getName() Get this location's name
Location.LocationType	getType() Get the type of this location
java.lang.String	getUserHome(SingleUser user)
java.util.Set<java.lang.String>	listPaths() Get all paths belonging to this location
java.util.Set<java.lang.String>	listPaths(SingleUser user) Get all paths belonging to a certain user within this location
boolean	moveFolder(java.lang.String folder, java.lang.String target, SingleUser user)
void	removeFolder(java.lang.String path, SingleUser user)
boolean	removeModel(java.lang.String id, SingleUser user) Remove a certain model
ServerModel	saveProcessModel(ProcessModel pm, java.lang.String id, int version)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemLocation

public FileSystemLocation(java.lang.String baseDir)

Create new FileSystemLocation for the given directory

Parameters:

baseDir - the path of the directory

FileSystemLocation

public FileSystemLocation(java.io.File baseDir)

Method Detail

saveProcessModel

public ServerModel saveProcessModel(ProcessModel pm,
                                    java.lang.String id,
                                    int version)

removeModel

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

Description copied from interface: Location

Remove a certain model

Specified by:

removeModel in interface Location

Parameters:

id - the model id

user - the user that requested the deletion

Returns:

• true, if the model can be physically deleted
• false, if the model should only be moved to some location where it resides until physical deletion

getAtticPath

public java.lang.String getAtticPath(SingleUser user)

Description copied from interface: Location

Get path to the attic directory

Specified by:

getAtticPath in interface Location

Parameters:

user - the user

Returns:

the path

getIndex

public java.util.Map<java.lang.String,java.util.List<ServerModel>> getIndex(java.util.Set<java.lang.String> usedIDs,
                                                                            boolean forceRefresh)

Description copied from interface: Location

Get index of this location.

Specified by:

getIndex in interface Location

Returns:

the index mapping IDs to lists of model versions

getMetaDataHandler

public DirectoryMetaDataHandler getMetaDataHandler()

Description copied from interface: Location

Get meta data handler for this location

Specified by:

getMetaDataHandler in interface Location

Returns:

the meta data handler

getType

public Location.LocationType getType()

Description copied from interface: Location

Get the type of this location

Specified by:

getType in interface Location

Returns:

the type

getName

public java.lang.String getName()

Description copied from interface: Location

Get this location's name

Specified by:

getName in interface Location

Returns:

the name

listPaths

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

Description copied from interface: Location

Get all paths belonging to this location

Specified by:

listPaths in interface Location

listPaths

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

Description copied from interface: Location

Get all paths belonging to a certain user within this location

Specified by:

listPaths in interface Location

Parameters:

user - the user

Returns:

the list of paths

getModelsForUser

public java.util.Map<java.lang.String,AccessType> getModelsForUser(SingleUser user)

Description copied from interface: Location

Get all models belonging to a certain user withing this location

Specified by:

getModelsForUser in interface Location

Parameters:

user - the user

Returns:

a map of model IDs and access types

createNewModel

public ServerModel createNewModel(java.io.File modelFile,
                                  java.lang.String path,
                                  java.lang.String id,
                                  SingleUser user,
                                  java.lang.String comment)

Description copied from interface: Location

Create new model

Specified by:

createNewModel in interface Location

addModelToFolder

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

moveFolder

public boolean moveFolder(java.lang.String folder,
                          java.lang.String target,
                          SingleUser user)

removeFolder

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

getModelIDs

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

getUserHome

public java.lang.String getUserHome(SingleUser user)

Specified by:

getUserHome in interface UserHomeable

createUserHome

public void createUserHome(SingleUser user)

Specified by:

createUserHome in interface UserHomeable

checkConnection

public boolean checkConnection()

Description copied from interface: Location

Checks if this location is currently available.

Specified by:

checkConnection in interface Location

Returns: