voot.provider

Class Voot2Provider

java.lang.Object

voot.provider.AbstractProvider

voot.provider.Voot2Provider

All Implemented Interfaces:

Provider

Direct Known Subclasses:

OpenSocialClient

public class Voot2Provider
extends AbstractProvider

Nested Class Summary

Nested classes/interfaces inherited from interface voot.provider.Provider

Provider.Configuration

Field Summary

Fields

Modifier and Type	Field and Description
protected String	allMembershipsUrlTemplate
protected String	specificMembershipTemplate

Fields inherited from class voot.provider.AbstractProvider

configuration, groupIdPrefix, objectMapper, restTemplate

Constructor Summary

Constructors

Constructor and Description
Voot2Provider(Provider.Configuration 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
protected List<Group>	parseGroups(String response)
protected Optional<Group>	parseSingleGroup(String response)
boolean	shouldBeQueriedForMemberships(String schacHomeOrganization) Tells us if it is worthwhile calling this client when returning all groups for an user

Methods inherited from class voot.provider.AbstractProvider

isExternalGroupProvider, parseJson, shouldBeQueriedForGroup, shouldBeQueriedForMembers, toString

Methods inherited from class java.lang.Object

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

Field Detail

allMembershipsUrlTemplate

protected String allMembershipsUrlTemplate

specificMembershipTemplate

protected String specificMembershipTemplate

Constructor Detail

Voot2Provider

public Voot2Provider(Provider.Configuration configuration)

Method Detail

shouldBeQueriedForMemberships

public boolean shouldBeQueriedForMemberships(String schacHomeOrganization)

Description copied from interface: Provider

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

getGroupMemberships

public List<Group> getGroupMemberships(String uid)

Parameters:

uid - the fully qualified uid

getAllGroups

public List<Group> getAllGroups()

Description copied from interface: Provider

All groups

getGroupMembership

public 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

public List<Member> getMembers(String groupId)

Description copied from interface: Provider

Get all members of a group

Parameters:

groupId - the fully qualified uid groupId

Returns:

all Members

parseGroups

protected List<Group> parseGroups(String response)

parseSingleGroup

protected Optional<Group> parseSingleGroup(String response)