org.apache.syncope.core.provisioning.api.pushpull

Interface PullActions

All Superinterfaces:

ProvisioningActions

All Known Implementing Classes:

ADMembershipPullActions, DBPasswordPullActions, LDAPMembershipPullActions, LDAPPasswordPullActions, SchedulingPullActions, TestPullActions

public interface PullActions
extends ProvisioningActions

Interface for actions to be performed during pull. All methods can throw IgnoreProvisionException to make the current any object ignored by the pull process.

Method Summary

Modifier and Type	Method and Description
default void	after(ProvisioningProfile<?,?> profile, SyncDelta delta, EntityTO entity, ProvisioningReport result) Action to be executed after each local entity pull.
default void	beforeAssign(ProvisioningProfile<?,?> profile, SyncDelta delta, EntityTO entity) Action to be executed before creating (and linking to the resource) a pulled entity locally.
default void	beforeDelete(ProvisioningProfile<?,?> profile, SyncDelta delta, EntityTO entity) Action to be executed before to delete a pulled entity locally.
default void	beforeDeprovision(ProvisioningProfile<?,?> profile, SyncDelta delta, EntityTO entity) Action to be executed before de-provisioning action only.
default void	beforeLink(ProvisioningProfile<?,?> profile, SyncDelta delta, EntityTO entity) Action to be executed before linking resource to the pulled entity.
default void	beforeProvision(ProvisioningProfile<?,?> profile, SyncDelta delta, EntityTO entity) Action to be executed before to create a pulled entity locally.
default void	beforeUnassign(ProvisioningProfile<?,?> profile, SyncDelta delta, EntityTO entity) Action to be executed before unlinking resource from the pulled entity and de-provisioning.
default void	beforeUnlink(ProvisioningProfile<?,?> profile, SyncDelta delta, EntityTO entity) Action to be executed before unlinking resource from the pulled entity.
default <P extends AnyPatch> void	beforeUpdate(ProvisioningProfile<?,?> profile, SyncDelta delta, EntityTO entity, P anyPatch) Action to be executed before to update a pulled entity locally.
default Set<String>	moreAttrsToGet(ProvisioningProfile<?,?> profile, OrgUnit orgUnit) Return additional attributes to include in the result from the underlying connector.
default Set<String>	moreAttrsToGet(ProvisioningProfile<?,?> profile, Provision provision) Return additional attributes to include in the result from the underlying connector.
default IgnoreProvisionException	onError(ProvisioningProfile<?,?> profile, SyncDelta delta, Exception e) Action to be executed in case an exception is thrown during pull.
default SyncDelta	preprocess(ProvisioningProfile<?,?> profile, SyncDelta delta) Pre-process the pull information received by the underlying connector, before any internal activity occurs.

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

afterAll, beforeAll

Method Detail

moreAttrsToGet

default Set<String> moreAttrsToGet(ProvisioningProfile<?,?> profile,
                                   OrgUnit orgUnit)

Return additional attributes to include in the result from the underlying connector.

Parameters:

profile - profile of the pull being executed.

orgUnit - Realm provisioning information

Returns:

additional attributes to include in the result from the underlying connector

moreAttrsToGet

default Set<String> moreAttrsToGet(ProvisioningProfile<?,?> profile,
                                   Provision provision)

Return additional attributes to include in the result from the underlying connector.

Parameters:

profile - profile of the pull being executed.

provision - Any provisioning information

Returns:

additional attributes to include in the result from the underlying connector

preprocess

default SyncDelta preprocess(ProvisioningProfile<?,?> profile,
                             SyncDelta delta)

Pre-process the pull information received by the underlying connector, before any internal activity occurs.

Parameters:

profile - profile of the pull being executed.

delta - retrieved pull information

Returns:

pull information, possibly altered.

beforeProvision

default void beforeProvision(ProvisioningProfile<?,?> profile,
                             SyncDelta delta,
                             EntityTO entity)
                      throws org.quartz.JobExecutionException

Action to be executed before to create a pulled entity locally. The entity is created locally upon pull in case of the un-matching rule UnmatchingRule.PROVISION (default un-matching rule) is applied.

Parameters:

profile - profile of the pull being executed.

delta - retrieved pull information

entity - entity

Throws:

org.quartz.JobExecutionException - in case of generic failure

beforeAssign

default void beforeAssign(ProvisioningProfile<?,?> profile,
                          SyncDelta delta,
                          EntityTO entity)
                   throws org.quartz.JobExecutionException

