org.cloudfoundry.identity.uaa.scim.jdbc

Class JdbcScimGroupMembershipManager

java.lang.Object

org.cloudfoundry.identity.uaa.rest.jdbc.AbstractQueryable<ScimGroupMember>

org.cloudfoundry.identity.uaa.scim.jdbc.JdbcScimGroupMembershipManager

All Implemented Interfaces:

org.cloudfoundry.identity.uaa.rest.Queryable<ScimGroupMember>, ScimGroupMembershipManager

public class JdbcScimGroupMembershipManager
extends org.cloudfoundry.identity.uaa.rest.jdbc.AbstractQueryable<ScimGroupMember>
implements ScimGroupMembershipManager

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADD_MEMBER_SQL
static java.lang.String	DELETE_MEMBER_IN_GROUPS_SQL_GROUP
static java.lang.String	DELETE_MEMBER_IN_GROUPS_SQL_USER
static java.lang.String	DELETE_MEMBER_SQL
static java.lang.String	DELETE_MEMBERS_IN_GROUP_SQL
static java.lang.String	GET_GROUPS_BY_MEMBER_SQL
static java.lang.String	GET_MEMBER_SQL
static java.lang.String	GET_MEMBERS_FILTER_SQL
static java.lang.String	GET_MEMBERS_SQL
static java.lang.String	GET_MEMBERS_WITH_AUTHORITY_SQL
static java.lang.String	MEMBERSHIP_FIELDS
static java.lang.String	MEMBERSHIP_TABLE
static java.lang.String	UPDATE_MEMBER_SQL

Constructor Summary

Constructors

Constructor and Description
JdbcScimGroupMembershipManager(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate, org.cloudfoundry.identity.uaa.rest.jdbc.JdbcPagingListFactory pagingListFactory)

Method Summary

Modifier and Type	Method and Description
ScimGroupMember	addMember(java.lang.String groupId, ScimGroupMember member) Add a member to a group
int	delete(java.lang.String filter)
protected java.lang.String	getBaseSqlQuery()
java.util.Set<ScimGroup>	getDefaultUserGroups(org.cloudfoundry.identity.uaa.zone.IdentityZone zone)
java.util.Set<ScimGroup>	getGroupsWithMember(java.lang.String memberId, boolean transitive) Retrieve all groups that the given member belongs to
ScimGroupMember	getMemberById(java.lang.String groupId, java.lang.String memberId) Retrieve a particular member's membership details
java.util.List<ScimGroupMember>	getMembers(java.lang.String groupId) Retrieve all members of a group
java.util.List<ScimGroupMember>	getMembers(java.lang.String groupId, ScimGroupMember.Role permission) Retrieve members that have the specified authority on the group
protected java.lang.String	getQuerySQL(java.lang.String filter, org.cloudfoundry.identity.uaa.rest.jdbc.SearchQueryConverter.ProcessedFilter where)
protected java.lang.String	getTableName()
boolean	isDefaultGroup(java.lang.String groupId)
java.util.List<ScimGroupMember>	query(java.lang.String filter)
java.util.List<ScimGroupMember>	query(java.lang.String filter, java.lang.String sortBy, boolean ascending)
ScimGroupMember	removeMemberById(java.lang.String groupId, java.lang.String memberId) Revoke membership of a member
java.util.List<ScimGroupMember>	removeMembersByGroupId(java.lang.String groupId) Empty the group, i.e revoke the membership of ALL members of a given group
java.util.Set<ScimGroup>	removeMembersByMemberId(java.lang.String memberId) Revoke membership of given member from ALL groups
void	setDefaultUserGroups(java.util.Set<java.lang.String> groupNames)
void	setScimGroupProvisioning(ScimGroupProvisioning groupProvisioning)
void	setScimUserProvisioning(ScimUserProvisioning userProvisioning)
ScimGroupMember	updateMember(java.lang.String groupId, ScimGroupMember member) Update a particular member's membership details
java.util.List<ScimGroupMember>	updateOrAddMembers(java.lang.String groupId, java.util.List<ScimGroupMember> members) Replace the members of the given group with the supplied member-list

Methods inherited from class org.cloudfoundry.identity.uaa.rest.jdbc.AbstractQueryable

getPageSize, getQueryConverter, setPageSize, setQueryConverter

