Interface PullActions
-
- All Superinterfaces:
ProvisioningActions
- All Known Implementing Classes:
ADMembershipPullActions
,DBPasswordPullActions
,LDAPMembershipPullActions
,LDAPPasswordPullActions
,TestPullActions
public interface PullActions extends ProvisioningActions
Interface for actions to be performed during pull. All methods can throwIgnoreProvisionException
to make the current any object ignored by the pull process.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method 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, AnyCR createReq)
Action to be executed before creating (and linking to the resource) a pulled entity locally.default void
beforeAssign(ProvisioningProfile<?,?> profile, SyncDelta delta, LinkedAccountTO linkedAccount)
Action to be executed before locally creating a linked account.default void
beforeAssign(ProvisioningProfile<?,?> profile, SyncDelta delta, RealmTO realm)
Action to be executed before creating (and linking to the resource) a pulled realm 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, AnyCR createReq)
Action to be executed before to create a pulled entity locally.default void
beforeProvision(ProvisioningProfile<?,?> profile, SyncDelta delta, LinkedAccountTO linkedAccount)
Action to be executed before locally creating a linked account.default void
beforeProvision(ProvisioningProfile<?,?> profile, SyncDelta delta, RealmTO realm)
Action to be executed before to create a pulled realm 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 void
beforeUpdate(ProvisioningProfile<?,?> profile, SyncDelta delta, EntityTO entity, AnyUR anyUR)
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, AnyCR createReq) 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 ruleUnmatchingRule.PROVISION
(default un-matching rule) is applied.- Parameters:
profile
- profile of the pull being executed.delta
- retrieved pull informationcreateReq
- create request- Throws:
org.quartz.JobExecutionException
- in case of generic failure
-
beforeProvision
default void beforeProvision(ProvisioningProfile<?,?> profile, SyncDelta delta, LinkedAccountTO linkedAccount) throws org.quartz.JobExecutionException
Action to be executed before locally creating a linked account.- Parameters:
profile
- profile of the pull being executed.delta
- retrieved pull informationlinkedAccount
- create request- Throws:
org.quartz.JobExecutionException
- in case of generic failure
-
beforeProvision
default void beforeProvision(ProvisioningProfile<?,?> profile, SyncDelta delta, RealmTO realm) throws org.quartz.JobExecutionException
Action to be executed before to create a pulled realm locally. The realm is created locally upon pull in case of the un-matching ruleUnmatchingRule.PROVISION
(default un-matching rule) is applied.- Parameters:
profile
- profile of the pull being executed.delta
- retrieved pull informationrealm
- realm- Throws:
org.quartz.JobExecutionException
- in case of generic failure
-
beforeAssign
default void beforeAssign(ProvisioningProfile<?,?> profile, SyncDelta delta, AnyCR createReq) 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 ruleUnmatchingRule.ASSIGN
is applied.- Parameters:
profile
- profile of the pull being executed.delta
- retrieved pull informationcreateReq
- create request- Throws:
org.quartz.JobExecutionException
- in case of generic failure
-
beforeAssign
default void beforeAssign(ProvisioningProfile<?,?> profile, SyncDelta delta, LinkedAccountTO linkedAccount) throws org.quartz.JobExecutionException
Action to be executed before locally creating a linked account.- Parameters:
profile
- profile of the pull being executed.delta
- retrieved pull informationlinkedAccount
- linked account- Throws:
org.quartz.JobExecutionException
- in case of generic failure
-
beforeAssign
default void beforeAssign(ProvisioningProfile<?,?> profile, SyncDelta delta, RealmTO realm) throws org.quartz.JobExecutionException
Action to be executed before creating (and linking to the resource) a pulled realm locally. The realm is created locally and linked to the pulled resource upon pull in case of the un-matching ruleUnmatchingRule.ASSIGN
is applied.- Parameters:
profile
- profile of the pull being executed.delta
- retrieved pull informationrealm
- realm- 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 ruleMatchingRule.UNASSIGN
is applied.- Parameters:
profile
- profile of the pull being executed.delta
- retrieved pull informationentity
- 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 ruleMatchingRule.DEPROVISION
is applied.- Parameters:
profile
- profile of the pull being executed.delta
- retrieved pull informationentity
- 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 ruleMatchingRule.UNLINK
is applied.- Parameters:
profile
- profile of the pull being executed.delta
- retrieved pull informationentity
- 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 ruleMatchingRule.LINK
is applied.- Parameters:
profile
- profile of the pull being executed.delta
- retrieved pull informationentity
- entity- Throws:
org.quartz.JobExecutionException
- in case of generic failure
-
beforeUpdate
default void beforeUpdate(ProvisioningProfile<?,?> profile, SyncDelta delta, EntityTO entity, AnyUR anyUR) 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 ruleMatchingRule.UPDATE
(default matching rule) is applied.- Parameters:
profile
- profile of the pull being executed.delta
- retrieved pull informationentity
- entityanyUR
- 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 informationentity
- 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 beforeProvisionTO / beforeUpdate / beforeDelete)entity
- entityresult
- 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 beforeProvisionTO / 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
-
-