Package cz.metacentrum.perun.core.impl

Class VosManagerImpl

java.lang.Object

cz.metacentrum.perun.core.impl.VosManagerImpl

All Implemented Interfaces:

VosManagerImplApi

public class VosManagerImpl
extends Object
implements VosManagerImplApi

VosManager implementation.

Author:

Michal Prochazka michalp@ics.muni.cz, Slavek Licehammer glory@ics.muni.cz

Field Summary

Fields

Modifier and Type	Field	Description
protected static final RowMapper<BanOnVo>	BAN_ON_VO_MAPPER
protected static final String	BAN_ON_VO_MAPPING_SELECT_QUERY
static final String	PERSON_TYPE
static final String	STEM
static final String	VO_GROUPS_STEM
protected static final RowMapper<Vo>	VO_MAPPER	Converts s ResultSet's row to a Vo instance.
protected static final String	VO_MAPPING_SELECT_QUERY
static final String	VO_RESOURCES_STEM
static final String	VO_SUBGROUPS_STEM

Constructor Summary

Constructors

Constructor	Description
VosManagerImpl(DataSource perunPool)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addMemberVo(PerunSession sess, Vo vo, Vo memberVo)	Adds new relationship between vo and a member vo.
void	checkVoExists(PerunSession sess, Vo vo)	Check if vo exists in underlaying data source.
void	createApplicationForm(PerunSession sess, Vo vo)	Creates empty application form definition for VO when VO is created
Vo	createVo(PerunSession sess, Vo vo)	Create new VO.
Vo	deleteVo(PerunSession sess, Vo vo)	Delete VO.
void	deleteVoApplicationForm(PerunSession sess, Vo vo)
List<Group>	getAdminGroups(PerunSession sess, Vo vo)	Deprecated.
List<Group>	getAdminGroups(PerunSession sess, Vo vo, String role)	Get list of group administrators of the given VO for specific role.
List<User>	getAdmins(PerunSession sess, Vo vo)	Deprecated.
List<User>	getAdmins(PerunSession sess, Vo vo, String role)	Get list of user administrators of specific vo for specific role.
List<BanOnVo>	getAllExpiredBansOnVos(PerunSession sess)	Returns expired bans across all vos
BanOnVo	getBanById(PerunSession sess, int banId)	Get ban by its id.
BanOnVo	getBanForMember(PerunSession sess, int memberId)	Get ban for given member or NULL if there is no ban.
List<BanOnVo>	getBansForUser(PerunSession sess, int userId)	Gets all rich bans for given user.
List<BanOnVo>	getBansForVo(PerunSession sess, int voId)	Get list of all bans for vo with given id.
List<User>	getDirectAdmins(PerunSession sess, Vo vo)	Deprecated.
List<User>	getDirectAdmins(PerunSession sess, Vo vo, String role)	Get list of direct user administrators of specific vo for specific role.
List<Vo>	getMemberVos(PerunSession sess, int voId)	Gets all member organizations of the given vo.
List<Vo>	getParentVos(PerunSession sess, int memberVoId)	Gets all organizations where given vo is direct member.
List<Integer>	getVoApplicationIds(PerunSession sess, Vo vo)	Return list of IDs of all applications, which belongs to VO.
Vo	getVoById(PerunSession sess, int id)	Finds existing VO by id.
Vo	getVoByShortName(PerunSession sess, String shortName)	Find existing VO by short name (short name is unique).
List<Vo>	getVos(PerunSession sess)	Get list of all Vos.
List<Vo>	getVosByIds(PerunSession perunSession, List<Integer> ids)	Gets VOs by their ids.
int	getVosCount(PerunSession sess)	Get count of all vos.
boolean	hasEmbeddedGroupsItemInForm(PerunSession sess, int voId)	Returns true, if there is a vo with given id which has application form with the EMBEDDED_GROUP_APPLICATION item in it.
boolean	isMemberBanned(PerunSession sess, int memberId)	Information if there is a ban for member with given id.
void	removeBan(PerunSession sess, int banId)	Removes ban with given id.
void	removeMemberVo(PerunSession sess, Vo vo, Vo memberVo)	Removes member vo from given vo.
List<Vo>	searchForVos(PerunSession sess, String searchString, boolean includeIDs)	Similarity substring search in all VOs based on shortname and description
List<Vo>	searchForVos(PerunSession sess, String searchString, Set<Integer> voIds, boolean includeIDs)	Similarity substring search in provided VOs based on shortname and description
BanOnVo	setBan(PerunSession sess, BanOnVo banOnVo)	Set given ban.
boolean	shortNameForVoExists(PerunSession sess, Vo vo)
BanOnVo	updateBan(PerunSession sess, BanOnVo banOnVo)	Update ban information.
Vo	updateVo(PerunSession sess, Vo vo)	Updates VO.
boolean	voExists(PerunSession sess, Vo vo)	Check if vo exists in underlaying data source.

