Package edu.internet2.middleware.grouper.app.truefoundry

Class TrueFoundryTargetDao

java.lang.Object

edu.internet2.middleware.grouper.app.provisioning.targetDao.GrouperProvisionerTargetDaoBase

edu.internet2.middleware.grouper.app.truefoundry.TrueFoundryTargetDao

public class TrueFoundryTargetDao
extends GrouperProvisionerTargetDaoBase

TrueFoundry TargetDao — manages users, teams, roles, and team memberships via the TrueFoundry native REST API. Entity ID note: The provisioning entity ID is the native TrueFoundry user ID (e.g. "pt3vuwlxupmefpk8i9cj11du"). The email address is stored as a separate attribute and is used for API calls (register, deactivate, role assignment, team membership). The native ID is used for SCIM display name updates (PATCH /scim/v2/{tenant}/{sso}/Users/{nativeId}). Team membership note: TrueFoundry has no individual add/remove member endpoints. Team membership is managed by replacing the full member list via PUT /teams. insertMembership and deleteMembership for teams both retrieve the current team state, modify the member list, and PUT the full manifest back. Role membership note: Role assignments are read from the rolesWithResource array on each user returned by the subjects endpoint. insertMembership assigns a role to a user; deleteMembership assigns the configured default role.

Constructor Summary

Constructors

Constructor	Description
TrueFoundryTargetDao()

Method Summary

Modifier and Type	Method	Description
TargetDaoDeleteEntityResponse	deleteEntity(TargetDaoDeleteEntityRequest targetDaoDeleteEntityRequest)	set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)
TargetDaoDeleteGroupResponse	deleteGroup(TargetDaoDeleteGroupRequest targetDaoDeleteGroupRequest)	set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)
TargetDaoDeleteMembershipsResponse	deleteMemberships(TargetDaoDeleteMembershipsRequest targetDaoDeleteMembershipsRequest)	delete all these Memberships and either throw exception for all or mark each one with an exception set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)
TargetDaoInsertEntityResponse	insertEntity(TargetDaoInsertEntityRequest targetDaoInsertEntityRequest)	set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)
TargetDaoInsertGroupResponse	insertGroup(TargetDaoInsertGroupRequest targetDaoInsertGroupRequest)	set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)
TargetDaoInsertMembershipsResponse	insertMemberships(TargetDaoInsertMembershipsRequest targetDaoInsertMembershipsRequest)	insert all these Memberships and either throw exception for all or mark each one with an exception set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)
boolean	loggingStart()	start logging the source low level actions
String	loggingStop()	stop logging and get the output only call this if you successfully started the logging
void	registerGrouperProvisionerDaoCapabilities(GrouperProvisionerDaoCapabilities grouperProvisionerDaoCapabilities)
TargetDaoReplaceGroupMembershipsResponse	replaceGroupMemberships(TargetDaoReplaceGroupMembershipsRequest targetDaoReplaceGroupMembershipsRequest)	replace a groups memberships with this list
TargetDaoRetrieveAllDataResponse	retrieveAllData(TargetDaoRetrieveAllDataRequest targetDaoRetrieveAllDataRequest)	retrieve all data from the target
TargetDaoRetrieveEntityResponse	retrieveEntity(TargetDaoRetrieveEntityRequest targetDaoRetrieveEntityRequest)	return a Entity by matching id of grouper target Entity, or null if not found
TargetDaoRetrieveGroupResponse	retrieveGroup(TargetDaoRetrieveGroupRequest targetDaoRetrieveGroupRequest)	return a group by matching id of grouper target group, or null if not found
TargetDaoUpdateEntityResponse	updateEntity(TargetDaoUpdateEntityRequest targetDaoUpdateEntityRequest)	set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)
TargetDaoUpdateGroupResponse	updateGroup(TargetDaoUpdateGroupRequest targetDaoUpdateGroupRequest)	set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)

Methods inherited from class edu.internet2.middleware.grouper.app.provisioning.targetDao.GrouperProvisionerTargetDaoBase

addTargetDaoTimingInfo, deleteEntities, deleteGroups, deleteMembership, getGrouperProvisioner, getGrouperProvisionerDaoCapabilities, getTargetDaoTimingInfos, insertEntities, insertGroups, insertMembership, retrieveAllEntities, retrieveAllGroups, retrieveAllMemberships, retrieveEntities, retrieveGroups, retrieveIncrementalData, retrieveMembership, retrieveMemberships, retrieveMembershipsByEntities, retrieveMembershipsByEntity, retrieveMembershipsByGroup, retrieveMembershipsByGroups, retrievePerItemInParallel, sendChangesToTarget, sendEntityChangesToTarget, sendGroupChangesToTarget, sendMembershipChangesToTarget, setGrouperProvisioner, setGrouperProvisionerDaoCapabilities, setTargetDaoTimingInfos, updateEntities, updateGroups, updateMembership, updateMemberships

Methods inherited from class java.lang.Object

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

Constructor Details

TrueFoundryTargetDao

public TrueFoundryTargetDao()

Method Details

loggingStart

public boolean loggingStart()

Description copied from class: GrouperProvisionerTargetDaoBase

