nl.surfnet.coin.api.service
Interface PersonService

All Known Implementing Classes:

MockServiceImpl, PersonServiceImpl

public interface PersonService

Method Summary

List<Person>	enforceArp(String spEntityId, List<Person> persons) Enforce the ARP on the given list of Persons.
GroupMembersEntry	getGroupMembers(String groupId, String onBehalfOf, String spEntityId, Integer count, Integer startIndex, String sortBy) Get the group members of the given group.
PersonEntry	getPerson(String userId, String onBehalfOf, String spEntityId) Get the OpenSocial Person.

Method Detail

getPerson

@PreAuthorize(value="#onBehalfOf == null or #userId.equals(#onBehalfOf)")
PersonEntry getPerson(String userId,
                                   String onBehalfOf,
                                   String spEntityId)

Get the OpenSocial Person. Note that the onBehalfOf can be null.

Parameters:

userId - the unique identifier

onBehalfOf - the unique identifier of the user on behalf of whom the request is made.

spEntityId - the entity that performs the request

Returns:

the PersonEntry

getGroupMembers

@PostAuthorize(value="#onBehalf == null or returnObject.isMember(#onBehalfOf)")
GroupMembersEntry getGroupMembers(String groupId,
                                                String onBehalfOf,
                                                String spEntityId,
                                                Integer count,
                                                Integer startIndex,
                                                String sortBy)

Get the group members of the given group. Note that the onBehalfOf can be null.

Parameters:

groupId - String the unique identifier for the group

onBehalfOf - the unique identifier of the user on behalf of whom the request is made.

spEntityId - the entity that performs the request

count - nr of records to fetch

startIndex - first record nr.

sortBy - field to sort by.

Returns:

an ArrayList containing Person's

enforceArp

List<Person> enforceArp(String spEntityId,
                        List<Person> persons)

Enforce the ARP on the given list of Persons.

Beware: this is not an in-place enforcement: the original list will not be touched, nor its elements.

Parameters:

spEntityId - the SP to use the ARP for

persons - the persons to enforce

Returns:

List of persons with the ARP applied.