com.atlassian.jira.web.landingpage

Class LandingPageRedirectManager

java.lang.Object

com.atlassian.jira.web.landingpage.LandingPageRedirectManager

@ThreadSafe
 @Internal
 @ParametersAreNonnullByDefault
public class LandingPageRedirectManager
extends Object

Allows to add redirects for user's landing page (location where users are taken after login).

Currently landing page redirects work on: - Dashboard - default landing page for users in Server mode - MyJIRAHome - default landing page for users in Cloud - Jira Setup Completed - when user finished setting up JIRA.

Since:

v7.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	DARK_FEATURE_DISABLE_LANDING_PAGE_REDIRECT_FLAG

Constructor Summary

Constructors

Constructor and Description
LandingPageRedirectManager(FeatureManager featureManager)

Method Summary

Modifier and Type	Method and Description
Optional<String>	redirectUrl(ApplicationUser applicationUser) Determines the redirect URL for landing page.
void	registerRedirect(PageRedirect redirect, int priority) Adds page redirection of landing page to a specified location.
boolean	unregisterRedirect(PageRedirect redirectToRemove) Removes redirection to the given url.

Methods inherited from class java.lang.Object

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

Field Detail

DARK_FEATURE_DISABLE_LANDING_PAGE_REDIRECT_FLAG

public static final String DARK_FEATURE_DISABLE_LANDING_PAGE_REDIRECT_FLAG

See Also:

Constant Field Values

Constructor Detail

LandingPageRedirectManager

public LandingPageRedirectManager(FeatureManager featureManager)

Method Detail

registerRedirect

public void registerRedirect(PageRedirect redirect,
                             int priority)

Adds page redirection of landing page to a specified location.

Parameters:

redirect - to add.

priority - of the redirect; the lower the value the higher the priority. Redirects with higher priority will take a precedence.

unregisterRedirect

public boolean unregisterRedirect(PageRedirect redirectToRemove)

Removes redirection to the given url.

Parameters:

redirectToRemove - which should be removed

Returns:

true if page redirect has been removed.

redirectUrl

public Optional<String> redirectUrl(@Nullable
                                    ApplicationUser applicationUser)

Determines the redirect URL for landing page.

Returns:

url that landing page should be redirected to or Optional.empty() if there are no active redirects.