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

Interface UserManager

public interface UserManager

Author:

valentina

Method Summary

Methods

Modifier and Type	Method and Description
boolean	associateUserToGroup(String scope, String username, String portalLogin) Associate a user with a scope group
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 groups
List<String>	getUsers() Get users
String	getVersionByUser(String user) getVersionByUser
Boolean	isGroup(String groupId) Check if a user is a group
boolean	removeAdministrator(String scope, String username, String portalLogin) Remove Administrator from a folder
boolean	removeUserFromGroup(String scope, String username, String portalLogin) Remove a user from a scope group
boolean	setAdministrator(String scope, String username, String portalLogin) Set Administrator to a folder
boolean	setVersionByUser(String user, String version) setVersionByUser

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 users

Returns:

a list of users

Throws:

InternalErrorException

getVersionByUser

String getVersionByUser(String user)
                        throws InternalErrorException

getVersionByUser

Parameters:

user -

Returns:

HL release version

Throws:

InternalErrorException

setVersionByUser

boolean setVersionByUser(String user,
                       String version)
                         throws InternalErrorException

setVersionByUser

Parameters:

user -

version - HL release version

Returns:

Throws:

InternalErrorException

getGroups

List<GCubeGroup> getGroups()
                           throws InternalErrorException

Get 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

boolean associateUserToGroup(String scope,
                           String username,
                           String portalLogin)
                             throws InternalErrorException,
                                    ItemNotFoundException

Associate a user with a scope group

Parameters:

scope: - VRE name

username: - an existing user

portalLogin -

Returns:

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

Throws:

InternalErrorException

ItemNotFoundException

removeUserFromGroup

boolean removeUserFromGroup(String scope,
                          String username,
                          String portalLogin)
                            throws InternalErrorException,
                                   ItemNotFoundException

Remove a user from a scope group

Parameters:

scope: - VRE name

username: - an existing user

portalLogin -

Returns:

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

Throws:

InternalErrorException

ItemNotFoundException

setAdministrator

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

Set Administrator to a folder

Parameters:

scope: - VRE name

username: - an existing user

portalLogin -

Returns:

Throws:

InternalErrorException

ItemNotFoundException

removeAdministrator

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

Remove Administrator from a folder

Parameters:

scope: - VRE name

username: - an existing user

portalLogin -

Returns:

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