com.atlassian.jira.web.startup

Class StartupPageSupport

java.lang.Object

com.atlassian.jira.web.startup.StartupPageSupport

public final class StartupPageSupport
extends Object

Static infrastructure related to the startup page, including filtering, constants, redirects, etc.

The startup page is delivered to the end user if any HTTP requests are received during the bootstrap process, to prevent Pico deadlocks or similar problems.

Since:

v7.1.0

See Also:

StartupServlet, LauncherContextListener, StartupProgressFilter

Field Summary

Fields

Modifier and Type	Field and Description
static String	STARTUP_JSP

Method Summary

Modifier and Type	Method and Description
static java.util.function.Function<String,String>	getTranslator(javax.servlet.http.HttpServletRequest request) Obtains a simple translation function for mapping message keys to translated text.
static boolean	isLaunched() Indicates whether JIRA is fully launched, in other words, it is safe to let requests hit JIRA itself rather than the startup page.
static boolean	isStartupPage(javax.servlet.http.HttpServletRequest request) Returns true if the provided request targets the startup page.
static boolean	isStartupPage(javax.servlet.ServletRequest request) Returns true if the provided request targets the startup page.
static void	redirectToStartupPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Redirects from the current page to startup.jsp.
static void	returnFromStartupJsp(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Redirects from startup.jsp to the original page.
static void	setLaunched(boolean launched) Marks JIRA as fully launched, in other words ready to handle requests.

Methods inherited from class java.lang.Object

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

Field Detail

STARTUP_JSP

public static final String STARTUP_JSP

See Also:

Constant Field Values

Method Detail

isLaunched

public static boolean isLaunched()

Indicates whether JIRA is fully launched, in other words, it is safe to let requests hit JIRA itself rather than the startup page.

Returns:

see above

See Also:

setLaunched(boolean)

setLaunched

public static void setLaunched(boolean launched)

Marks JIRA as fully launched, in other words ready to handle requests.

See Also:

isLaunched()

isStartupPage

public static boolean isStartupPage(javax.servlet.ServletRequest request)

Returns true if the provided request targets the startup page.

Parameters:

request - the current request

Returns:

true if the provided request targets the startup page; false if it is anything else.

isStartupPage

public static boolean isStartupPage(javax.servlet.http.HttpServletRequest request)

Returns true if the provided request targets the startup page.

Parameters:

request - the current request

Returns:

true if the provided request targets the startup page; false if it is anything else.

redirectToStartupPage

public static void redirectToStartupPage(javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpServletResponse response)
                                  throws IOException

Redirects from the current page to startup.jsp.

Parameters:

request - the current HTTP request

response - the current HTTP response

Throws:

IOException - if something goes wrong when sending the redirect (probably because the client disconnected)

returnFromStartupJsp

public static void returnFromStartupJsp(javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response)
                                 throws IOException

Redirects from startup.jsp to the original page.

Parameters:

request - the current HTTP request

response - the current HTTP response

Throws:

IOException - if something goes wrong when sending the redirect (probably because the client disconnected)

getTranslator

public static java.util.function.Function<String,String> getTranslator(javax.servlet.http.HttpServletRequest request)

Obtains a simple translation function for mapping message keys to translated text.

The locale is taken from the current request instead of the normal JIRA pattern of using a setting from the user's preferences or application properties because during startup those kinds of things may or may not be available, and changing what language is displayed for the same user in the same web browser would be very surprising, especially since the use of AJAX means that the same page would end up displaying more than one language at a time. It seems safest to just guess the locale based on the Accept-Language header from the user's browser, instead.

Note: These translations can only be provided by the special StartupPageSupport properties files and cannot be added to or altered by plugins (including language packs). What we build into JIRA is all you get.

Parameters:

request - the servlet request that wants a translated string

Returns:

the translated string