Interface UserWorkflowAdapter
-
- All Superinterfaces:
WorkflowAdapter
- All Known Implementing Classes:
AbstractUserWorkflowAdapter
,DefaultUserWorkflowAdapter
,FlowableUserWorkflowAdapter
public interface UserWorkflowAdapter extends WorkflowAdapter
Interface for calling underlying workflow implementations.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description UserWorkflowResult<String>
activate(String userKey, String token, String updater, String context)
Activate an user.UserWorkflowResult<Pair<UserUR,Boolean>>
confirmPasswordReset(String userKey, String token, String password, String updater, String context)
Confirm password reset for an user.UserWorkflowResult<Pair<String,Boolean>>
create(UserCR userCR, boolean disablePwdPolicyCheck, Boolean enabled, String creator, String context)
Create an user, optionally disabling password policy check.UserWorkflowResult<Pair<String,Boolean>>
create(UserCR userCR, String creator, String context)
Create an user.void
delete(String userKey, String eraser, String context)
Delete an user.Pair<UserWorkflowResult<String>,Boolean>
internalSuspend(String key, String updater, String context)
Suspend an user (used by internal authentication process)UserWorkflowResult<String>
reactivate(String userKey, String updater, String context)
Reactivate an user.void
requestPasswordReset(String userKey, String updater, String context)
Request password reset for an user.UserWorkflowResult<String>
suspend(String key, String updater, String context)
Suspend an user.UserWorkflowResult<Pair<UserUR,Boolean>>
update(UserUR userUR, String updater, String context)
Update an user.-
Methods inherited from interface org.apache.syncope.core.workflow.api.WorkflowAdapter
getPrefix
-
-
-
-
Method Detail
-
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 activecreator
- username that requested this operationcontext
- 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 activedisablePwdPolicyCheck
- disable password policy check?enabled
- specify true/false to force active/supended statuscreator
- username that requested this operationcontext
- 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 activatedtoken
- to be verified for activationupdater
- username that requested this operationcontext
- context information- Returns:
- user just updated
-
update
UserWorkflowResult<Pair<UserUR,Boolean>> update(UserUR userUR, String updater, String context)
Update an user.- Parameters:
userUR
- modification set to be performedupdater
- username that requested this operationcontext
- 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 suspendedupdater
- username that requested this operationcontext
- 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 suspendedupdater
- username that requested this operationcontext
- 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 reactivatedupdater
- username that requested this operationcontext
- 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 resetupdater
- username that requested this operationcontext
- 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 resettoken
- security tokenpassword
- new password valueupdater
- username that requested this operationcontext
- context information- Returns:
- user just updated and propagations to be performed
-
-