com.atlassian.jira.event.user

Interface UserEventFactory

All Known Implementing Classes:

UserEventFactoryImpl

public interface UserEventFactory

Common interface to create UserEvent and it's subclasses.

Since:

v8.12

Method Summary

Modifier and Type	Method and Description
UserEvent	newCannotChangePasswordEvent(Map<String,Object> params, ApplicationUser user) Creates a new UserEvent instance about an user not being able to change password, with the provided arguments.
UserEvent	newForgotPasswordEvent(Map<String,Object> params, ApplicationUser user) Creates a new UserEvent instance about an user triggering the forgot password feature, with the provided arguments.
UserEvent	newForgotUsernameEvent(Map<String,Object> params, ApplicationUser user) Creates a new UserEvent instance about an user triggering the forgot username feature, with the provided arguments.
UserEvent	newUserEventWithExtendedParams(Map<String,Object> params, ApplicationUser user, int type) Creates a new UserEvent instance with the provided arguments.

Method Detail

newUserEventWithExtendedParams

@Nonnull
UserEvent newUserEventWithExtendedParams(@Nonnull
                                                  Map<String,Object> params,
                                                  @Nullable
                                                  ApplicationUser user,
                                                  int type)

Creates a new UserEvent instance with the provided arguments. The provided params will be extended with more predefined ones.

Parameters:

params - a map of parameters for the event

user - the user this event is concerning

type - type of the event

Returns:

a new instance of UserEvent

newForgotPasswordEvent

@Nonnull
UserEvent newForgotPasswordEvent(@Nonnull
                                          Map<String,Object> params,
                                          @Nullable
                                          ApplicationUser user)

Creates a new UserEvent instance about an user triggering the forgot password feature, with the provided arguments. The provided params will be extended with more predefined ones.

Parameters:

params - a map of parameters for the event

user - the user this event is concerning

Returns:

a new instance of UserEvent that represent a forgot password event

newCannotChangePasswordEvent

@Nonnull
UserEvent newCannotChangePasswordEvent(@Nonnull
                                                Map<String,Object> params,
                                                @Nullable
                                                ApplicationUser user)

Creates a new UserEvent instance about an user not being able to change password, with the provided arguments. The provided params will be extended with more predefined ones.

Parameters:

params - a map of parameters for the event

user - the user this event is concerning

Returns:

a new instance of UserEvent that represent a cannot change password event

newForgotUsernameEvent

@Nonnull
UserEvent newForgotUsernameEvent(@Nonnull
                                          Map<String,Object> params,
                                          @Nullable
                                          ApplicationUser user)

Creates a new UserEvent instance about an user triggering the forgot username feature, with the provided arguments. The provided params will be extended with more predefined ones.

Parameters:

params - a map of parameters for the event

user - the user this event is concerning

Returns:

a new instance of UserEvent that represent a forgot username event