Package org.apache.syncope.core.provisioning.java.pushpull

Class LDAPMembershipPullActions

java.lang.Object

org.apache.syncope.core.provisioning.java.pushpull.LDAPMembershipPullActions

All Implemented Interfaces:

InboundActions, ProvisioningActions

Direct Known Subclasses:

ADMembershipPullActions

public class LDAPMembershipPullActions
extends Object
implements InboundActions

Simple action for pulling LDAP groups memberships to Syncope group memberships, when the same resource is configured for both users and groups.

See Also:

• LDAPMembershipPropagationActions

Field Summary

Fields

Modifier and Type	Field	Description
protected AnyTypeDAO	anyTypeDAO
protected GroupDAO	groupDAO
protected InboundMatcher	inboundMatcher
protected static final Logger	LOG
protected final Map<String,Set<String>>	membershipsAfter
protected final Map<String,Set<String>>	membershipsBefore
protected UserProvisioningManager	userProvisioningManager

Constructor Summary

Constructors

Constructor	Description
LDAPMembershipPullActions()

Method Summary

Modifier and Type	Method	Description
void	after(ProvisioningProfile<?,?> profile, LiveSyncDelta delta, EntityTO entity, ProvisioningReport result)	Keep track of members of the group being updated after actual update took place.
void	afterAll(ProvisioningProfile<?,?> profile)	Action to be executed after the provisioning (push / pull) task completion.
void	beforeUpdate(ProvisioningProfile<?,?> profile, LiveSyncDelta delta, EntityTO entity, AnyUR anyUR)	Keep track of members of the group being updated before actual update takes place.
protected String	getGroupMembershipAttrName(Connector connector)	Allows easy subclassing for the ConnId AD connector bundle.
protected List<Object>	getMembAttrValues(LiveSyncDelta delta, Connector connector)	Read values of attribute returned by getGroupMembershipAttrName(); if not present in the given delta, perform an additional read on the underlying connector.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.syncope.core.provisioning.api.pushpull.InboundActions

beforeAssign, beforeAssign, beforeAssign, beforeDelete, beforeDeprovision, beforeLink, beforeProvision, beforeProvision, beforeProvision, beforeUnassign, beforeUnlink, moreAttrsToGet, moreAttrsToGet, onError, preprocess

Methods inherited from interface org.apache.syncope.core.provisioning.api.pushpull.ProvisioningActions

beforeAll

Field Details

LOG

protected static final Logger LOG

anyTypeDAO

@Autowired
protected AnyTypeDAO anyTypeDAO

groupDAO

@Autowired
protected GroupDAO groupDAO

inboundMatcher

@Autowired
protected InboundMatcher inboundMatcher

userProvisioningManager

@Autowired
protected UserProvisioningManager userProvisioningManager

membershipsBefore

protected final Map<String,Set<String>> membershipsBefore

membershipsAfter

protected final Map<String,Set<String>> membershipsAfter

Constructor Details

LDAPMembershipPullActions

public LDAPMembershipPullActions()

Method Details

getGroupMembershipAttrName

protected String getGroupMembershipAttrName(Connector connector)

Allows easy subclassing for the ConnId AD connector bundle.

Parameters:

connector - A Connector instance to query for the groupMemberAttribute property name

Returns:

the name of the attribute used to keep track of group memberships

getMembAttrValues

protected List<Object> getMembAttrValues(LiveSyncDelta delta,
 Connector connector)

Read values of attribute returned by getGroupMembershipAttrName(); if not present in the given delta, perform an additional read on the underlying connector.

Parameters:

delta - representing the pulling group

connector - associated to the current resource

Returns:

value of attribute returned by getGroupMembershipAttrName(org.apache.syncope.core.provisioning.api.Connector)

beforeUpdate

@Transactional(readOnly=true)
public void beforeUpdate(ProvisioningProfile<?,?> profile,
 LiveSyncDelta delta,
 EntityTO entity,
 AnyUR anyUR)
                  throws JobExecutionException

Keep track of members of the group being updated before actual update takes place. This is not needed on

• InboundActions.beforeProvision(org.apache.syncope.core.provisioning.api.pushpull.ProvisioningProfile<?, ?>, org.identityconnectors.framework.common.objects.LiveSyncDelta, org.apache.syncope.common.lib.request.AnyCR) because the pulling group does not exist yet on Syncope
• InboundActions.beforeDelete(org.apache.syncope.core.provisioning.api.pushpull.ProvisioningProfile<?, ?>, org.identityconnectors.framework.common.objects.LiveSyncDelta, org.apache.syncope.common.lib.to.EntityTO) because group delete cascades as membership removal for all users involved

Action to be executed before to update a inbounded entity locally. The entity is updated upon inbound in case of the matching rule MatchingRule.UPDATE (default matching rule) is applied.

Specified by:

beforeUpdate in interface InboundActions

Parameters:

profile - profile of the inbound being executed.

delta - retrieved inbound information

entity - entity

anyUR - modification

Throws:

JobExecutionException - in case of generic failure.

after

public void after(ProvisioningProfile<?,?> profile,
 LiveSyncDelta delta,
 EntityTO entity,
 ProvisioningReport result)
           throws JobExecutionException

Keep track of members of the group being updated after actual update took place. Action to be executed after each local entity inbound.

Specified by:

after in interface InboundActions

Parameters:

profile - profile of the inbound being executed.

delta - retrieved inbound information (may be modified by beforeProvisionTO / beforeUpdate / beforeDelete)

entity - entity

result - global inbound results at the current inbound step

Throws:

JobExecutionException - in case of generic failure

afterAll

@Transactional(propagation=REQUIRES_NEW)
public void afterAll(ProvisioningProfile<?,?> profile)

Description copied from interface: ProvisioningActions

Action to be executed after the provisioning (push / pull) task completion.

Specified by:

afterAll in interface ProvisioningActions

Parameters:

profile - provisioning profile