org.gcube.common.homelibrary.home.workspace.usermanager

Interface UserManager

public interface UserManager

Author:

valentina

Method Summary

Modifier and Type	Method and Description
boolean	associateUserToGroup(String scope, String userToAssociate) Associate a user with a scope group
boolean	associateUserToGroup(String scope, String userToAssociate, String portalLogin) Deprecated. use associateUserToGroup(String scope, String userToAssociate) instead.
GCubeGroup	createGroup(String groupName) Create a new group
boolean	createUser(String name, String version) Create a new user (the password will be automatically generated)
boolean	createUser(String name, String pass, String version) Create a new user with password
boolean	deleteAuthorizable(String user) Delete a group
GCubeGroup	getGroup(String groupname) Return a group by the name
List<GCubeGroup>	getGroups() Get all groups
List<String>	getUsers() Get a list of all users
String	getVersionByUser(String user) Get current workspace Version By User
boolean	isGroup(String groupId) Check if a user is a group
boolean	removeAdministrator(String scope, String username)
boolean	removeAdministrator(String scope, String username, String portalLogin) Deprecated.
boolean	removeUserFromGroup(String scope, String userToRemove) Remove a user from a scope group
boolean	removeUserFromGroup(String scope, String userToRemove, String portalLogin) Deprecated. use removeUserFromGroup(String scope, String userToRemove) instead.
boolean	setAdministrator(String scope, String username)
boolean	setAdministrator(String scope, String username, String portalLogin) Deprecated.
boolean	setVersionByUser(String user, String version) Set workspace Version for a User

Method Detail

createUser

boolean createUser(String name,
                   String version)
            throws InternalErrorException

Create a new user (the password will be automatically generated)

Parameters:

name - of the new user

version - HL release version

Returns:

true if it has been successfully created

Throws:

InternalErrorException

createUser

boolean createUser(String name,
                   String pass,
                   String version)
            throws InternalErrorException

Create a new user with password

Parameters:

name - of the new user

pass - of the new user

version - HL release version

Returns:

true if it has been successfully created

Throws:

InternalErrorException

getUsers

List<String> getUsers()
               throws InternalErrorException

Get a list of all users

Returns:

a list of users

Throws:

InternalErrorException

getVersionByUser

String getVersionByUser(String user)
                 throws InternalErrorException

Get current workspace Version By User

Parameters:

user -

Returns:

HL release version

Throws:

InternalErrorException

setVersionByUser

boolean setVersionByUser(String user,
                         String version)
                  throws InternalErrorException

Set workspace Version for a User

Parameters:

user -

version - HL release version

Returns:

true if the version has been correctly set, false otherwise

Throws:

InternalErrorException

getGroups

List<GCubeGroup> getGroups()
                    throws InternalErrorException

Get all groups

Returns:

a list of groups

Throws:

InternalErrorException

getGroup

GCubeGroup getGroup(String groupname)
             throws InternalErrorException

Return a group by the name

Parameters:

groupname: - name of the new group.

Returns:

a GCubeGroup

Throws:

InternalErrorException

createGroup

GCubeGroup createGroup(String groupName)
                throws InternalErrorException

Create a new group

Parameters:

groupName: - name of the new group

Returns:

true if it has been created

Throws:

InternalErrorException

deleteAuthorizable

boolean deleteAuthorizable(String user)
                    throws InternalErrorException

Delete a group

Parameters:

user: - name of a group or user

Returns:

true if it has been successfully deleted

Throws:

InternalErrorException

associateUserToGroup

@Deprecated
boolean associateUserToGroup(String scope,
                                         String userToAssociate,
                                         String portalLogin)
                                  throws InternalErrorException,
                                         ItemNotFoundException

Deprecated. use associateUserToGroup(String scope, String userToAssociate) instead.

Associate a user with a scope group

Parameters:

scope: - the VRE scope

username: - an existing user to associate to a VRE group

portalLogin -

Returns:

true if the user has been successfully associated to the VRE group

Throws:

InternalErrorException

ItemNotFoundException

removeUserFromGroup

@Deprecated
boolean removeUserFromGroup(String scope,
                                        String userToRemove,
                                        String portalLogin)
                                 throws InternalErrorException,
                                        ItemNotFoundException

Deprecated. use removeUserFromGroup(String scope, String userToRemove) instead.

Remove a user from a scope group

Parameters:

scope: - the VRE scope

userToRemove: - an existing user to remove

portalLogin -

Returns:

true if the user has been successfully removed to the VRE group

Throws:

InternalErrorException

ItemNotFoundException

setAdministrator

@Deprecated
boolean setAdministrator(String scope,
                                     String username,
                                     String portalLogin)
                              throws InternalErrorException,
                                     ItemNotFoundException

Deprecated.

Set Administrator to a folder

Parameters:

scope: - the VRE scope

username: - an existing user to remove from the VRE group

portalLogin -

Returns:

true if the user has been successfully set as administrator

Throws:

InternalErrorException

ItemNotFoundException

removeAdministrator

@Deprecated
boolean removeAdministrator(String scope,
                                        String username,
                                        String portalLogin)
                                 throws InternalErrorException,
                                        ItemNotFoundException

Deprecated.

Remove Administrator from a folder

Parameters:

scope: - the VRE scope

username: - an existing user

portalLogin -

Returns:

true if the user has been successfully removed as administrator

Throws:

InternalErrorException

ItemNotFoundException

isGroup

boolean isGroup(String groupId)
         throws InternalErrorException

Check if a user is a group

Parameters:

groupId -

Returns:

true if the groupId is a group

Throws:

InternalErrorException

associateUserToGroup

boolean associateUserToGroup(String scope,
                             String userToAssociate)
                      throws InternalErrorException,
                             ItemNotFoundException

Associate a user with a scope group

Parameters:

scope: - the VRE scope

username: - an existing user to associate to a VRE group

portalLogin -

Returns:

true if the user has been successfully associated to the VRE group

Throws:

InternalErrorException

ItemNotFoundException

removeUserFromGroup

boolean removeUserFromGroup(String scope,
                            String userToRemove)
                     throws InternalErrorException,
                            ItemNotFoundException

Remove a user from a scope group

Parameters:

scope: - the VRE scope

userToRemove: - an existing user to remove from the VRE group

Returns:

true if the user has been successfully removed to the VRE group

Throws:

InternalErrorException

ItemNotFoundException

setAdministrator

boolean setAdministrator(String scope,
                         String username)
                  throws InternalErrorException,
                         ItemNotFoundException

Parameters:

scope -

username -

Returns:

Throws:

InternalErrorException

ItemNotFoundException

removeAdministrator

boolean removeAdministrator(String scope,
                            String username)
                     throws InternalErrorException,
                            ItemNotFoundException

Parameters:

scope -

username -

Returns:

Throws:

InternalErrorException

ItemNotFoundException