com.esri.gpt.control.identity
Class SelfCareController

java.lang.Object
  com.esri.gpt.framework.jsf.BaseActionListener
      com.esri.gpt.control.identity.SelfCareController

All Implemented Interfaces:

EventListener, ActionListener, FacesListener

public class SelfCareController
extends BaseActionListener

Handles actions associated with user self care.

The action executed is based upon a supplied "command" attribute associated with the UIComponent that triggers the processAction event. Command values:

changePassword - executes a password change

recoverPassword - recovers a forgotten password

registerUser - registers a user

sendFeedback - sends a feedback message

updateProfile - executes a user profile update

Constructor Summary

SelfCareController()
Default constructor.

Method Summary

UserAttributeMap	getActiveUserAttributes() Gets the active user profile attributes.
String	getActiveUsername() Gets the active username.
ChangePasswordCriteria	getChangePasswordCriteria() Gets the change password criteria.
String	getEncryptedPwd() Encrypts a password for configuration file storage.
FeedbackMessage	getFeedbackMessage() Gets the message associated with user feedback.
HasAttributeMap	getHasUserAttribute() Returns a Map interface of configured user attributes to aid in determining if a user attribute should be rendered.
User	getNewUser() Gets the user associated with new registration requests.
UsernamePasswordCredentials	getNewUserCredentials() Gets the credentials associated with the new registration requests.
RecoverPasswordCriteria	getRecoverPasswordCriteria() Gets the recover password criteria.
protected void	processSubAction(ActionEvent event, RequestContext context) Handles a user self care action.
void	setActiveUsername(String ignored) Setter for the active username.
void	setEncryptedPwd(String ignore) This method does nothing, JSF chokes if it doesn't exist.

Methods inherited from class com.esri.gpt.framework.jsf.BaseActionListener

assertLoggedIn, authorizeAction, extractMessageBroker, extractRequestContext, getContextBroker, getKey, getLogger, getNavigationOutcome, getPrepareView, getSecurityRoles, getSecurityRoleSet, handleException, onExecutionPhaseCompleted, onExecutionPhaseStarted, onPrepareView, onPrepareViewCompleted, onPrepareViewStarted, processAction, setKey, setNavigationOutcome, setPrepareView, setSecurityRoles

Methods inherited from class java.lang.Object

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

Constructor Detail

SelfCareController

public SelfCareController()

Default constructor.

Method Detail

getActiveUserAttributes

public UserAttributeMap getActiveUserAttributes()

Gets the active user profile attributes.

This method is intended for use from a JSP page only.

Returns:

the active user profile attributes

getActiveUsername

public String getActiveUsername()

Gets the active username.
This is for display only.

Returns:

the active username

setActiveUsername

public void setActiveUsername(String ignored)

Setter for the active username.
This is for display only, the set is ignored

Parameters:

ignored -

getChangePasswordCriteria

public ChangePasswordCriteria getChangePasswordCriteria()

Gets the change password criteria.

Returns:

the change password criteria

getFeedbackMessage

public FeedbackMessage getFeedbackMessage()

Gets the message associated with user feedback.

Returns:

the feedback message

getHasUserAttribute

public HasAttributeMap getHasUserAttribute()

Returns a Map interface of configured user attributes to aid in determining if a user attribute should be rendered.
rendered="#{SelfCareController.hasUserAttribute['firstName']}"

Returns:

the configured attribute map interface

getNewUser

public User getNewUser()

Gets the user associated with new registration requests.

Returns:

the user associated with new registration requests

getNewUserCredentials

public UsernamePasswordCredentials getNewUserCredentials()

Gets the credentials associated with the new registration requests.

Returns:

the credentials associated with new registration requests

getEncryptedPwd

public String getEncryptedPwd()

Encrypts a password for configuration file storage.

Returns:

the enscypted password

setEncryptedPwd

public void setEncryptedPwd(String ignore)

This method does nothing, JSF chokes if it doesn't exist.

getRecoverPasswordCriteria

public RecoverPasswordCriteria getRecoverPasswordCriteria()

Gets the recover password criteria.

Returns:

the recover password criteria

processSubAction

protected void processSubAction(ActionEvent event,
                                RequestContext context)
                         throws AbortProcessingException,
                                Exception

Handles a user self care action.

The action executed is based upon a supplied "command" attribute associated with the UIComponent that triggered the processAction event. Command values:
changePassword, recoverPassword, registerUser, sendFeedback, updateProfile

This is the default entry point for a sub-class of BaseActionListener.
This BaseActionListener handles the JSF processAction method and invokes the processSubAction method of the sub-class.

Overrides:

processSubAction in class BaseActionListener

Parameters:

event - the associated JSF action event

context - the context associated with the active request

Throws:

AbortProcessingException - if processing should be aborted

Exception - if an exception occurs