voot.provider

Interface Provider

All Known Implementing Classes:

AbstractProvider, GrouperSoapClient, OpenSocialClient, Voot2Provider

public interface Provider

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Provider.Configuration

Method Summary

Modifier and Type	Method and Description
List<Group>	getAllGroups() All groups
Optional<Group>	getGroupMembership(String uid, String groupId)
List<Group>	getGroupMemberships(String uid)
List<Member>	getMembers(String groupId) Get all members of a group
boolean	isExternalGroupProvider()
boolean	shouldBeQueriedForGroup(String groupId) Tells us if it is worthwhile calling this client when returning a single specified group for an user
boolean	shouldBeQueriedForMembers(String groupId) Tells us if it is worthwhile calling this client when returning all members of a group
boolean	shouldBeQueriedForMemberships(String schacHomeOrganization) Tells us if it is worthwhile calling this client when returning all groups for an user

Method Detail

shouldBeQueriedForMemberships

boolean shouldBeQueriedForMemberships(String schacHomeOrganization)

Tells us if it is worthwhile calling this client when returning all groups for an user

Parameters:

schacHomeOrganization - the end-user's schacHomeOrg

Returns:

true if this Provider can return groups for the specified schacHomeOrganization

shouldBeQueriedForGroup

boolean shouldBeQueriedForGroup(String groupId)

Tells us if it is worthwhile calling this client when returning a single specified group for an user

Parameters:

groupId - the group being requested (must be fully qualified persistent name or the unqualified Institution name)

Returns:

true if this Provider can return groups for the specified schacHomeOrganization

isExternalGroupProvider

boolean isExternalGroupProvider()

Returns:

true if this Provider is external (e.g. not Grouper)

getGroupMemberships

List<Group> getGroupMemberships(String uid)

Parameters:

uid - the fully qualified uid

getAllGroups

List<Group> getAllGroups()

All groups

getGroupMembership

Optional<Group> getGroupMembership(String uid,
                                   String groupId)

Parameters:

uid - the fully qualified uid

groupId - the fully qualified uid groupId

Returns:

the Group membership info if the user is indeed a member of the group, the empty Optional otherwise.

getMembers

List<Member> getMembers(String groupId)

Get all members of a group

Parameters:

groupId - the fully qualified uid groupId

Returns:

all Members

shouldBeQueriedForMembers

boolean shouldBeQueriedForMembers(String groupId)

Tells us if it is worthwhile calling this client when returning all members of a group

Parameters:

groupId - the fully qualified uid groupId

Returns:

true if this Provider can return memers for the specified group id