Package org.gcube.vomanagement.usermanagement

Interface GroupManager

All Known Implementing Classes:

LiferayGroupManager, LiferayWSGroupManager

public interface GroupManager

This interface defines the class that manages the groups.

Author:

Massimiliano Assante, CNR-ISTI

Method Summary

Modifier and Type	Method	Description
GCubeGroup	createRootVO(String rootVOName, String description)	This method only creates the Group (site), no private or public pages are associated
GCubeGroup	createVO(String virtualOrgName, long rootVOGroupId, String description)	This method only creates the Group (site), no private or public pages are associated
GCubeGroup	createVRE(String virtualResearchEnvName, long virtualOrgGroupId, String description)	This method only creates the Group (site), no private or public pages are associated
List<GCubeGroup>	getGateways()	Retrieve the list of GCubeGroups that are Gateways (i.e. groups with no father and children).
GCubeGroup	getGroup(long groupId)
long	getGroupId(String groupName)
long	getGroupIdFromInfrastructureScope(String scope)
String	getGroupLogoURL(long logoId)
long	getGroupParentId(long groupId)
String	getInfrastructureScope(long groupId)
GCubeGroup	getRootVO()
String	getRootVOName()
String	getScope(long groupId)	Deprecated. please use getInfrastructureScope(long groupId)
List<VirtualGroup>	getVirtualGroups()	Virtual Groups are handled as Custom attributes in Liferay Sites table
List<VirtualGroup>	getVirtualGroups(long actualGroupId)	Virtual Groups are handled as Custom attributes in Liferay Sites table
Boolean	isRootVO(long groupId)
Boolean	isVO(long groupId)
Boolean	isVRE(long groupId)
List<GCubeGroup>	listGroups()	* @return a flat list of VOs and VREs present in this gateway mapped as @see GCubeGroup
Map<GCubeGroup,List<GCubeRole>>	listGroupsAndRolesByUser(long userId)
List<GCubeGroup>	listGroupsByUser(long userId)
Set<GCubeGroup>	listGroupsByUserAndSite(long userId, String serverName)
Set<GCubeGroup>	listGroupsByUserAndSiteGroupId(long userId, long siteGroupId)
List<GCubeGroup>	listVresByUser(long userId)	* @return the list of user VREs
Serializable	readCustomAttr(long groupId, String attributeKey)
void	saveCustomAttr(long groupId, String attributeKey, Serializable value)
String	updateGroupDescription(long groupId, String description)

Method Details

createRootVO

GCubeGroup createRootVO(String rootVOName,
 String description)
                 throws UserManagementNameException,
UserManagementSystemException,
UserRetrievalFault,
GroupRetrievalFault,
UserManagementPortalException

This method only creates the Group (site), no private or public pages are associated

Parameters:

rootVOName - the name

description - the description

Returns:

the instance of the yet created root VO

Throws:

UserManagementNameException

UserManagementSystemException

UserRetrievalFault

GroupRetrievalFault

UserManagementPortalException

createVO

GCubeGroup createVO(String virtualOrgName,
 long rootVOGroupId,
 String description)
             throws UserManagementNameException,
UserManagementSystemException,
UserRetrievalFault,
GroupRetrievalFault,
UserManagementPortalException

This method only creates the Group (site), no private or public pages are associated

Parameters:

virtualOrgName - the name you wish

rootVOGroupId -

description -

Returns:

the instance of the yet created VO

Throws:

UserManagementNameException

UserManagementSystemException

UserRetrievalFault

GroupRetrievalFault

UserManagementPortalException

createVRE

GCubeGroup createVRE(String virtualResearchEnvName,
 long virtualOrgGroupId,
 String description)
              throws UserManagementNameException,
UserManagementSystemException,
UserRetrievalFault,
GroupRetrievalFault,
UserManagementPortalException

This method only creates the Group (site), no private or public pages are associated

Parameters:

virtualResearchEnvName - the name you wish for this VRE

virtualOrgGroupId -