Methods inherited from class java.lang.Object

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

Field Details

STEM

public static final String STEM

See Also:

• Constant Field Values

VO_GROUPS_STEM

public static final String VO_GROUPS_STEM

See Also:

• Constant Field Values

VO_SUBGROUPS_STEM

public static final String VO_SUBGROUPS_STEM

See Also:

• Constant Field Values

VO_RESOURCES_STEM

public static final String VO_RESOURCES_STEM

See Also:

• Constant Field Values

PERSON_TYPE

public static final String PERSON_TYPE

See Also:

• Constant Field Values

VO_MAPPING_SELECT_QUERY

protected static final String VO_MAPPING_SELECT_QUERY

See Also:

• Constant Field Values

BAN_ON_VO_MAPPING_SELECT_QUERY

protected static final String BAN_ON_VO_MAPPING_SELECT_QUERY

See Also:

• Constant Field Values

VO_MAPPER

protected static final RowMapper<Vo> VO_MAPPER

Converts s ResultSet's row to a Vo instance.

BAN_ON_VO_MAPPER

protected static final RowMapper<BanOnVo> BAN_ON_VO_MAPPER

Constructor Details

VosManagerImpl

public VosManagerImpl(DataSource perunPool)

Constructor.

Parameters:

perunPool - connection pool instance

Method Details

addMemberVo

public void addMemberVo(PerunSession sess,
 Vo vo,
 Vo memberVo)
                 throws RelationExistsException

Description copied from interface: VosManagerImplApi

Adds new relationship between vo and a member vo.

Specified by:

addMemberVo in interface VosManagerImplApi

Parameters:

sess - session

vo - vo

memberVo - new member of the vo

Throws:

RelationExistsException - if member vo is already member of the vo

checkVoExists

public void checkVoExists(PerunSession sess,
 Vo vo)
                   throws VoNotExistsException

Description copied from interface: VosManagerImplApi

Check if vo exists in underlaying data source.

Specified by:

checkVoExists in interface VosManagerImplApi

Parameters:

sess -

vo -

Throws:

VoNotExistsException

createApplicationForm

public void createApplicationForm(PerunSession sess,
 Vo vo)

Description copied from interface: VosManagerImplApi

Creates empty application form definition for VO when VO is created

Specified by:

createApplicationForm in interface VosManagerImplApi

Parameters:

sess -

vo -

createVo

public Vo createVo(PerunSession sess,
 Vo vo)
            throws VoExistsException

Description copied from interface: VosManagerImplApi

Create new VO.

Specified by:

createVo in interface VosManagerImplApi

Parameters:

sess -

vo -

Returns:

newly created VO

Throws:

VoExistsException

deleteVo

public Vo deleteVo(PerunSession sess,
 Vo vo)

Description copied from interface: VosManagerImplApi

Delete VO.

Specified by:

deleteVo in interface VosManagerImplApi

Parameters:

sess -

vo -

Returns:

deleted VO

deleteVoApplicationForm

public void deleteVoApplicationForm(PerunSession sess,
 Vo vo)

getAdminGroups

public List<Group> getAdminGroups(PerunSession sess,
 Vo vo,
 String role)

Description copied from interface: VosManagerImplApi

Get list of group administrators of the given VO for specific role.

Specified by:

getAdminGroups in interface VosManagerImplApi

Parameters:

sess -

vo -

Returns:

List of groups, who are administrators of the Vo with specific role. Returns empty list if there is no such authorized group.

getAdminGroups

@Deprecated
public List<Group> getAdminGroups(PerunSession sess,
 Vo vo)

Deprecated.

Description copied from interface: VosManagerImplApi

Get list of group administrators of the given VO.

Specified by:

getAdminGroups in interface VosManagerImplApi

Parameters:

sess -

vo -

Returns:

List of groups, who are administrators of the Vo. Returns empty list if there is no VO group admin.

getAdmins

public List<User> getAdmins(PerunSession sess,
 Vo vo,
 String role)

Description copied from interface: VosManagerImplApi

Get list of user administrators of specific vo for specific role. If some group is administrator of the VO, all VALID members are included in the list.

Specified by:

getAdmins in interface VosManagerImplApi

Parameters:

sess -

vo -

role -

Returns:

List of users who are administrators of the vo with specific role. Empty list if there is no such administrator

getAdmins

@Deprecated
public List<User> getAdmins(PerunSession sess,
 Vo vo)

Deprecated.

