Package org.apache.syncope.core.workflow.api

Interface UserWorkflowAdapter

All Superinterfaces:
WorkflowAdapter
All Known Implementing Classes:
AbstractUserWorkflowAdapter, DefaultUserWorkflowAdapter, FlowableUserWorkflowAdapter
public interface UserWorkflowAdapter extends WorkflowAdapter
Interface for calling underlying workflow implementations.

  • Field Details

  • Method Details

    • create

      UserWorkflowResult<Pair<String,Boolean>> create(UserCR userCR, String creator, String context)
      Create an user.
      Parameters:
      userCR - user to be created and whether to propagate it as active
      creator - username that requested this operation
      context - context information
      Returns:
      user just created

    • create

      UserWorkflowResult<Pair<String,Boolean>> create(UserCR userCR, boolean disablePwdPolicyCheck, Boolean enabled, String creator, String context)
      Create an user, optionally disabling password policy check.
      Parameters:
      userCR - user to be created and whether to propagate it as active
      disablePwdPolicyCheck - disable password policy check?
      enabled - specify true/false to force active/supended status
      creator - username that requested this operation
      context - context information
      Returns:
      user just created

    • activate

      UserWorkflowResult<String> activate(String userKey, String token, String updater, String context)
      Activate an user.
      Parameters:
      userKey - user to be activated
      token - to be verified for activation
      updater - username that requested this operation
      context - context information
      Returns:
      user just updated

    • update

      UserWorkflowResult<Pair<UserUR,Boolean>> update(UserUR userUR, Boolean enabled, String updater, String context)
      Update an user.
      Parameters:
      userUR - modification set to be performed
      enabled - whether status shall be changed or not
      updater - username that requested this operation
      context - context information
      Returns:
      user just updated and propagations to be performed

    • suspend

      UserWorkflowResult<String> suspend(String key, String updater, String context)
      Suspend an user.
      Parameters:
      key - to be suspended
      updater - username that requested this operation
      context - context information
      Returns:
      user just suspended

    • internalSuspend

      Pair<UserWorkflowResult<String>,Boolean> internalSuspend(String key, String updater, String context)
      Suspend an user (used by internal authentication process)
      Parameters:
      key - to be suspended
      updater - username that requested this operation
      context - context information
      Returns:
      user just suspended and information whether to propagate suspension

    • reactivate

      UserWorkflowResult<String> reactivate(String userKey, String updater, String context)
      Reactivate an user.
      Parameters:
      userKey - user to be reactivated
      updater - username that requested this operation
      context - context information
      Returns:
      user just reactivated

    • requestPasswordReset

      void requestPasswordReset(String userKey, String updater, String context)
      Request password reset for an user.
      Parameters:
      userKey - user requesting password reset
      updater - username that requested this operation
      context - context information

    • confirmPasswordReset

      UserWorkflowResult<Pair<UserUR,Boolean>> confirmPasswordReset(String userKey, String token, String password, String updater, String context)
      Confirm password reset for an user.
      Parameters:
      userKey - user confirming password reset
      token - security token
      password - new password value
      updater - username that requested this operation
      context - context information
      Returns:
      user just updated and propagations to be performed

    • delete

      void delete(String userKey, String eraser, String context)
      Delete an user.
      Parameters:
      userKey - user to be deleted
      eraser - username that requested this operation
      context - context information