Methods inherited from class java.lang.Object

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

Field Detail

MEMBERSHIP_FIELDS

public static final java.lang.String MEMBERSHIP_FIELDS

See Also:

Constant Field Values

MEMBERSHIP_TABLE

public static final java.lang.String MEMBERSHIP_TABLE

See Also:

Constant Field Values

ADD_MEMBER_SQL

public static final java.lang.String ADD_MEMBER_SQL

UPDATE_MEMBER_SQL

public static final java.lang.String UPDATE_MEMBER_SQL

GET_MEMBERS_FILTER_SQL

public static final java.lang.String GET_MEMBERS_FILTER_SQL

GET_MEMBERS_SQL

public static final java.lang.String GET_MEMBERS_SQL

GET_GROUPS_BY_MEMBER_SQL

public static final java.lang.String GET_GROUPS_BY_MEMBER_SQL

GET_MEMBERS_WITH_AUTHORITY_SQL

public static final java.lang.String GET_MEMBERS_WITH_AUTHORITY_SQL

GET_MEMBER_SQL

public static final java.lang.String GET_MEMBER_SQL

DELETE_MEMBER_SQL

public static final java.lang.String DELETE_MEMBER_SQL

DELETE_MEMBERS_IN_GROUP_SQL

public static final java.lang.String DELETE_MEMBERS_IN_GROUP_SQL

DELETE_MEMBER_IN_GROUPS_SQL_USER

public static final java.lang.String DELETE_MEMBER_IN_GROUPS_SQL_USER

DELETE_MEMBER_IN_GROUPS_SQL_GROUP

public static final java.lang.String DELETE_MEMBER_IN_GROUPS_SQL_GROUP

Constructor Detail

JdbcScimGroupMembershipManager

public JdbcScimGroupMembershipManager(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate,
                                      org.cloudfoundry.identity.uaa.rest.jdbc.JdbcPagingListFactory pagingListFactory)

Method Detail

setDefaultUserGroups

public void setDefaultUserGroups(java.util.Set<java.lang.String> groupNames)

getDefaultUserGroups

public java.util.Set<ScimGroup> getDefaultUserGroups(org.cloudfoundry.identity.uaa.zone.IdentityZone zone)

setScimUserProvisioning

public void setScimUserProvisioning(ScimUserProvisioning userProvisioning)

setScimGroupProvisioning

public void setScimGroupProvisioning(ScimGroupProvisioning groupProvisioning)

getBaseSqlQuery

protected java.lang.String getBaseSqlQuery()

Specified by:

getBaseSqlQuery in class org.cloudfoundry.identity.uaa.rest.jdbc.AbstractQueryable<ScimGroupMember>

getTableName

protected java.lang.String getTableName()

Specified by:

getTableName in class org.cloudfoundry.identity.uaa.rest.jdbc.AbstractQueryable<ScimGroupMember>

delete

public int delete(java.lang.String filter)

Specified by:

delete in interface org.cloudfoundry.identity.uaa.rest.Queryable<ScimGroupMember>

Overrides:

delete in class org.cloudfoundry.identity.uaa.rest.jdbc.AbstractQueryable<ScimGroupMember>

query

public java.util.List<ScimGroupMember> query(java.lang.String filter)

Specified by:

query in interface org.cloudfoundry.identity.uaa.rest.Queryable<ScimGroupMember>

Overrides:

query in class org.cloudfoundry.identity.uaa.rest.jdbc.AbstractQueryable<ScimGroupMember>

query

public java.util.List<ScimGroupMember> query(java.lang.String filter,
                                             java.lang.String sortBy,
                                             boolean ascending)

Specified by:

query in interface org.cloudfoundry.identity.uaa.rest.Queryable<ScimGroupMember>

Overrides:

query in class org.cloudfoundry.identity.uaa.rest.jdbc.AbstractQueryable<ScimGroupMember>

getQuerySQL

protected java.lang.String getQuerySQL(java.lang.String filter,
                                       org.cloudfoundry.identity.uaa.rest.jdbc.SearchQueryConverter.ProcessedFilter where)

Overrides:

getQuerySQL in class org.cloudfoundry.identity.uaa.rest.jdbc.AbstractQueryable<ScimGroupMember>

isDefaultGroup

public boolean isDefaultGroup(java.lang.String groupId)

addMember

