nl.surfnet.coin.teams.service.impl

Class GrouperTeamServiceWsImpl

java.lang.Object

nl.surfnet.coin.teams.service.impl.GrouperTeamServiceWsImpl

All Implemented Interfaces:

GrouperTeamService

public class GrouperTeamServiceWsImpl
extends Object
implements GrouperTeamService

GrouperTeamService using Grouper LDAP as persistent store

Constructor Summary

Constructors

Constructor and Description
GrouperTeamServiceWsImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	addMember(String teamId, nl.surfnet.coin.api.client.domain.Person person) Adds a person to the team
boolean	addMemberRole(String teamId, String memberId, Role role, String actAsUserId) Add Role to a Team
String	addTeam(String teamId, String displayName, String teamDescription, String stemName) Add a Team.
void	deleteMember(String teamId, String personId) Delete a Member from a Team
void	deleteTeam(String teamId) Delete a Team
Set<Member>	findAdmins(Team team) Returns a Set of Member's that have the admin role for this team
TeamResultWrapper	findAllTeamsByMember(String personId, int offset, int pageSize) Return all teams using a specific stem where the personId is a member
Member	findMember(String teamId, String memberId) Tries to find a Member in a Team
TeamResultWrapper	findPublicTeams(String personId, String partOfGroupname) Return all teams using a specific stem with a name like, , without the teams being private except if the personId is a member of the private team
Stem	findStem(String stemId)
List<Stem>	findStemsByMember(String personId) Return all stems for a person
Team	findTeamById(String teamId) Find Team by id
TeamResultWrapper	findTeamsByMember(String personId, String partOfGroupname, int offset, int pageSize) Return all teams using a specific stem with a name like where the personId is a member
String	getGrouperPowerUser()
int	pagenumber(int offset, int pageSize) Get a page number by the given offset and pageSize.
boolean	removeMemberRole(String teamId, String memberId, Role role, String actAsUserId) Remove Role to a Team
void	setEnvironment(TeamEnvironment environment)
void	setVisibilityGroup(String teamId, boolean viewable) Update the Team to be (not) visible
protected String	teamIdWithContext(String teamId) Prepend the teamId with the (environment specific) context.
void	updateTeam(String teamId, String displayName, String teamDescription, String actAsSubject) Update a Team

Methods inherited from class java.lang.Object

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

Constructor Detail

GrouperTeamServiceWsImpl

public GrouperTeamServiceWsImpl()

Method Detail

findTeamById

public Team findTeamById(String teamId)

Find Team by id

Specified by:

findTeamById in interface GrouperTeamService

Parameters:

teamId - unique identifier for a Team

Returns:

Team with all members

findStem

public Stem findStem(String stemId)

Specified by:

findStem in interface GrouperTeamService

addTeam

public String addTeam(String teamId,
             String displayName,
             String teamDescription,
             String stemName)
               throws DuplicateTeamException

Add a Team. Note that the teamId is altered if not compliant to the rules for correct id's.

Specified by:

addTeam in interface GrouperTeamService

Parameters:

teamId - the teamId

displayName - the displayName

teamDescription - description of the team

stemName - name of the stem

Returns:

The id of the team

Throws:

DuplicateTeamException - when a team with with the given teamId already exists.

deleteMember

public void deleteMember(String teamId,
                String personId)

Delete a Member from a Team

Specified by:

deleteMember in interface GrouperTeamService

Parameters:

teamId - the unique identifier for a Team

personId - the unique identifier for a Member

deleteTeam

public void deleteTeam(String teamId)

Delete a Team

Specified by:

deleteTeam in interface GrouperTeamService

Parameters:

teamId - the unique identifier

updateTeam

public void updateTeam(String teamId,
              String displayName,
              String teamDescription,
              String actAsSubject)

Update a Team

Specified by:

updateTeam in interface GrouperTeamService

Parameters:

teamId - the id of a Team

displayName - the new displayName

teamDescription - the new description of the Team

actAsSubject - the unique identifier that performs the request in Grouper. Can be the power user or the memberId

setVisibilityGroup

public void setVisibilityGroup(String teamId,
                      boolean viewable)

Update the Team to be (not) visible

Specified by:

