Package org.apereo.cas.pm.web.flow.actions

Class SendForgotUsernameInstructionsAction

  • All Implemented Interfaces:
    org.springframework.beans.factory.InitializingBean, org.springframework.webflow.execution.Action
    public class SendForgotUsernameInstructionsAction
extends org.apereo.cas.web.flow.actions.BaseCasWebflowAction
    This is SendForgotUsernameInstructionsAction.
    Since:
    6.0.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.apereo.cas.configuration.CasConfigurationProperties casProperties
      The CAS configuration properties.
      protected org.apereo.cas.notifications.CommunicationsManager communicationsManager
      The communication manager for SMS/emails.
      protected org.apereo.cas.pm.PasswordManagementService passwordManagementService
      The password management service.
      protected org.apereo.cas.authentication.principal.PrincipalResolver principalResolver
      The principal resolver to resolve the user and fetch attributes for follow-up ops, such as email message body building.
      static java.lang.String REQUEST_PARAMETER_EMAIL
      Parameter name to look up the user.

      • Fields inherited from class org.springframework.webflow.action.AbstractAction

        logger

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected org.springframework.webflow.execution.Event doExecute​(org.springframework.webflow.execution.RequestContext requestContext)  
      protected org.springframework.webflow.execution.Event getErrorEvent​(java.lang.String code, java.lang.String defaultMessage, org.springframework.webflow.execution.RequestContext requestContext)  
      protected org.springframework.webflow.execution.Event locateUserAndProcess​(org.springframework.webflow.execution.RequestContext requestContext, org.apereo.cas.pm.PasswordManagementQuery query)
      Process forgot username email and do a lookup.
      protected org.apereo.cas.notifications.mail.EmailCommunicationResult sendForgotUsernameEmailToAccount​(org.apereo.cas.pm.PasswordManagementQuery query, org.springframework.webflow.execution.RequestContext requestContext)  

      • Methods inherited from class org.apereo.cas.web.flow.actions.BaseCasWebflowAction

        isLoginFlowActive

      • Methods inherited from class org.springframework.webflow.action.AbstractAction

        afterPropertiesSet, doPostExecute, doPreExecute, error, error, execute, getActionNameForLogging, getEventFactorySupport, initAction, no, result, result, result, result, success, success, yes

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • REQUEST_PARAMETER_EMAIL

        public static final java.lang.String REQUEST_PARAMETER_EMAIL
        Parameter name to look up the user.
        See Also:
        Constant Field Values

      • casProperties

        protected final org.apereo.cas.configuration.CasConfigurationProperties casProperties
        The CAS configuration properties.

      • communicationsManager

        protected final org.apereo.cas.notifications.CommunicationsManager communicationsManager
        The communication manager for SMS/emails.

      • passwordManagementService

        protected final org.apereo.cas.pm.PasswordManagementService passwordManagementService
        The password management service.

      • principalResolver

        protected final org.apereo.cas.authentication.principal.PrincipalResolver principalResolver
        The principal resolver to resolve the user and fetch attributes for follow-up ops, such as email message body building.

    • Constructor Detail

      • SendForgotUsernameInstructionsAction

        public SendForgotUsernameInstructionsAction()

    • Method Detail

      • doExecute

        protected org.springframework.webflow.execution.Event doExecute​(org.springframework.webflow.execution.RequestContext requestContext)
        Specified by:
        doExecute in class org.springframework.webflow.action.AbstractAction

      • locateUserAndProcess

        protected org.springframework.webflow.execution.Event locateUserAndProcess​(org.springframework.webflow.execution.RequestContext requestContext,
                                                                           org.apereo.cas.pm.PasswordManagementQuery query)
        Process forgot username email and do a lookup.
        Parameters:
        requestContext - the request context
        query - the query
        Returns:
        the event

      • sendForgotUsernameEmailToAccount

        protected org.apereo.cas.notifications.mail.EmailCommunicationResult sendForgotUsernameEmailToAccount​(org.apereo.cas.pm.PasswordManagementQuery query,
                                                                                                      org.springframework.webflow.execution.RequestContext requestContext)

      • getErrorEvent

        protected org.springframework.webflow.execution.Event getErrorEvent​(java.lang.String code,
                                                                    java.lang.String defaultMessage,
                                                                    org.springframework.webflow.execution.RequestContext requestContext)