public ScimGroupMember addMember(java.lang.String groupId,
                                 ScimGroupMember member)
                          throws ScimResourceNotFoundException,
                                 MemberAlreadyExistsException

Description copied from interface: ScimGroupMembershipManager

Add a member to a group

Specified by:

addMember in interface ScimGroupMembershipManager

Parameters:

groupId - id of a valid group that already exists.

member - membership info for enrolling an existing scim object (user or group) in the group

Returns:

Throws:

ScimResourceNotFoundException

MemberAlreadyExistsException

getMembers

public java.util.List<ScimGroupMember> getMembers(java.lang.String groupId)
                                           throws ScimResourceNotFoundException

Description copied from interface: ScimGroupMembershipManager

Retrieve all members of a group

Specified by:

getMembers in interface ScimGroupMembershipManager

Returns:

Throws:

ScimResourceNotFoundException

getGroupsWithMember

public java.util.Set<ScimGroup> getGroupsWithMember(java.lang.String memberId,
                                                    boolean transitive)
                                             throws ScimResourceNotFoundException

Description copied from interface: ScimGroupMembershipManager

Retrieve all groups that the given member belongs to

Specified by:

getGroupsWithMember in interface ScimGroupMembershipManager

transitive - true means indirect/transitive membership is also processed (nested groups)

Returns:

Throws:

ScimResourceNotFoundException

getMembers

public java.util.List<ScimGroupMember> getMembers(java.lang.String groupId,
                                                  ScimGroupMember.Role permission)
                                           throws ScimResourceNotFoundException

Description copied from interface: ScimGroupMembershipManager

Retrieve members that have the specified authority on the group

Specified by:

getMembers in interface ScimGroupMembershipManager

Returns:

Throws:

ScimResourceNotFoundException

getMemberById

public ScimGroupMember getMemberById(java.lang.String groupId,
                                     java.lang.String memberId)
                              throws ScimResourceNotFoundException,
                                     MemberNotFoundException

Description copied from interface: ScimGroupMembershipManager

Retrieve a particular member's membership details

Specified by:

getMemberById in interface ScimGroupMembershipManager

Returns:

Throws:

ScimResourceNotFoundException

MemberNotFoundException

updateMember

public ScimGroupMember updateMember(java.lang.String groupId,
                                    ScimGroupMember member)
                             throws ScimResourceNotFoundException,
                                    MemberNotFoundException

Description copied from interface: ScimGroupMembershipManager

Update a particular member's membership details

Specified by:

updateMember in interface ScimGroupMembershipManager

Returns:

Throws:

ScimResourceNotFoundException

MemberNotFoundException

updateOrAddMembers

public java.util.List<ScimGroupMember> updateOrAddMembers(java.lang.String groupId,
                                                          java.util.List<ScimGroupMember> members)
                                                   throws ScimResourceNotFoundException

Description copied from interface: ScimGroupMembershipManager

Replace the members of the given group with the supplied member-list

Specified by:

updateOrAddMembers in interface ScimGroupMembershipManager

Returns:

Throws:

ScimResourceNotFoundException

removeMemberById

public ScimGroupMember removeMemberById(java.lang.String groupId,
                                        java.lang.String memberId)
                                 throws ScimResourceNotFoundException,
                                        MemberNotFoundException

Description copied from interface: ScimGroupMembershipManager

Revoke membership of a member

Specified by:

removeMemberById in interface ScimGroupMembershipManager

Returns:

Throws:

ScimResourceNotFoundException

MemberNotFoundException

removeMembersByGroupId

public java.util.List<ScimGroupMember> removeMembersByGroupId(java.lang.String groupId)
                                                       throws ScimResourceNotFoundException

Description copied from interface: ScimGroupMembershipManager

Empty the group, i.e revoke the membership of ALL members of a given group

Specified by:

removeMembersByGroupId in interface ScimGroupMembershipManager

Returns:

Throws:

ScimResourceNotFoundException

removeMembersByMemberId

public java.util.Set<ScimGroup> removeMembersByMemberId(java.lang.String memberId)
                                                 throws ScimResourceNotFoundException

Description copied from interface: ScimGroupMembershipManager

Revoke membership of given member from ALL groups

Specified by:

removeMembersByMemberId in interface ScimGroupMembershipManager

Returns:

Throws:

ScimResourceNotFoundException