start logging the source low level actions

Overrides:

loggingStart in class GrouperProvisionerTargetDaoBase

Returns:

true if the logging was started (i.e. can be stopped), or false if already started (in which case somewhere up the stack with stop it so dont stop it)

loggingStop

public String loggingStop()

Description copied from class: GrouperProvisionerTargetDaoBase

stop logging and get the output only call this if you successfully started the logging

Overrides:

loggingStop in class GrouperProvisionerTargetDaoBase

retrieveAllData

public TargetDaoRetrieveAllDataResponse retrieveAllData(TargetDaoRetrieveAllDataRequest targetDaoRetrieveAllDataRequest)

Description copied from class: GrouperProvisionerTargetDaoBase

retrieve all data from the target

Overrides:

retrieveAllData in class GrouperProvisionerTargetDaoBase

retrieveEntity

public TargetDaoRetrieveEntityResponse retrieveEntity(TargetDaoRetrieveEntityRequest targetDaoRetrieveEntityRequest)

Description copied from class: GrouperProvisionerTargetDaoBase

return a Entity by matching id of grouper target Entity, or null if not found

Overrides:

retrieveEntity in class GrouperProvisionerTargetDaoBase

Returns:

the target provisioning Entity or null if not found

retrieveGroup

public TargetDaoRetrieveGroupResponse retrieveGroup(TargetDaoRetrieveGroupRequest targetDaoRetrieveGroupRequest)

Description copied from class: GrouperProvisionerTargetDaoBase

return a group by matching id of grouper target group, or null if not found

Overrides:

retrieveGroup in class GrouperProvisionerTargetDaoBase

Returns:

the target provisioning group or null if not found

insertGroup

public TargetDaoInsertGroupResponse insertGroup(TargetDaoInsertGroupRequest targetDaoInsertGroupRequest)

Description copied from class: GrouperProvisionerTargetDaoBase

set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)

Overrides:

insertGroup in class GrouperProvisionerTargetDaoBase

updateGroup

public TargetDaoUpdateGroupResponse updateGroup(TargetDaoUpdateGroupRequest targetDaoUpdateGroupRequest)

Description copied from class: GrouperProvisionerTargetDaoBase

set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)

Overrides:

updateGroup in class GrouperProvisionerTargetDaoBase

deleteGroup

public TargetDaoDeleteGroupResponse deleteGroup(TargetDaoDeleteGroupRequest targetDaoDeleteGroupRequest)

Description copied from class: GrouperProvisionerTargetDaoBase

set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)

Overrides:

deleteGroup in class GrouperProvisionerTargetDaoBase

insertEntity

public TargetDaoInsertEntityResponse insertEntity(TargetDaoInsertEntityRequest targetDaoInsertEntityRequest)

Description copied from class: GrouperProvisionerTargetDaoBase

set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)

Overrides:

insertEntity in class GrouperProvisionerTargetDaoBase

updateEntity

public TargetDaoUpdateEntityResponse updateEntity(TargetDaoUpdateEntityRequest targetDaoUpdateEntityRequest)

Description copied from class: GrouperProvisionerTargetDaoBase

set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)

Overrides:

updateEntity in class GrouperProvisionerTargetDaoBase

deleteEntity

public TargetDaoDeleteEntityResponse deleteEntity(TargetDaoDeleteEntityRequest targetDaoDeleteEntityRequest)

Description copied from class: GrouperProvisionerTargetDaoBase

set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)

Overrides:

deleteEntity in class GrouperProvisionerTargetDaoBase

insertMemberships

public TargetDaoInsertMembershipsResponse insertMemberships(TargetDaoInsertMembershipsRequest targetDaoInsertMembershipsRequest)

Description copied from class: GrouperProvisionerTargetDaoBase

insert all these Memberships and either throw exception for all or mark each one with an exception set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)

Overrides:

insertMemberships in class GrouperProvisionerTargetDaoBase

deleteMemberships

public TargetDaoDeleteMembershipsResponse deleteMemberships(TargetDaoDeleteMembershipsRequest targetDaoDeleteMembershipsRequest)

Description copied from class: GrouperProvisionerTargetDaoBase

delete all these Memberships and either throw exception for all or mark each one with an exception set each provisioning object as "provisioned" after the insert/update/delete is done e.g. targetObject.setProvisioned(true)

Overrides:

deleteMemberships in class GrouperProvisionerTargetDaoBase

replaceGroupMemberships

public TargetDaoReplaceGroupMembershipsResponse replaceGroupMemberships(TargetDaoReplaceGroupMembershipsRequest targetDaoReplaceGroupMembershipsRequest)

Description copied from class: GrouperProvisionerTargetDaoBase

replace a groups memberships with this list

Overrides:

replaceGroupMemberships in class GrouperProvisionerTargetDaoBase

Returns:

the response

registerGrouperProvisionerDaoCapabilities

public void registerGrouperProvisionerDaoCapabilities(GrouperProvisionerDaoCapabilities grouperProvisionerDaoCapabilities)

Specified by:

registerGrouperProvisionerDaoCapabilities in class GrouperProvisionerTargetDaoBase