Package com.broadleafcommerce.auth.user.service

Class DefaultUserMessagingService

java.lang.Object

com.broadleafcommerce.auth.user.service.DefaultUserMessagingService

All Implemented Interfaces:

UserMessagingService<User>

public class DefaultUserMessagingService
extends Object
implements UserMessagingService<User>

Author:

Nathan Moore (nathanmoore).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TOKEN
static final String	URL_REGEX

Constructor Summary

Constructors

Constructor	Description
DefaultUserMessagingService(AuthorizedClientService<AuthorizedClient> clientService, AuthorizationServerService<AuthorizationServer> serverService, com.broadleafcommerce.common.messaging.authentication.AuthenticationMessageProducer messageProducer, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected com.broadleafcommerce.data.tracking.core.context.ContextInfo	buildContextInfo(User user, PasswordResetEmailRequestDTO request)
protected com.broadleafcommerce.data.tracking.core.context.ContextInfo	buildContextInfo(User user, String clientId)
protected String	buildResetPasswordUri(String token)	Deprecated. use buildResetPasswordUri(String, String)
protected String	buildResetPasswordUri(String token, String clientId)
protected AuthenticationEvent	createResetPasswordEvent(@NonNull User user, @NonNull String token, @NonNull String clientId)
protected ApplicationService<Application>	getApplicationService()
protected String	getClientId(jakarta.servlet.http.HttpServletRequest req)
protected AuthorizedClientService<AuthorizedClient>	getClientService()
protected com.broadleafcommerce.common.messaging.authentication.AuthenticationMessageProducer	getMessageProducer()
protected String	getRedirectUrlParam()
protected Optional<jakarta.servlet.http.HttpServletRequest>	getRequest()
protected String	getResetPasswordBaseContextPath(@NonNull jakarta.servlet.http.HttpServletRequest request, AuthorizedClient client)	Gets the context path the precedes the reset password view's name, e.g., /auth.
protected String	getResetPasswordBaseUrl(@NonNull jakarta.servlet.http.HttpServletRequest request, AuthorizedClient client)	Responsible for getting the base URL to use for the reset password request.
protected String	getResetPasswordUrl(@NonNull jakarta.servlet.http.HttpServletRequest request, String clientId)
protected String	getResetPasswordUrl(jakarta.servlet.http.HttpServletRequest request)	Deprecated. use getResetPasswordUrl(HttpServletRequest, String)
protected String	getResetPasswordView()
protected AuthorizationServerService<AuthorizationServer>	getServerService()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected void	sendAuthenticationMessage(@NonNull AuthenticationEvent event)	Responsible for actually sending the event message
void	sendPasswordChangedEmail(@NonNull User user, @NonNull String clientId)	Dispatches a "PASSWORD_CHANGED" AuthenticationEvent.
void	sendResetPasswordEmail(@NonNull User user, @NonNull String token, @NonNull PasswordResetEmailRequestDTO request)	Dispatches a "RESET_PASSWORD" AuthenticationEvent.
void	sendResetPasswordEmail(@NonNull User user, @NonNull String token, @NonNull String clientId)	Dispatches a "RESET_PASSWORD" AuthenticationEvent.
void	setApplicationService(ApplicationService<Application> applicationService)

Methods inherited from class java.lang.Object

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

Field Details

TOKEN

public static final String TOKEN

See Also:

• Constant Field Values

URL_REGEX

public static final String URL_REGEX

See Also:

• Constant Field Values

Constructor Details

DefaultUserMessagingService

public DefaultUserMessagingService(AuthorizedClientService<AuthorizedClient> clientService,
 AuthorizationServerService<AuthorizationServer> serverService,
 com.broadleafcommerce.common.messaging.authentication.AuthenticationMessageProducer messageProducer,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

sendResetPasswordEmail

public void sendResetPasswordEmail(@NonNull
 @NonNull User user,
 @NonNull
 @NonNull String token,
 @NonNull
 @NonNull String clientId)

Description copied from interface: UserMessagingService

Dispatches a "RESET_PASSWORD" AuthenticationEvent.

Specified by:

sendResetPasswordEmail in interface UserMessagingService<User>

Parameters:

user - the user requesting a reset password.

token - the secure token to facilitate the password reset.

clientId - the client id associated with the request.

sendResetPasswordEmail

public void sendResetPasswordEmail(@NonNull
 @NonNull User user,
 @NonNull
 @NonNull String token,
 @NonNull
 @NonNull PasswordResetEmailRequestDTO request)

Description copied from interface: UserMessagingService

Dispatches a "RESET_PASSWORD" AuthenticationEvent.

Specified by:

sendResetPasswordEmail in interface UserMessagingService<User>

Parameters:

user - the user requesting a reset password.

token - the secure token to facilitate the password reset.

request - the request DTO to reset password

sendPasswordChangedEmail

public void sendPasswordChangedEmail(@NonNull
 @NonNull User user,
 @NonNull
 @NonNull String clientId)

Description copied from interface: UserMessagingService

Dispatches a "PASSWORD_CHANGED" AuthenticationEvent.

Specified by:

sendPasswordChangedEmail in interface UserMessagingService<User>

Parameters:

user - the user requesting a reset password.

clientId - the client id associated with the request.

createResetPasswordEvent

protected AuthenticationEvent createResetPasswordEvent(@NonNull
 @NonNull User user,
 @NonNull
 @NonNull String token,
 @NonNull
 @NonNull String clientId)

sendAuthenticationMessage

protected void sendAuthenticationMessage(@NonNull
 @NonNull AuthenticationEvent event)

Responsible for actually sending the event message

Parameters:

event - the event to be sent

buildContextInfo

protected com.broadleafcommerce.data.tracking.core.context.ContextInfo buildContextInfo(User user,
 String clientId)

buildContextInfo

protected com.broadleafcommerce.data.tracking.core.context.ContextInfo buildContextInfo(User user,
 PasswordResetEmailRequestDTO request)

buildResetPasswordUri

protected String buildResetPasswordUri(String token,
 String clientId)

buildResetPasswordUri

@Deprecated
protected String buildResetPasswordUri(String token)

Deprecated.

use buildResetPasswordUri(String, String)

getResetPasswordUrl

protected String getResetPasswordUrl(@NonNull
 @NonNull jakarta.servlet.http.HttpServletRequest request,
 @Nullable
 String clientId)

getResetPasswordBaseUrl

protected String getResetPasswordBaseUrl(@NonNull
 @NonNull jakarta.servlet.http.HttpServletRequest request,
 @Nullable
 AuthorizedClient client)

Responsible for getting the base URL to use for the reset password request. This is used by getResetPasswordUrl(HttpServletRequest, String). First, it will look at the AuthorizedClient.getResetPasswordBaseUri(), then AuthorizedClient.getDefaultRedirectUri(). If those are blank, it will try X-Forwarded headers assuming there is a gateway proxying requests. Finally, if X-Forwarded headers are also blank, then it will reconstruct the URL based on the original request's URL.

Parameters:

request - The original http request

client - The client matching the client id provided in the request if found.

Returns:

The base URL to use for the reset password request.

getResetPasswordBaseContextPath

protected String getResetPasswordBaseContextPath(@NonNull
 @NonNull jakarta.servlet.http.HttpServletRequest request,
 @Nullable
 AuthorizedClient client)

Gets the context path the precedes the reset password view's name, e.g., /auth. This is used by getResetPasswordUrl(HttpServletRequest, String) and is appended to the result of getResetPasswordBaseUrl(HttpServletRequest, AuthorizedClient).

Parameters:

request - The original http request

client - The client matching the client id provided in the request if found.

Returns:

The context path the precedes the reset password view's name, e.g., /auth.

getResetPasswordUrl

@Deprecated
protected String getResetPasswordUrl(jakarta.servlet.http.HttpServletRequest request)

Deprecated.

use getResetPasswordUrl(HttpServletRequest, String)

getResetPasswordView

protected String getResetPasswordView()

getRedirectUrlParam

protected String getRedirectUrlParam()

getRequest

protected Optional<jakarta.servlet.http.HttpServletRequest> getRequest()

getClientId

protected String getClientId(jakarta.servlet.http.HttpServletRequest req)

getClientService

protected AuthorizedClientService<AuthorizedClient> getClientService()

getServerService

protected AuthorizationServerService<AuthorizationServer> getServerService()

getMessageProducer

protected com.broadleafcommerce.common.messaging.authentication.AuthenticationMessageProducer getMessageProducer()

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()

setApplicationService

@Autowired
public void setApplicationService(ApplicationService<Application> applicationService)

getApplicationService

protected ApplicationService<Application> getApplicationService()