Package org.apache.syncope.core.workflow.java

Class AbstractUserWorkflowAdapter

java.lang.Object

org.apache.syncope.core.workflow.java.AbstractWorkflowAdapter

org.apache.syncope.core.workflow.java.AbstractUserWorkflowAdapter

All Implemented Interfaces:

UserWorkflowAdapter, WorkflowAdapter

Direct Known Subclasses:

DefaultUserWorkflowAdapter, FlowableUserWorkflowAdapter

@Transactional(propagation=REQUIRES_NEW,
               rollbackFor=java.lang.Throwable.class)
public abstract class AbstractUserWorkflowAdapter
extends AbstractWorkflowAdapter
implements UserWorkflowAdapter

Field Summary

Fields

Modifier and Type	Field	Description
protected UserDataBinder	dataBinder
protected static Logger	LOG
protected RealmDAO	realmDAO
protected RuleEnforcer	ruleEnforcer
protected SecurityProperties	securityProperties
protected UserDAO	userDAO

Fields inherited from class org.apache.syncope.core.workflow.java.AbstractWorkflowAdapter

entityFactory, groupDAO, publisher

Fields inherited from interface org.apache.syncope.core.workflow.api.UserWorkflowAdapter

CONFIRM_PASSWORD_RESET, REQUEST_PASSWORD_RESET

Constructor Summary

Constructors

Constructor	Description
AbstractUserWorkflowAdapter(UserDataBinder dataBinder, UserDAO userDAO, RealmDAO realmDAO, GroupDAO groupDAO, EntityFactory entityFactory, SecurityProperties securityProperties, RuleEnforcer ruleEnforcer, ApplicationEventPublisher publisher)

Method Summary

