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

Interface PushActions

All Superinterfaces:
ProvisioningActions
public interface PushActions extends ProvisioningActions
Interface for actions to be performed during push. All methods can throw IgnoreProvisionException to make the current entity ignored by the push process.

  • Method Details

    • moreAttrsToGet

      default Set<String> moreAttrsToGet(ProvisioningProfile<?,?> profile, Entity entity)
      Return additional attributes to include in the result from the underlying connector.
      Parameters:
      profile - profile of the pull being executed.
      entity - entity
      Returns:
      additional attributes to include in the result from the underlying connector

    • beforeAssign

      default Entity beforeAssign(ProvisioningProfile<?,?> profile, Entity entity)
      Action to be executed before to assign (link & provision) a pushed entity to the resource.
      Parameters:
      profile - profile of the push being executed.
      entity - entity to be created.
      Returns:
      entity.

    • beforeProvision

      default Entity beforeProvision(ProvisioningProfile<?,?> profile, Entity entity)
      Action to be executed before to provision a pushed entity to the resource.
      Parameters:
      profile - profile of the push being executed.
      entity - entity to be created.
      Returns:
      entity.

    • beforeUpdate

      default Entity beforeUpdate(ProvisioningProfile<?,?> profile, Entity entity)
      Action to be executed before to update a pushed entity on the resource.
      Parameters:
      profile - profile of the push being executed.
      entity - entity to be updated.
      Returns:
      entity.

    • beforeLink

      default Entity beforeLink(ProvisioningProfile<?,?> profile, Entity entity)
      Action to be executed before to link a pushed entity to the resource.
      Parameters:
      profile - profile of the push being executed.
      entity - entity to be created.
      Returns:
      entity.

    • beforeUnlink

      default Entity beforeUnlink(ProvisioningProfile<?,?> profile, Entity entity)
      Action to be executed before to unlink a pushed entity from the resource.
      Parameters:
      profile - profile of the push being executed.
      entity - entity to be created.
      Returns:
      entity.

    • beforeUnassign

      default Entity beforeUnassign(ProvisioningProfile<?,?> profile, Entity entity)
      Action to be executed before to unassign a pushed entity from the resource.
      Parameters:
      profile - profile of the push being executed.
      entity - entity to be created.
      Returns:
      entity.

    • beforeDeprovision

      default Entity beforeDeprovision(ProvisioningProfile<?,?> profile, Entity entity)
      Action to be executed before to unassign a pushed entity from the resource.
      Parameters:
      profile - profile of the push being executed.
      entity - entity to be created.
      Returns:
      entity.

    • beforeDelete

      default Entity beforeDelete(ProvisioningProfile<?,?> profile, Entity entity)
      Action to be executed before delete a pushed entity locally and from the resource.
      Parameters:
      profile - profile of the push being executed.
      entity - entity to be created.
      Returns:
      entity.

    • onError

      default void onError(ProvisioningProfile<?,?> profile, Entity entity, ProvisioningReport result, Exception error)
      Action to be executed after entity push goes on error.
      Parameters:
      profile - profile of the push being executed.
      entity - pushed entity.
      result - operation result.
      error - error being reported

    • after

      default void after(ProvisioningProfile<?,?> profile, Entity entity, ProvisioningReport result)
      Action to be executed after each local entity push.
      Parameters:
      profile - profile of the push being executed.
      entity - pushed entity.
      result - operation result.