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

Interface InboundActions

All Superinterfaces:
ProvisioningActions
All Known Implementing Classes:
ADMembershipPullActions, DBPasswordPullActions, KafkaInboundActions, LDAPMembershipPullActions, LDAPPasswordPullActions, TestInboundActions
public interface InboundActions extends ProvisioningActions
Interface for actions to be performed during inbound. All methods can throw IgnoreProvisionException to make the current any object ignored by the inbound process.

  • Method Details

    • 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 inbound 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 inbound being executed.
      provision - Any provisioning information
      Returns:
      additional attributes to include in the result from the underlying connector

    • preprocess

      default <T extends LiveSyncDelta> T preprocess(ProvisioningProfile<?,?> profile, T delta)
      Pre-process the inbound information received by the underlying connector, before any internal activity occurs.
      Type Parameters:
      T - sync delta class
      Parameters:
      profile - profile of the inbound being executed.
      delta - retrieved inbound information
      Returns:
      inbound information, possibly altered.

    • beforeProvision

      default void beforeProvision(ProvisioningProfile<?,?> profile, LiveSyncDelta delta, AnyCR createReq)
      Action to be executed before to create a inbounded entity locally. The entity is created locally upon inbound in case of the un-matching rule UnmatchingRule.PROVISION (default un-matching rule) is applied.
      Parameters:
      profile - profile of the inbound being executed.
      delta - retrieved inbound information
      createReq - create request

    • beforeProvision

      default void beforeProvision(ProvisioningProfile<?,?> profile, LiveSyncDelta delta, LinkedAccountTO linkedAccount)
      Action to be executed before locally creating a linked account.
      Parameters:
      profile - profile of the inbound being executed.
      delta - retrieved inbound information
      linkedAccount - create request

    • beforeProvision

      default void beforeProvision(ProvisioningProfile<?,?> profile, LiveSyncDelta delta, RealmTO realm)
      Action to be executed before to create a inbounded realm locally. The realm is created locally upon inbound in case of the un-matching rule UnmatchingRule.PROVISION (default un-matching rule) is applied.
      Parameters:
      profile - profile of the inbound being executed.
      delta - retrieved inbound information
      realm - realm

    • beforeAssign

      default void beforeAssign(ProvisioningProfile<?,?> profile, LiveSyncDelta delta, AnyCR createReq)
      Action to be executed before creating (and linking to the resource) a inbounded entity locally. The entity is created locally and linked to the inbounded resource upon inbound in case of the un-matching rule UnmatchingRule.ASSIGN is applied.
      Parameters:
      profile - profile of the inbound being executed.
      delta - retrieved inbound information
      createReq - create request

    • beforeAssign

      default void beforeAssign(ProvisioningProfile<?,?> profile, LiveSyncDelta delta, LinkedAccountTO linkedAccount)
      Action to be executed before locally creating a linked account.
      Parameters:
      profile - profile of the inbound being executed.
      delta - retrieved inbound information
      linkedAccount - linked account

    • beforeAssign

      default void beforeAssign(ProvisioningProfile<?,?> profile, LiveSyncDelta delta, RealmTO realm)
      Action to be executed before creating (and linking to the resource) a inbounded realm locally. The realm is created locally and linked to the inbounded resource upon inbound in case of the un-matching rule UnmatchingRule.ASSIGN is applied.
      Parameters:
      profile - profile of the inbound being executed.
      delta - retrieved inbound information
      realm - realm

    • beforeUnassign

      default void beforeUnassign(ProvisioningProfile<?,?> profile, LiveSyncDelta delta, EntityTO entity)
      Action to be executed before unlinking resource from the inbounded entity and de-provisioning. The entity is unlinked and de-provisioned from the inbounded resource upon inbound in case of the matching rule MatchingRule.UNASSIGN is applied.
      Parameters:
      profile - profile of the inbound being executed.
      delta - retrieved inbound information
      entity - entity

    • beforeDeprovision

      default void beforeDeprovision(ProvisioningProfile<?,?> profile, LiveSyncDelta delta, EntityTO entity)
      Action to be executed before de-provisioning action only. The entity is de-provisioned (without unlinking) from the inbounded resource upon inbound in case of the matching rule MatchingRule.DEPROVISION is applied.
      Parameters:
      profile - profile of the inbound being executed.
      delta - retrieved inbound information
      entity - entity

    • beforeUnlink

      default void beforeUnlink(ProvisioningProfile<?,?> profile, LiveSyncDelta delta, EntityTO entity)
      Action to be executed before unlinking resource from the inbounded entity. The entity is unlinked (without de-provisioning) from the inbounded resource upon inbound in case of the matching rule MatchingRule.UNLINK is applied.
      Parameters:
      profile - profile of the inbound being executed.
      delta - retrieved inbound information
      entity - entity

    • beforeLink

      default void beforeLink(ProvisioningProfile<?,?> profile, LiveSyncDelta delta, EntityTO entity)
      Action to be executed before linking resource to the inbounded entity. The entity is linked (without updating) to the inbounded resource upon inbound in case of the matching rule MatchingRule.LINK is applied.
      Parameters:
      profile - profile of the inbound being executed.
      delta - retrieved inbound information
      entity - entity

    • beforeUpdate

      default void beforeUpdate(ProvisioningProfile<?,?> profile, LiveSyncDelta delta, EntityTO entity, AnyUR anyUR) throws JobExecutionException
      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.
      Parameters:
      profile - profile of the inbound being executed.
      delta - retrieved inbound information
      entity - entity
      anyUR - modification
      Throws:
      JobExecutionException - in case of generic failure.

    • beforeDelete

      default void beforeDelete(ProvisioningProfile<?,?> profile, LiveSyncDelta delta, EntityTO entity)
      Action to be executed before to delete a inbounded entity locally.
      Parameters:
      profile - profile of the inbound being executed.
      delta - retrieved inbound information
      entity - entity

    • after

      default void after(ProvisioningProfile<?,?> profile, LiveSyncDelta delta, EntityTO entity, ProvisioningReport result) throws JobExecutionException
      Action to be executed after each local entity inbound.
      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

    • onError

      default IgnoreProvisionException onError(ProvisioningProfile<?,?> profile, LiveSyncDelta delta, Exception e)
      Action to be executed in case an exception is thrown during inbound.
      Parameters:
      profile - profile of the inbound being executed.
      delta - retrieved inbound 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