org.apache.syncope.core.workflow.java

Class AbstractUserWorkflowAdapter

java.lang.Object

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 Object
implements UserWorkflowAdapter

Field Summary

Fields

Modifier and Type	Field and Description
protected String	adminUser
protected String	anonymousUser
protected UserDataBinder	dataBinder
protected EntityFactory	entityFactory
protected static org.slf4j.Logger	LOG
protected Map<String,AccountRule>	perContextAccountRules
protected Map<String,PasswordRule>	perContextPasswordRules
protected RealmDAO	realmDAO
protected UserDAO	userDAO

Constructor Summary

Constructors

Constructor and Description
AbstractUserWorkflowAdapter()

Method Summary

Modifier and Type	Method and Description
UserWorkflowResult<String>	activate(String key, String token) Activate an user.
UserWorkflowResult<Pair<UserPatch,Boolean>>	confirmPasswordReset(String key, String token, String password) Confirm password reset for an user.
UserWorkflowResult<Pair<String,Boolean>>	create(UserTO userTO, boolean storePassword) Create an user.
UserWorkflowResult<Pair<String,Boolean>>	create(UserTO userTO, boolean disablePwdPolicyCheck, Boolean enabled, boolean storePassword) Create an user, optionally disabling password policy check.
void	delete(String userKey) Delete an user.
protected abstract UserWorkflowResult<String>	doActivate(User user, String token)
protected abstract UserWorkflowResult<Pair<UserPatch,Boolean>>	doConfirmPasswordReset(User user, String token, String password)
protected abstract UserWorkflowResult<Pair<String,Boolean>>	doCreate(UserTO userTO, boolean disablePwdPolicyCheck, Boolean enabled, boolean storePassword)
protected abstract void	doDelete(User user)
protected abstract UserWorkflowResult<String>	doReactivate(User user)
protected abstract void	doRequestPasswordReset(User user)
protected abstract UserWorkflowResult<String>	doSuspend(User user)
protected abstract UserWorkflowResult<Pair<UserPatch,Boolean>>	doUpdate(User user, UserPatch userPatch)
protected Pair<Boolean,Boolean>	enforcePolicies(User user, boolean disablePwdPolicyCheck, String clearPassword)
protected List<AccountPolicy>	getAccountPolicies(User user)
protected List<AccountRule>	getAccountRules(AccountPolicy policy)
protected List<PasswordPolicy>	getPasswordPolicies(User user)
protected List<PasswordRule>	getPasswordRules(PasswordPolicy policy)
String	getPrefix()
Pair<UserWorkflowResult<String>,Boolean>	internalSuspend(String key) Suspend an user (used by internal authentication process)
UserWorkflowResult<String>	reactivate(String key) Reactivate an user.
void	requestPasswordReset(String key) Request password reset for an user.
UserWorkflowResult<String>	suspend(String key) Suspend an user.
UserWorkflowResult<Pair<UserPatch,Boolean>>	update(UserPatch userPatch) Update an user.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

dataBinder

@Autowired
protected UserDataBinder dataBinder

userDAO

@Autowired
protected UserDAO userDAO

realmDAO

@Autowired
protected RealmDAO realmDAO

entityFactory

@Autowired
protected EntityFactory entityFactory

adminUser

protected String adminUser

anonymousUser

protected String anonymousUser

perContextAccountRules

protected final Map<String,AccountRule> perContextAccountRules

perContextPasswordRules

protected final Map<String,PasswordRule> perContextPasswordRules

Constructor Detail

AbstractUserWorkflowAdapter

public AbstractUserWorkflowAdapter()

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)

getAccountPolicies

protected List<AccountPolicy> getAccountPolicies(User user)

getAccountRules

protected List<AccountRule> getAccountRules(AccountPolicy policy)

getPasswordPolicies

protected List<PasswordPolicy> getPasswordPolicies(User user)

getPasswordRules

protected List<PasswordRule> getPasswordRules(PasswordPolicy policy)

enforcePolicies

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

create

public UserWorkflowResult<Pair<String,Boolean>> create(UserTO userTO,
                                                       boolean storePassword)

Description copied from interface: UserWorkflowAdapter

Create an user.

Specified by:

create in interface UserWorkflowAdapter

Parameters:

userTO - user to be created and whether to propagate it as active

storePassword - whether password shall be stored into the internal storage

Returns:

user just created

doCreate

protected abstract UserWorkflowResult<Pair<String,Boolean>> doCreate(UserTO userTO,
                                                                     boolean disablePwdPolicyCheck,
                                                                     Boolean enabled,
                                                                     boolean storePassword)

create

public UserWorkflowResult<Pair<String,Boolean>> create(UserTO userTO,
                                                       boolean disablePwdPolicyCheck,
                                                       Boolean enabled,
                                                       boolean storePassword)

Description copied from interface: UserWorkflowAdapter

Create an user, optionally disabling password policy check.

Specified by:

create in interface UserWorkflowAdapter

Parameters:

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

storePassword - whether password shall be stored into the internal storage

Returns:

user just created

doActivate

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

activate

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

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

Returns:

user just updated

doUpdate

protected abstract UserWorkflowResult<Pair<UserPatch,Boolean>> doUpdate(User user,
                                                                        UserPatch userPatch)

update

public UserWorkflowResult<Pair<UserPatch,Boolean>> update(UserPatch userPatch)

Description copied from interface: UserWorkflowAdapter

Update an user.

Specified by:

update in interface UserWorkflowAdapter

Parameters:

userPatch - modification set to be performed

Returns:

user just updated and propagations to be performed

doSuspend

protected abstract UserWorkflowResult<String> doSuspend(User user)

suspend

public UserWorkflowResult<String> suspend(String key)

Description copied from interface: UserWorkflowAdapter

Suspend an user.

Specified by:

suspend in interface UserWorkflowAdapter

Parameters:

key - to be suspended

Returns:

user just suspended

internalSuspend

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

Description copied from interface: UserWorkflowAdapter

Suspend an user (used by internal authentication process)

Specified by:

internalSuspend in interface UserWorkflowAdapter

Parameters:

key - to be suspended

Returns:

user just suspended and information whether to propagate suspension

doReactivate

protected abstract UserWorkflowResult<String> doReactivate(User user)

reactivate

public UserWorkflowResult<String> reactivate(String key)

Description copied from interface: UserWorkflowAdapter

Reactivate an user.

Specified by:

reactivate in interface UserWorkflowAdapter

Parameters:

key - user to be reactivated

Returns:

user just reactivated

doRequestPasswordReset

protected abstract void doRequestPasswordReset(User user)

requestPasswordReset

public void requestPasswordReset(String key)

Description copied from interface: UserWorkflowAdapter

Request password reset for an user.

Specified by:

requestPasswordReset in interface UserWorkflowAdapter

Parameters:

key - user requesting password reset

doConfirmPasswordReset

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

confirmPasswordReset

public UserWorkflowResult<Pair<UserPatch,Boolean>> confirmPasswordReset(String key,
                                                                        String token,
                                                                        String password)

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

Returns:

user just updated and propagations to be performed

doDelete

protected abstract void doDelete(User user)

delete

public void delete(String userKey)

Description copied from interface: UserWorkflowAdapter

Delete an user.

Specified by:

delete in interface UserWorkflowAdapter

Parameters:

userKey - user to be deleted