Action to be executed before creating (and linking to the resource) a pulled entity locally. The entity is created locally and linked to the pulled resource upon pull in case of the un-matching rule UnmatchingRule.ASSIGN is applied.

Parameters:

profile - profile of the pull being executed.

delta - retrieved pull information

entity - entity

Throws:

org.quartz.JobExecutionException - in case of generic failure

beforeUnassign

default void beforeUnassign(ProvisioningProfile<?,?> profile,
                            SyncDelta delta,
                            EntityTO entity)
                     throws org.quartz.JobExecutionException

Action to be executed before unlinking resource from the pulled entity and de-provisioning. The entity is unlinked and de-provisioned from the pulled resource upon pull in case of the matching rule MatchingRule.UNASSIGN is applied.

Parameters:

profile - profile of the pull being executed.

delta - retrieved pull information

entity - entity

Throws:

org.quartz.JobExecutionException - in case of generic failure

beforeDeprovision

default void beforeDeprovision(ProvisioningProfile<?,?> profile,
                               SyncDelta delta,
                               EntityTO entity)
                        throws org.quartz.JobExecutionException

Action to be executed before de-provisioning action only. The entity is de-provisioned (without unlinking) from the pulled resource upon pull in case of the matching rule MatchingRule.DEPROVISION is applied.

Parameters:

profile - profile of the pull being executed.

delta - retrieved pull information

entity - entity

Throws:

org.quartz.JobExecutionException - in case of generic failure

beforeUnlink

default void beforeUnlink(ProvisioningProfile<?,?> profile,
                          SyncDelta delta,
                          EntityTO entity)
                   throws org.quartz.JobExecutionException

Action to be executed before unlinking resource from the pulled entity. The entity is unlinked (without de-provisioning) from the pulled resource upon pull in case of the matching rule MatchingRule.UNLINK is applied.

Parameters:

profile - profile of the pull being executed.

delta - retrieved pull information

entity - entity

Throws:

org.quartz.JobExecutionException - in case of generic failure

beforeLink

default void beforeLink(ProvisioningProfile<?,?> profile,
                        SyncDelta delta,
                        EntityTO entity)
                 throws org.quartz.JobExecutionException

Action to be executed before linking resource to the pulled entity. The entity is linked (without updating) to the pulled resource upon pull in case of the matching rule MatchingRule.LINK is applied.

Parameters:

profile - profile of the pull being executed.

delta - retrieved pull information

entity - entity

Throws:

org.quartz.JobExecutionException - in case of generic failure

beforeUpdate

default <P extends AnyPatch> void beforeUpdate(ProvisioningProfile<?,?> profile,
                                               SyncDelta delta,
                                               EntityTO entity,
                                               P anyPatch)
                                        throws org.quartz.JobExecutionException

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

Type Parameters:

P - any object modifications

Parameters:

profile - profile of the pull being executed.

delta - retrieved pull information

entity - entity

anyPatch - modification

Throws:

org.quartz.JobExecutionException - in case of generic failure.

beforeDelete

default void beforeDelete(ProvisioningProfile<?,?> profile,
                          SyncDelta delta,
                          EntityTO entity)
                   throws org.quartz.JobExecutionException

Action to be executed before to delete a pulled entity locally.

Parameters:

profile - profile of the pull being executed.

delta - retrieved pull information

entity - entity

Throws:

org.quartz.JobExecutionException - in case of generic failure

after

default void after(ProvisioningProfile<?,?> profile,
                   SyncDelta delta,
                   EntityTO entity,
                   ProvisioningReport result)
            throws org.quartz.JobExecutionException

Action to be executed after each local entity pull.

Parameters:

profile - profile of the pull being executed.

delta - retrieved pull information (may be modified by beforeProvision / beforeUpdate / beforeDelete)

entity - entity

result - global pull results at the current pull step

Throws:

org.quartz.JobExecutionException - in case of generic failure

onError

default IgnoreProvisionException onError(ProvisioningProfile<?,?> profile,
                                         SyncDelta delta,
                                         Exception e)
                                  throws org.quartz.JobExecutionException

Action to be executed in case an exception is thrown during pull.

Parameters:

profile - profile of the pull being executed.

delta - retrieved pull information (may be modified by beforeProvision / beforeUpdate / beforeDelete)

e - the exception thrown

Returns:

an instance of the given exception type is that is to be thrown; NULL otherwise

Throws:

org.quartz.JobExecutionException - in case of generic failure