com.inubit.research.server.manager

Class ISLocation

java.lang.Object

com.inubit.research.server.manager.ISLocation

All Implemented Interfaces:

Location

public class ISLocation
extends java.lang.Object
implements 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
ISLocation(java.net.URI serverURL, java.lang.String username, java.lang.String password)

Method Summary

Modifier and Type	Method and Description
boolean	checkConnection() Checks if this location is currently available.
ServerModel	createNewModel(java.io.File model, java.lang.String path, java.lang.String id, SingleUser user, java.lang.String comment) Create new model
boolean	equals(java.lang.Object o)
AccessType	getAccessability(java.lang.String id, int version, LoginableUser user)
java.util.Set<User>	getAnnotators(java.lang.String id)
java.lang.String	getAtticPath(SingleUser user) Get path to the attic directory
java.util.Set<User>	getEditors(java.lang.String id)
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.
MetaDataHandler	getMetaDataHandler() Get meta data handler for this location
ServerModel	getModel(java.lang.String id)
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
java.lang.String	getOwner(java.lang.String id)
java.lang.String	getPwd()
Location.LocationType	getType() Get the type of this location
java.lang.String	getURL()
java.lang.String	getUser()
java.util.Set<User>	getViewers(java.lang.String id)
int	hashCode() this hashcode ensures that no ISLocation with the same user/URL combination can be added
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	removeModel(java.lang.String id, SingleUser user) Remove a certain model
ServerModel	saveProcessModel(ProcessModel pm, java.lang.String id, int version)
boolean	setOwner(java.lang.String id, SingleUser owner, SingleUser admin)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ISLocation

public ISLocation(java.net.URI serverURL,
                  java.lang.String username,
                  java.lang.String password)

Method Detail

hashCode

public int hashCode()

this hashcode ensures that no ISLocation with the same user/URL combination can be added

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

checkConnection

public boolean checkConnection()

Description copied from interface: Location

Checks if this location is currently available.

Specified by:

checkConnection in interface Location

Returns:

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

getModel

public ServerModel getModel(java.lang.String id)

getMetaDataHandler

public MetaDataHandler 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 model,
                                  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

getAccessability

public AccessType getAccessability(java.lang.String id,
                                   int version,
                                   LoginableUser user)

getOwner

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

getViewers

public java.util.Set<User> getViewers(java.lang.String id)

getEditors

public java.util.Set<User> getEditors(java.lang.String id)

getAnnotators

public java.util.Set<User> getAnnotators(java.lang.String id)

setOwner

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

getURL

public java.lang.String getURL()
                        throws java.lang.Exception

Throws:

java.lang.Exception

getUser

public java.lang.String getUser()

getPwd

public java.lang.String getPwd()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object