Package org.gcube.vomanagement.usermanagement.impl.ws

Class LiferayWSGroupManager

java.lang.Object

org.gcube.vomanagement.usermanagement.impl.ws.LiferayWSGroupManager

All Implemented Interfaces:

GroupManager

public class LiferayWSGroupManager
extends Object
implements GroupManager

Exploit Liferay JSON Web Service to perform GroupManager's operations.

Author:

Costantino Perciante at ISTI-CNR (costantino.perciante@isti.cnr.it)

Constructor Summary

Constructors

Constructor	Description
LiferayWSGroupManager(String user, String password, String host, String schema, int port)	In order to contact the json ws of Liferay, user and password are needed.

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)
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)

Methods inherited from class java.lang.Object

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

Constructor Details

LiferayWSGroupManager

public LiferayWSGroupManager(String user,
 String password,
 String host,
 String schema,
 int port)
                      throws Exception

In order to contact the json ws of Liferay, user and password are needed. The host in which the current JVM machine runs needs to be authorized.

Parameters:

user -

password -

host - the host to contact

port - the port number

schema - the schema (http/https) https is suggested!

Throws:

Exception

Method Details

createRootVO

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

Description copied from interface: GroupManager

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

Specified by:

createRootVO in interface GroupManager

Parameters:

rootVOName - the name

description - the description

Returns:

the instance of the yet created root VO

Throws:

UserManagementNameException

UserManagementSystemException

UserRetrievalFault

GroupRetrievalFault

UserManagementPortalException

createVO

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

Description copied from interface: GroupManager

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

Specified by:

createVO in interface GroupManager

Parameters:

virtualOrgName - the name you wish

Returns:

the instance of the yet created VO

Throws:

UserManagementNameException

UserManagementSystemException

UserRetrievalFault

GroupRetrievalFault

UserManagementPortalException

createVRE

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

Description copied from interface: GroupManager

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

Specified by:

createVRE in interface GroupManager

Parameters:

virtualResearchEnvName - the name you wish for this VRE

description - the description

Returns:

the instance of the yet created root VRE

Throws:

UserManagementNameException

UserManagementSystemException

UserRetrievalFault

GroupRetrievalFault

UserManagementPortalException

getGroupParentId

public long getGroupParentId(long groupId)
                      throws UserManagementSystemException,
GroupRetrievalFault

Specified by:

getGroupParentId in interface GroupManager

Parameters:

groupId - the LR groupId

Returns:

the parent groupId if exists, -1 otherwise

Throws:

UserManagementSystemException

GroupRetrievalFault

getGroupId

public long getGroupId(String groupName)
                throws UserManagementSystemException,
GroupRetrievalFault

Specified by:

getGroupId in interface GroupManager

Parameters:

groupName - the VO/VRE name

Returns:

the LR groupId if exists, -1 otherwise

Throws:

UserManagementSystemException

GroupRetrievalFault

getGroup

public GCubeGroup getGroup(long groupId)
                    throws UserManagementSystemException,
GroupRetrievalFault

Specified by:

getGroup in interface GroupManager

Parameters:

groupId - the LR groupId

Returns:

an instance of @see GCubeGroup if exists, null otherwise

Throws:

UserManagementSystemException

GroupRetrievalFault

getVirtualGroups

public List<VirtualGroup> getVirtualGroups()
                                    throws VirtualGroupNotExistingException

Description copied from interface: GroupManager

Virtual Groups are handled as Custom attributes in Liferay Sites table

Specified by:

getVirtualGroups in interface GroupManager

Returns:

the virtual group list available

Throws:

VirtualGroupNotExistingException - if the virtual group does not exist

getVirtualGroups

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

Description copied from interface: GroupManager

Virtual Groups are handled as Custom attributes in Liferay Sites table

Specified by:

getVirtualGroups in interface GroupManager

Parameters:

actualGroupId - the LR groupId

Returns:

the virtual group name associated to this group

Throws:

GroupRetrievalFault - if the group does not exist

VirtualGroupNotExistingException - if the virtual group does not exist