Modifier and Type	Method	Description
UserWorkflowResult<String>	activate(String key, String token, String updater, String context)	Activate an user.
UserWorkflowResult<Pair<UserUR,Boolean>>	confirmPasswordReset(String key, 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.
protected abstract UserWorkflowResult<String>	doActivate(User user, String token, String updater, String context)
protected abstract UserWorkflowResult<Pair<UserUR,Boolean>>	doConfirmPasswordReset(User user, String token, String password, String updater, String context)
protected abstract UserWorkflowResult<Pair<String,Boolean>>	doCreate(UserCR userCR, boolean disablePwdPolicyCheck, Boolean enabled, String creator, String context)
protected abstract void	doDelete(User user, String eraser, String context)
protected abstract UserWorkflowResult<String>	doReactivate(User user, String updater, String context)
protected abstract void	doRequestPasswordReset(User user, String updater, String context)
protected abstract UserWorkflowResult<String>	doSuspend(User user, String updater, String context)
protected abstract UserWorkflowResult<Pair<UserUR,Boolean>>	doUpdate(User user, UserUR userUR, String updater, String context)
protected Pair<Boolean,Boolean>	enforcePolicies(User user, boolean disablePwdPolicyCheck, String clearPassword)
String	getPrefix()
Pair<UserWorkflowResult<String>,Boolean>	internalSuspend(String key, String updater, String context)	Suspend an user (used by internal authentication process)
UserWorkflowResult<String>	reactivate(String key, String updater, String context)	Reactivate an user.
void	requestPasswordReset(String key, 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, Boolean enabled, String updater, String context)	Update an user.

Methods inherited from class org.apache.syncope.core.workflow.java.AbstractWorkflowAdapter

metadata

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

protected static final Logger LOG

dataBinder

protected final UserDataBinder dataBinder

userDAO

protected final UserDAO userDAO

realmDAO

protected final RealmDAO realmDAO

securityProperties

protected final SecurityProperties securityProperties

ruleEnforcer

protected final RuleEnforcer ruleEnforcer

Constructor Detail

AbstractUserWorkflowAdapter

public AbstractUserWorkflowAdapter(UserDataBinder dataBinder,
                                   UserDAO userDAO,
                                   RealmDAO realmDAO,
                                   GroupDAO groupDAO,
                                   EntityFactory entityFactory,
                                   SecurityProperties securityProperties,
                                   RuleEnforcer ruleEnforcer,
                                   ApplicationEventPublisher publisher)

Method Detail

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface WorkflowAdapter

Returns:

any string that might be interpreted as 'prefix' (say table prefix in SQL environments)

enforcePolicies

protected Pair<Boolean,Boolean> enforcePolicies(User user,
                                                      boolean disablePwdPolicyCheck,
                                                      String clearPassword)

create

public UserWorkflowResult<Pair<String,Boolean>> create(UserCR userCR,
                                                             String creator,
                                                             String context)

Description copied from interface: UserWorkflowAdapter

Create an user.

Specified by:

create in interface UserWorkflowAdapter

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

doCreate

protected abstract UserWorkflowResult<Pair<String,Boolean>> doCreate(UserCR userCR,
                                                                           boolean disablePwdPolicyCheck,
                                                                           Boolean enabled,
                                                                           String creator,
                                                                           String context)

create

public UserWorkflowResult<Pair<String,Boolean>> create(UserCR userCR,
                                                             boolean disablePwdPolicyCheck,
                                                             Boolean enabled,
                                                             String creator,
                                                             String context)

Description copied from interface: UserWorkflowAdapter

Create an user, optionally disabling password policy check.

Specified by:

create in interface UserWorkflowAdapter

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

doActivate

protected abstract UserWorkflowResult<String> doActivate(User user,
                                                         String token,
                                                         String updater,
                                                         String context)

activate

public UserWorkflowResult<String> activate(String key,
                                           String token,
                                           String updater,
                                           String context)

Description copied from interface: UserWorkflowAdapter

Activate an user.

Specified by:

activate in interface UserWorkflowAdapter

Parameters:

key - user to be activated

token - to be verified for activation

updater - username that requested this operation

context - context information

Returns:

user just updated

doUpdate

protected abstract UserWorkflowResult<Pair<UserUR,Boolean>> doUpdate(User user,
                                                                           UserUR userUR,
                                                                           String updater,
                                                                           String context)

update

public UserWorkflowResult<Pair<UserUR,Boolean>> update(UserUR userUR,
                                                             Boolean enabled,
                                                             String updater,
                                                             String context)

Description copied from interface: UserWorkflowAdapter

Update an user.

Specified by:

update in interface UserWorkflowAdapter

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

doSuspend

protected abstract UserWorkflowResult<String> doSuspend(User user,
                                                        String updater,
                                                        String context)

suspend

public UserWorkflowResult<String> suspend(String key,
                                          String updater,
                                          String context)

Description copied from interface: UserWorkflowAdapter

Suspend an user.

Specified by:

suspend in interface UserWorkflowAdapter

Parameters:

key - to be suspended

updater - username that requested this operation

context - context information

Returns:

user just suspended

internalSuspend

public Pair<UserWorkflowResult<String>,Boolean> internalSuspend(String key,
                                                                      String updater,
                                                                      String context)

Description copied from interface: UserWorkflowAdapter

Suspend an user (used by internal authentication process)

Specified by:

internalSuspend in interface UserWorkflowAdapter

Parameters:

key - to be suspended

updater - username that requested this operation

context - context information

Returns:

user just suspended and information whether to propagate suspension

doReactivate

protected abstract UserWorkflowResult<String> doReactivate(User user,
                                                           String updater,
                                                           String context)

reactivate

public UserWorkflowResult<String> reactivate(String key,
                                             String updater,
                                             String context)

Description copied from interface: UserWorkflowAdapter

Reactivate an user.

Specified by:

reactivate in interface UserWorkflowAdapter

Parameters:

key - user to be reactivated

updater - username that requested this operation

context - context information

Returns:

user just reactivated

doRequestPasswordReset

protected abstract void doRequestPasswordReset(User user,
                                               String updater,
                                               String context)

requestPasswordReset

public void requestPasswordReset(String key,
                                 String updater,
                                 String context)

Description copied from interface: UserWorkflowAdapter

Request password reset for an user.

Specified by:

requestPasswordReset in interface UserWorkflowAdapter

Parameters:

key - user requesting password reset

updater - username that requested this operation

context - context information

doConfirmPasswordReset

protected abstract UserWorkflowResult<Pair<UserUR,Boolean>> doConfirmPasswordReset(User user,
                                                                                         String token,
                                                                                         String password,
                                                                                         String updater,
                                                                                         String context)

confirmPasswordReset

public UserWorkflowResult<Pair<UserUR,Boolean>> confirmPasswordReset(String key,
                                                                           String token,
                                                                           String password,
                                                                           String updater,
                                                                           String context)

Description copied from interface: UserWorkflowAdapter

Confirm password reset for an user.

Specified by:

confirmPasswordReset in interface UserWorkflowAdapter

Parameters:

key - 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

doDelete

protected abstract void doDelete(User user,
                                 String eraser,
                                 String context)

delete

public void delete(String userKey,
                   String eraser,
                   String context)

Description copied from interface: UserWorkflowAdapter

Delete an user.

Specified by:

delete in interface UserWorkflowAdapter

Parameters:

userKey - user to be deleted

eraser - username that requested this operation

context - context information