net.smartlab.web.auth
Interface RegistrationHandler

All Superinterfaces:

Handler

All Known Implementing Classes:

AbstractAssociationRegistrationHandler, AbstractlVerifierRegistrationHandler, AbstractRegistrationHandler, BusinessObjectAssociationRegistrationHandler, CaptchaRegistrationHandler, ChainHandler, EmailVerifierRegistrationHandler

public interface RegistrationHandler
extends Handler

Defines an interface to introduce custom controls and actions into the registration process at a business level.

Author:

svetrini, pmoretti, rlogiacco

Field Summary

static Domain	domain
static org.apache.commons.logging.Log	logger
static java.lang.String	STATE_END
static java.lang.String	STATE_INSERT_UPDATE
static java.lang.String	STATE_START

Method Summary

java.util.List	getStates()
java.lang.String	onRegister(java.util.Map props, java.lang.String step) This method is invoked while the user creation is in progress meaning the user could have already obtained a unique identifier.
java.lang.String	onUpdate(User user, java.util.Map props, java.lang.String step) This method is invoked before a request of user informations update is performed.

Methods inherited from interface net.smartlab.web.auth.Handler

destroy, getId, init, setId

Field Detail

STATE_START

static final java.lang.String STATE_START

See Also:

Constant Field Values

STATE_INSERT_UPDATE

static final java.lang.String STATE_INSERT_UPDATE

See Also:

Constant Field Values

STATE_END

static final java.lang.String STATE_END

See Also:

Constant Field Values

logger

static final org.apache.commons.logging.Log logger

domain

static final Domain domain

Method Detail

onRegister

java.lang.String onRegister(java.util.Map props,
                            java.lang.String step)
                            throws java.lang.Exception

This method is invoked while the user creation is in progress meaning the user could have already obtained a unique identifier. Implementations can process custom properties and create linked informations and structures. For multi step registration procedures an optional step parameter can be used to distinguish between each step. FIXME documentation

Parameters:

props - additional properties not directly managed by the module.

step - indicates the internal handler status to be used for multi step registration procedures.

Returns:

the next step to be processed.

Throws:

java.lang.Exception - if the registration couldn't be performed for some reason described into the exception message.

onUpdate

java.lang.String onUpdate(User user,
                          java.util.Map props,
                          java.lang.String step)
                          throws java.lang.Exception

This method is invoked before a request of user informations update is performed. Implementations should verify the ongoing changes doesn't break any business or security constraint. For multi step update procedures an optional step parameter can be used to distinguish between each step.

Parameters:

user - the user already updated but not yet committed.

props - additional properties not directly managed by the module.

step - indicates the internal handler status to be used for multi step registration procedures.

Returns:

the next step to be processed.

Throws:

java.lang.Exception - if the update shouldn't be performed for some reason described into the exception message.

getStates

java.util.List getStates()