Description copied from interface: VosManagerImplApi

Get list of Vo administrators. If some group is administrator of the VO, all members are included in the list.

Specified by:

getAdmins in interface VosManagerImplApi

Parameters:

sess -

vo -

Returns:

List of users, who are administrators of the Vo. Returns empty list if there is no VO admin.

getAllExpiredBansOnVos

public List<BanOnVo> getAllExpiredBansOnVos(PerunSession sess)

Description copied from interface: VosManagerImplApi

Returns expired bans across all vos

Specified by:

getAllExpiredBansOnVos in interface VosManagerImplApi

Parameters:

sess -

Returns:

all expired bans

getBanById

public BanOnVo getBanById(PerunSession sess,
 int banId)
                   throws BanNotExistsException

Description copied from interface: VosManagerImplApi

Get ban by its id.

Specified by:

getBanById in interface VosManagerImplApi

Parameters:

sess - session

banId - ban id

Returns:

ban object

Throws:

BanNotExistsException - if ban with given id is not found

getBanForMember

public BanOnVo getBanForMember(PerunSession sess,
 int memberId)

Description copied from interface: VosManagerImplApi

Get ban for given member or NULL if there is no ban.

Specified by:

getBanForMember in interface VosManagerImplApi

Parameters:

sess - session

memberId - member id

Returns:

ban object or NULL

getBansForUser

public List<BanOnVo> getBansForUser(PerunSession sess,
 int userId)

Description copied from interface: VosManagerImplApi

Gets all rich bans for given user.

Specified by:

getBansForUser in interface VosManagerImplApi

Parameters:

sess - session

userId - user id

Returns:

getBansForVo

public List<BanOnVo> getBansForVo(PerunSession sess,
 int voId)

Description copied from interface: VosManagerImplApi

Get list of all bans for vo with given id.

Specified by:

getBansForVo in interface VosManagerImplApi

Parameters:

sess - session

voId - vo id

Returns:

list of bans for given vo

getDirectAdmins

public List<User> getDirectAdmins(PerunSession sess,
 Vo vo,
 String role)

Description copied from interface: VosManagerImplApi

Get list of direct user administrators of specific vo for specific role. 'Direct' means, there aren't included users, who are members of group administrators, in the returned list.

Specified by:

getDirectAdmins in interface VosManagerImplApi

Parameters:

sess -

vo -

role -

Returns:

List of direct users who are administrators of the vo with specific role. Empty list if there is no such administrator

getDirectAdmins

@Deprecated
public List<User> getDirectAdmins(PerunSession sess,
 Vo vo)

Deprecated.

Description copied from interface: VosManagerImplApi

Gets list of direct user administrators of the VO. 'Direct' means, there aren't included users, who are members of group administrators, in the returned list.

Specified by:

getDirectAdmins in interface VosManagerImplApi

Parameters:

sess -

vo -

getMemberVos

public List<Vo> getMemberVos(PerunSession sess,
 int voId)

Description copied from interface: VosManagerImplApi

Gets all member organizations of the given vo.

Specified by:

getMemberVos in interface VosManagerImplApi

Parameters:

sess - session

voId - vo id

Returns:

list of member vos

getParentVos

public List<Vo> getParentVos(PerunSession sess,
 int memberVoId)

Description copied from interface: VosManagerImplApi

Gets all organizations where given vo is direct member.

Specified by:

getParentVos in interface VosManagerImplApi

Parameters:

sess - session

memberVoId - member vo id

Returns:

list of direct parent vos

getVoApplicationIds

public List<Integer> getVoApplicationIds(PerunSession sess,
 Vo vo)

Description copied from interface: VosManagerImplApi

Return list of IDs of all applications, which belongs to VO.

Specified by:

getVoApplicationIds in interface VosManagerImplApi

Parameters:

sess -

vo -

Returns:

list of all vo applications ids

getVoById

public Vo getVoById(PerunSession sess,
 int id)
             throws VoNotExistsException

Description copied from interface: VosManagerImplApi

Finds existing VO by id.

Specified by:

getVoById in interface VosManagerImplApi

Parameters:

sess -

id - id of the VO you are looking for

Returns:

found VO

Throws:

VoNotExistsException

getVoByShortName

public Vo getVoByShortName(PerunSession sess,
 String shortName)
                    throws VoNotExistsException

Description copied from interface: VosManagerImplApi

Find existing VO by short name (short name is unique).

Specified by:

getVoByShortName in interface VosManagerImplApi

Parameters:

sess -

shortName -

Returns:

vo

Throws:

VoNotExistsException

getVos

public List<Vo> getVos(PerunSession sess)

Description copied from interface: VosManagerImplApi