getGroupIdFromInfrastructureScope

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

Specified by:

getGroupIdFromInfrastructureScope in interface GroupManager

Throws:

IllegalArgumentException

UserManagementSystemException

GroupRetrievalFault

getRootVO

public GCubeGroup getRootVO()
                     throws UserManagementSystemException,
GroupRetrievalFault

Specified by:

getRootVO in interface GroupManager

Returns:

an instance of @see GCubeGroup filled with the RootVO metadata

Throws:

UserManagementSystemException

GroupRetrievalFault

getRootVOName

public String getRootVOName()
                     throws UserManagementSystemException,
GroupRetrievalFault

Specified by:

getRootVOName in interface GroupManager

Returns:

the RootVO name

Throws:

UserManagementSystemException

GroupRetrievalFault

getInfrastructureScope

public String getInfrastructureScope(long groupId)
                              throws UserManagementSystemException,
GroupRetrievalFault

Specified by:

getInfrastructureScope in interface GroupManager

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

public String getScope(long groupId)
                throws UserManagementSystemException,
GroupRetrievalFault

Specified by:

getScope in interface GroupManager

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

public List<GCubeGroup> listGroups()
                            throws UserManagementSystemException,
GroupRetrievalFault

Description copied from interface: GroupManager

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

Specified by:

listGroups in interface GroupManager

Throws:

UserManagementSystemException

GroupRetrievalFault - if the rootVO does not exists

listGroupsByUser

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

Specified by:

listGroupsByUser in interface GroupManager

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

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

Description copied from interface: GroupManager

* @return the list of user VREs

Specified by:

listVresByUser in interface GroupManager

Throws:

UserManagementSystemException

GroupRetrievalFault - if the rootVO does not exists

UserRetrievalFault - if the user does not exists

listGroupsByUserAndSite

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

Specified by:

listGroupsByUserAndSite in interface GroupManager

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

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

Specified by:

listGroupsByUserAndSiteGroupId in interface GroupManager

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

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

Specified by:

listGroupsAndRolesByUser in interface GroupManager

Parameters:

userId - the LR userId

Returns:

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

Throws:

UserManagementSystemException

isRootVO

public Boolean isRootVO(long groupId)
                 throws UserManagementSystemException,
GroupRetrievalFault

Specified by:

isRootVO in interface GroupManager

Parameters:

groupId - the LR groupId

Returns:

true if the groupId is the RootVO, false otherwise

Throws:

UserManagementSystemException

GroupRetrievalFault

isVO

public Boolean isVO(long groupId)
             throws UserManagementSystemException,
GroupRetrievalFault

Specified by:

isVO in interface GroupManager

Parameters:

groupId - the LR groupId

Returns:

true if the groupId is a VO, false otherwise

Throws:

UserManagementSystemException

GroupRetrievalFault

isVRE

public Boolean isVRE(long groupId)
              throws UserManagementSystemException,
GroupRetrievalFault

Specified by:

isVRE in interface GroupManager

Parameters:

groupId - the LR groupId

Returns:

true if the groupId is a VRE, false otherwise

Throws:

UserManagementSystemException

GroupRetrievalFault

readCustomAttr

public Serializable readCustomAttr(long groupId,
 String attributeKey)
                            throws GroupRetrievalFault

Specified by:

readCustomAttr in interface GroupManager

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

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

Specified by:

saveCustomAttr in interface GroupManager

attributeKey - the name of the attribute you want to save

value - the value

Throws:

GroupRetrievalFault

updateGroupDescription

public String updateGroupDescription(long groupId,
 String description)
                              throws GroupRetrievalFault

Specified by:

updateGroupDescription in interface GroupManager

description - text to update

Returns:

the updated description

Throws:

GroupRetrievalFault

getGroupLogoURL

public String getGroupLogoURL(long logoId)

Specified by:

getGroupLogoURL in interface GroupManager

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 ... )

getGateways

public List<GCubeGroup> getGateways()

Description copied from interface: GroupManager

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

Specified by:

getGateways in interface GroupManager

Returns:

a list of gateways