description - the description

Returns:

the instance of the yet created root VRE

Throws:

UserManagementNameException

UserManagementSystemException

UserRetrievalFault

GroupRetrievalFault

UserManagementPortalException

getGroupParentId

long getGroupParentId(long groupId)
               throws UserManagementSystemException,
GroupRetrievalFault

Parameters:

groupId - the LR groupId

Returns:

the parent groupId if exists, -1 otherwise

Throws:

UserManagementSystemException

GroupRetrievalFault

getGroupId

long getGroupId(String groupName)
         throws UserManagementSystemException,
GroupRetrievalFault

Parameters:

groupName - the VO/VRE name

Returns:

the LR groupId if exists, -1 otherwise

Throws:

UserManagementSystemException

GroupRetrievalFault

getGroup

GCubeGroup getGroup(long groupId)
             throws UserManagementSystemException,
GroupRetrievalFault

Parameters:

groupId - the LR groupId

Returns:

an instance of @see GCubeGroup if exists, null otherwise

Throws:

UserManagementSystemException

GroupRetrievalFault

getVirtualGroups

List<VirtualGroup> getVirtualGroups()
                             throws VirtualGroupNotExistingException

Virtual Groups are handled as Custom attributes in Liferay Sites table

Returns:

the virtual group list available

Throws:

VirtualGroupNotExistingException - if the virtual group does not exist

getVirtualGroups

List<VirtualGroup> getVirtualGroups(long actualGroupId)
                             throws GroupRetrievalFault,
VirtualGroupNotExistingException

Virtual Groups are handled as Custom attributes in Liferay Sites table

Parameters:

actualGroupId - the LR groupId

Returns:

the virtual group name associated to this group

Throws:

GroupRetrievalFault

VirtualGroupNotExistingException

getGroupIdFromInfrastructureScope

long getGroupIdFromInfrastructureScope(String scope)
                                throws IllegalArgumentException,
UserManagementSystemException,
GroupRetrievalFault

Throws:

IllegalArgumentException

UserManagementSystemException

GroupRetrievalFault

getRootVO

GCubeGroup getRootVO()
              throws UserManagementSystemException,
GroupRetrievalFault

Returns:

an instance of @see GCubeGroup filled with the RootVO metadata

Throws:

UserManagementSystemException

GroupRetrievalFault

getRootVOName

String getRootVOName()
              throws UserManagementSystemException,
GroupRetrievalFault

Returns:

the RootVO name

Throws:

UserManagementSystemException

GroupRetrievalFault

getInfrastructureScope

String getInfrastructureScope(long groupId)
                       throws UserManagementSystemException,
GroupRetrievalFault

Parameters:

groupId - the LR groupId

Returns:

the infrastructure scope given the groupId e.g. for devsec VO would return /gcube/devsec

Throws:

UserManagementSystemException

GroupRetrievalFault

getScope

String getScope(long groupId)
         throws UserManagementSystemException,
GroupRetrievalFault

Deprecated.

please use getInfrastructureScope(long groupId)

Parameters:

groupId - the LR groupId

Returns:

the infrastructure scope given the groupId e.g. for devsec VO would return /gcube/devsec

Throws:

UserManagementSystemException

GroupRetrievalFault

listGroups

List<GCubeGroup> listGroups()
                     throws UserManagementSystemException,
GroupRetrievalFault

* @return a flat list of VOs and VREs present in this gateway mapped as @see GCubeGroup

Throws:

UserManagementSystemException

GroupRetrievalFault - if the rootVO does not exists

listGroupsByUser

List<GCubeGroup> listGroupsByUser(long userId)
                           throws UserRetrievalFault,
UserManagementSystemException,
GroupRetrievalFault

Parameters:

userId - the LR userId

Returns:

a flat list of VOs and VREs where the user is registered as @see GCubeGroup

Throws:

UserRetrievalFault

UserManagementSystemException

GroupRetrievalFault

listVresByUser

List<GCubeGroup> listVresByUser(long userId)
                         throws UserManagementSystemException,
