com.atlassian.johnson.setup

Interface SetupConfig

All Known Implementing Classes:

DefaultSetupConfig

public interface SetupConfig

Allows Johnson to interrogate the application to determine whether it has been setup, and whether a given URI relates to its setup process (for those applications which offer web-based configuration).

Method Summary

Modifier and Type	Method and Description
boolean	isSetup() Retrieves a flag indicating whether the application has been setup.
boolean	isSetupPage(String uri) Retrieves a flag indicating whether the provided uri is a setup-related page.

Method Detail

isSetup

boolean isSetup()

Retrieves a flag indicating whether the application has been setup.

Returns:

true if the application has been setup; otherwise, false

isSetupPage

boolean isSetupPage(@Nonnull
                    String uri)

Retrieves a flag indicating whether the provided uri is a setup-related page.

Applications which require complex setup with multiple pages can implement this method to allow access to all of their pages when isSetup() returns false.

Note: This method is related, but not identical, to JohnsonConfig.getSetupPath(). That property provides the URL to which a user should be redirected when the application is not setup. It defines the entry point for setup. After the initial redirection, this method is used to determine whether a page being accessed is part of the setup process.

Parameters:

uri - the URI of a web page

Returns:

true if the URI references a setup page; otherwise, false