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 Summary

Modifier and Type	Method and Description
default void	after(ProvisioningProfile<?,?> profile, Entity entity, ProvisioningReport result) Action to be executed after each local entity push.
default Entity	beforeAssign(ProvisioningProfile<?,?> profile, Entity entity) Action to be executed before to assign (link & provision) a pushed entity to the resource.
default Entity	beforeDelete(ProvisioningProfile<?,?> profile, Entity entity) Action to be executed before delete a pushed entity locally and from the resource.
default Entity	beforeDeprovision(ProvisioningProfile<?,?> profile, Entity entity) Action to be executed before to unassign a pushed entity from the resource.
default Entity	beforeLink(ProvisioningProfile<?,?> profile, Entity entity) Action to be executed before to link a pushed entity to the resource.
default Entity	beforeProvision(ProvisioningProfile<?,?> profile, Entity entity) Action to be executed before to provision a pushed entity to the resource.
default Entity	beforeUnassign(ProvisioningProfile<?,?> profile, Entity entity) Action to be executed before to unassign a pushed entity from the resource.
default Entity	beforeUnlink(ProvisioningProfile<?,?> profile, Entity entity) Action to be executed before to unlink a pushed entity from the resource.
default Entity	beforeUpdate(ProvisioningProfile<?,?> profile, Entity entity) Action to be executed before to update a pushed entity on the resource.
default Set<String>	moreAttrsToGet(ProvisioningProfile<?,?> profile, Entity entity) Return additional attributes to include in the result from the underlying connector.
default void	onError(ProvisioningProfile<?,?> profile, Entity entity, ProvisioningReport result, Exception error) Action to be executed after entity push goes on error.

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

afterAll, beforeAll

Method Detail

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)
                     throws org.quartz.JobExecutionException

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.

Throws:

org.quartz.JobExecutionException - in case of generic failure

beforeProvision

default Entity beforeProvision(ProvisioningProfile<?,?> profile,
                               Entity entity)
                        throws org.quartz.JobExecutionException

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.

Throws:

org.quartz.JobExecutionException - in case of generic failure

beforeUpdate

default Entity beforeUpdate(ProvisioningProfile<?,?> profile,
                            Entity entity)
                     throws org.quartz.JobExecutionException

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.

Throws:

org.quartz.JobExecutionException - in case of generic failure

beforeLink

default Entity beforeLink(ProvisioningProfile<?,?> profile,
                          Entity entity)
                   throws org.quartz.JobExecutionException

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.

Throws:

org.quartz.JobExecutionException - in case of generic failure

beforeUnlink

default Entity beforeUnlink(ProvisioningProfile<?,?> profile,
                            Entity entity)
                     throws org.quartz.JobExecutionException

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.

Throws:

org.quartz.JobExecutionException - in case of generic failure

beforeUnassign

default Entity beforeUnassign(ProvisioningProfile<?,?> profile,
                              Entity entity)
                       throws org.quartz.JobExecutionException

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.

Throws:

org.quartz.JobExecutionException - in case of generic failure

beforeDeprovision

default Entity beforeDeprovision(ProvisioningProfile<?,?> profile,
                                 Entity entity)
                          throws org.quartz.JobExecutionException

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.

Throws:

org.quartz.JobExecutionException - in case of generic failure

beforeDelete

default Entity beforeDelete(ProvisioningProfile<?,?> profile,
                            Entity entity)
                     throws org.quartz.JobExecutionException

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.

Throws:

org.quartz.JobExecutionException - in case of generic failure

onError

default void onError(ProvisioningProfile<?,?> profile,
                     Entity entity,
                     ProvisioningReport result,
                     Exception error)
              throws org.quartz.JobExecutionException

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

Throws:

org.quartz.JobExecutionException - in case of generic failure

after

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

Action to be executed after each local entity push.

Parameters:

profile - profile of the push being executed.

entity - pushed entity.

result - operation result.

Throws:

org.quartz.JobExecutionException - in case of generic failure