GroupRetrievalFault,
UserRetrievalFault

* @return the list of user VREs

Throws:

UserManagementSystemException

GroupRetrievalFault - if the rootVO does not exists

UserRetrievalFault

listGroupsByUserAndSite

Set<GCubeGroup> listGroupsByUserAndSite(long userId,
 String serverName)
                                 throws UserRetrievalFault,
UserManagementSystemException,
GroupRetrievalFault,
VirtualGroupNotExistingException

Parameters:

userId - the LR userId

serverName - the host name of the server that is sending the request (e.g. i-marine.d4science.org)

Returns:

a set of VREs where the user is registered as @see GCubeGroup on the current Site (e.g i-marine.d4science.org)

Throws:

UserRetrievalFault

UserManagementSystemException

GroupRetrievalFault

VirtualGroupNotExistingException

listGroupsByUserAndSiteGroupId

Set<GCubeGroup> listGroupsByUserAndSiteGroupId(long userId,
 long siteGroupId)
                                        throws UserRetrievalFault,
UserManagementSystemException,
GroupRetrievalFault,
VirtualGroupNotExistingException

Parameters:

userId - the LR userId

siteGroupId - the LR groupId from which is sending the request

Returns:

a set of VREs where the user is registered as @see GCubeGroup on the current Site (e.g i-marine.d4science.org)

Throws:

UserRetrievalFault

UserManagementSystemException

GroupRetrievalFault

VirtualGroupNotExistingException

listGroupsAndRolesByUser

Map<GCubeGroup,List<GCubeRole>> listGroupsAndRolesByUser(long userId)
                                                  throws UserManagementSystemException

Parameters:

userId - the LR userId

Returns:

a map contaiting the users groups and his roles in the group

Throws:

UserManagementSystemException

isRootVO

Boolean isRootVO(long groupId)
          throws UserManagementSystemException,
GroupRetrievalFault

Parameters:

groupId - the LR groupId

Returns:

true if the groupId is the RootVO, false otherwise

Throws:

UserManagementSystemException

GroupRetrievalFault

isVO

Boolean isVO(long groupId)
      throws UserManagementSystemException,
GroupRetrievalFault

Parameters:

groupId - the LR groupId

Returns:

true if the groupId is a VO, false otherwise

Throws:

UserManagementSystemException

GroupRetrievalFault

isVRE

Boolean isVRE(long groupId)
       throws UserManagementSystemException,
GroupRetrievalFault

Parameters:

groupId - the LR groupId

Returns:

true if the groupId is a VRE, false otherwise

Throws:

UserManagementSystemException

GroupRetrievalFault

readCustomAttr

Serializable readCustomAttr(long groupId,
 String attributeKey)
                     throws GroupRetrievalFault

Parameters:

groupId - the LR groupId

attributeKey - the name of the attribute you want to read its value

Returns:

the attributeKey value if existing, null otherwise

Throws:

GroupRetrievalFault

saveCustomAttr

void saveCustomAttr(long groupId,
 String attributeKey,
 Serializable value)
             throws GroupRetrievalFault

Parameters:

groupId -

attributeKey - the name of the attribute you want to save

value - the value

Throws:

GroupRetrievalFault

updateGroupDescription

String updateGroupDescription(long groupId,
 String description)
                       throws GroupRetrievalFault

Parameters:

groupId -

description - text to update

Returns:

the updated description

Throws:

GroupRetrievalFault

getGroupLogoURL

String getGroupLogoURL(long logoId)
                throws GroupRetrievalFault

Parameters:

logoId - the logo identifier of the group @see {GCubeGroup#logoId}

Returns:

the absolute path on server for the logo (e.g. /image/layout_set_logo?img_id ... )

Throws:

GroupRetrievalFault - the group retrieval fault

getGateways

List<GCubeGroup> getGateways()

Retrieve the list of GCubeGroups that are Gateways (i.e. groups with no father and children).

Returns:

a list of gateways