Get list of all Vos.

Specified by:

getVos in interface VosManagerImplApi

Parameters:

sess -

Returns:

List of VOs

getVosByIds

public List<Vo> getVosByIds(PerunSession perunSession,
 List<Integer> ids)

Description copied from interface: VosManagerImplApi

Gets VOs by their ids. Silently skips non-existing VOs.

Specified by:

getVosByIds in interface VosManagerImplApi

Parameters:

perunSession -

ids -

Returns:

List of VOs with specified ids

getVosCount

public int getVosCount(PerunSession sess)

Description copied from interface: VosManagerImplApi

Get count of all vos.

Specified by:

getVosCount in interface VosManagerImplApi

Parameters:

sess -

Returns:

count of all vos

hasEmbeddedGroupsItemInForm

public boolean hasEmbeddedGroupsItemInForm(PerunSession sess,
 int voId)

Description copied from interface: VosManagerImplApi

Returns true, if there is a vo with given id which has application form with the EMBEDDED_GROUP_APPLICATION item in it.

Specified by:

hasEmbeddedGroupsItemInForm in interface VosManagerImplApi

Parameters:

sess - session

voId - vo id

Returns:

true, if there is a vo with given id which has application form with the EMBEDDED_GROUP_APPLICATION item in it, false otherwise

isMemberBanned

public boolean isMemberBanned(PerunSession sess,
 int memberId)

Description copied from interface: VosManagerImplApi

Information if there is a ban for member with given id.

Specified by:

isMemberBanned in interface VosManagerImplApi

Parameters:

sess - session

memberId - member id

Returns:

true, if member with given id is banned, false otherwise

removeBan

public void removeBan(PerunSession sess,
 int banId)
               throws BanNotExistsException

Description copied from interface: VosManagerImplApi

Removes ban with given id.

Specified by:

removeBan in interface VosManagerImplApi

Parameters:

sess - session

banId - ban id

Throws:

BanNotExistsException - if there is no ban with given id

removeMemberVo

public void removeMemberVo(PerunSession sess,
 Vo vo,
 Vo memberVo)
                    throws RelationNotExistsException

Description copied from interface: VosManagerImplApi

Removes member vo from given vo.

Specified by:

removeMemberVo in interface VosManagerImplApi

Parameters:

sess - session

vo - vo

memberVo - vo to be removed

Throws:

RelationNotExistsException - if member vo is not a member of the vo

searchForVos

public List<Vo> searchForVos(PerunSession sess,
 String searchString,
 boolean includeIDs)

Description copied from interface: VosManagerImplApi

Similarity substring search in all VOs based on shortname and description

Specified by:

searchForVos in interface VosManagerImplApi

Parameters:

sess - session

searchString - string to search for

includeIDs - whether to search in IDs as well, used for PERUNADMINs

Returns:

list of matched vos

searchForVos

public List<Vo> searchForVos(PerunSession sess,
 String searchString,
 Set<Integer> voIds,
 boolean includeIDs)

Description copied from interface: VosManagerImplApi

Similarity substring search in provided VOs based on shortname and description

Specified by:

searchForVos in interface VosManagerImplApi

Parameters:

sess - session

searchString - string to search for

voIds - VO IDs in which to perform the search

includeIDs - whether to search in IDs as well, used for PERUNADMINs

Returns:

list of matched vos

setBan

public BanOnVo setBan(PerunSession sess,
 BanOnVo banOnVo)

Description copied from interface: VosManagerImplApi

Set given ban.

Specified by:

setBan in interface VosManagerImplApi

Parameters:

sess - session

banOnVo - ban information, memberId, voId, validity and description are needed

Returns:

created ban object

shortNameForVoExists

public boolean shortNameForVoExists(PerunSession sess,
 Vo vo)

updateBan

public BanOnVo updateBan(PerunSession sess,
 BanOnVo banOnVo)

Description copied from interface: VosManagerImplApi

Update ban information. Only description and validity are updated.

Specified by:

updateBan in interface VosManagerImplApi

Parameters:

sess - session

banOnVo - updated ban

Returns:

updated ban object

updateVo

public Vo updateVo(PerunSession sess,
 Vo vo)

Description copied from interface: VosManagerImplApi

Updates VO.

Specified by:

updateVo in interface VosManagerImplApi

Parameters:

sess -

vo -

Returns:

returns updated VO

voExists

public boolean voExists(PerunSession sess,
 Vo vo)

Description copied from interface: VosManagerImplApi

Check if vo exists in underlaying data source.

Specified by:

voExists in interface VosManagerImplApi

Parameters:

sess -

vo -

Returns:

true if vo exists in underlaying data source, false otherwise