setVisibilityGroup in interface GrouperTeamService

Parameters:

teamId - unique identifier for a Team

viewable - boolean

addMemberRole

public boolean addMemberRole(String teamId,
                    String memberId,
                    Role role,
                    String actAsUserId)

Add Role to a Team

Specified by:

addMemberRole in interface GrouperTeamService

Parameters:

teamId - the unique identifier of a Team

memberId - the unique identifier of a Member

role - the Role to be added

actAsUserId - the unique identifier that performs the request in Grouper. Can be the power user or the memberId

Returns:

boolean true if the Role has been successfully added false if the Role has not been added

removeMemberRole

public boolean removeMemberRole(String teamId,
                       String memberId,
                       Role role,
                       String actAsUserId)

Remove Role to a Team

Specified by:

removeMemberRole in interface GrouperTeamService

Parameters:

teamId - the unique identifier of a Team

memberId - the unique identifier of a Member

role - the Role to be removed

actAsUserId - the unique identifier that performs the request in Grouper. Can be the power user of the memberId

Returns:

boolean true if the Role has been successfully added false if the Role has not been added

addMember

public void addMember(String teamId,
             nl.surfnet.coin.api.client.domain.Person person)

Adds a person to the team

Specified by:

addMember in interface GrouperTeamService

Parameters:

teamId - the unique identifier of the Team

person - Person to add as Member to the Team

findMember

public Member findMember(String teamId,
                String memberId)

Tries to find a Member in a Team

Specified by:

findMember in interface GrouperTeamService

Parameters:

teamId - the unique identifier of the Team

memberId - the unique identifier of a Member

Returns:

Member or null if the Team does not contain a Member by the memberId

findAdmins

public Set<Member> findAdmins(Team team)

Returns a Set of Member's that have the admin role for this team

Specified by:

findAdmins in interface GrouperTeamService

Parameters:

team - Team

Returns:

Set of Member's with admin role, can be empty

setEnvironment

public void setEnvironment(TeamEnvironment environment)

Parameters:

environment - the environment to set

findPublicTeams

public TeamResultWrapper findPublicTeams(String personId,
                                String partOfGroupname)

Description copied from interface: GrouperTeamService

Return all teams using a specific stem with a name like, , without the teams being private except if the personId is a member of the private team

Specified by:

findPublicTeams in interface GrouperTeamService

Parameters:

personId - the logged in person

partOfGroupname - part of group name

Returns:

teams including the number of total records

findAllTeamsByMember

public TeamResultWrapper findAllTeamsByMember(String personId,
                                     int offset,
                                     int pageSize)

Description copied from interface: GrouperTeamService

Return all teams using a specific stem where the personId is a member

Specified by:

findAllTeamsByMember in interface GrouperTeamService

Parameters:

personId - the logged in person

offset - the row number of the start

pageSize - the maximum result size

Returns:

teams including the number of total records

pagenumber

public int pagenumber(int offset,
             int pageSize)

Get a page number by the given offset and pageSize.

findTeamsByMember

public TeamResultWrapper findTeamsByMember(String personId,
                                  String partOfGroupname,
                                  int offset,
                                  int pageSize)

Description copied from interface: GrouperTeamService

Return all teams using a specific stem with a name like where the personId is a member

Specified by:

findTeamsByMember in interface GrouperTeamService

Parameters:

personId - the logged in person

partOfGroupname - part of group name

offset - the row number of the start

pageSize - the maximum result size

Returns:

teams including the number of total records

findStemsByMember

public List<Stem> findStemsByMember(String personId)

Description copied from interface: GrouperTeamService

Return all stems for a person

Specified by:

findStemsByMember in interface GrouperTeamService

Parameters:

personId - String the identifier of the logged in person

Returns:

List the list with stems that this user is a member of.

getGrouperPowerUser

public String getGrouperPowerUser()

teamIdWithContext

protected String teamIdWithContext(String teamId)

Prepend the teamId with the (environment specific) context. E.g.: urn:collab:group:surfteams.nl:

Parameters:

teamId - the teamId without context (e.g.: nl:surfnet:diensten:mygroup)

Returns:

the concatenation: urn:collab:group:surfteams.nl:nl:surfnet:diensten:mygroup