com.atlassian.confluence.core

Class ConfluenceSystemProperties

java.lang.Object

com.atlassian.confluence.core.ConfluenceSystemProperties

public class ConfluenceSystemProperties
extends Object

Query the status of various Confluence system properties

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATABASE_PLUGINLOADER_DISABLED_PROPERTY_KEY
static String	DEFAULT_JDBC_DRIVER_CLASS_NAME
static String	IDENTITY_PLATFORM_ENABLED
static String	MULTITENANTED_DEV_MODE
static String	UNICORN_INSTANCE_SYSTEM_PROPERTY_KEY
static String	UNIFIED_USER_MANAGEMENT_KEY
static String	VERTIGO_INSTANCE_SYSTEM_PROPERTY_KEY
static String	VERTIGO_PROVISIONED_SYSTEM_PROPERTY_KEY
static String	VERTIGO_WEBINTERFACE_SYSTEM_PROPERTY_KEY

Constructor Summary

Constructors

Constructor and Description
ConfluenceSystemProperties()

Method Summary

Modifier and Type	Method and Description
static String	getConfluenceBaseUrlCDNPrefix()
static String	getConfluenceFixedCDNPrefix()
static String	getConfluenceFrontendServiceURL()
static String	getDefaultJdbcDriverClassName() Returns the default Jdbc driver class name, it is needed as under tomcat and when tomcat starts, the JavaSE Service Provider mechanism will find, discover and register only Jdbc drivers that are located under the tomcat lib directory but not under the application WEB-INF/lib directory.
static String	getMemcachedAddress()
static String	getMemcachedHost()
static String	getMemcachedPort()
static String	getTcapiFallbackEndpoint()
static String	getTcapiPrimaryEndpoint()
static String	getVertigoProtocol() Return the vertigo transport/protocol.
static int	getWebFragmentCacheDuration()
static String	getWebFragmentLocation()
static boolean	isAjsLogRendered()
static boolean	isAjsLogVisible()
static boolean	isBackupPathSetAllowed() Checks the confluence.backup.path.set.allowed property, to see if the backup path can be modified in the admin console.
static boolean	isBandanaPrefetchLoggingEnabled()
static boolean	isBandanaPrefixPrefetchingDisabled()
static boolean	isBundledPluginsDisabled()
static boolean	isContextBatchingDisabled()
static boolean	isDatabasePluginLoaderDisabled()
static boolean	isDevMode()
static boolean	isDisableCaches()
static boolean	isExternalUserManagementEnabled() Returns true if external user management should be used instead of Confluence's internal user management.
static boolean	isForceCacheExternalisationEnabled() All caches must be externalised to memcached in vertigo mode
static boolean	isIdentityPlatformEnabled() Returns true if the identity platform is enabled
static boolean	isLocalBandanaPrefetchLoggingEnabled()
static boolean	isMultiTenantedDevMode() Returns true if confluence is running in a multi-tenanted dev mode.
static boolean	isUnicornInstance() Returns true if confluence is running as a unicorn instance.
static boolean	isVertigoInstance() Returns true if confluence is running as a vertigo instance.
static boolean	isVertigoProvisioned() Returns true if confluence is being provisioned in a vertigo world.
static boolean	isVertigoWebInterface() Returns true if Confluence should use the vertigo web interface manager.
static boolean	shouldPluginStateBeStoredInMemory() Ensures that the checking of plugin state doesn't use the database.

Methods inherited from class java.lang.Object

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

Field Detail

VERTIGO_PROVISIONED_SYSTEM_PROPERTY_KEY

public static final String VERTIGO_PROVISIONED_SYSTEM_PROPERTY_KEY

See Also:

Constant Field Values

VERTIGO_WEBINTERFACE_SYSTEM_PROPERTY_KEY

public static final String VERTIGO_WEBINTERFACE_SYSTEM_PROPERTY_KEY

See Also:

Constant Field Values

UNICORN_INSTANCE_SYSTEM_PROPERTY_KEY

public static final String UNICORN_INSTANCE_SYSTEM_PROPERTY_KEY

See Also:

Constant Field Values

DEFAULT_JDBC_DRIVER_CLASS_NAME

public static final String DEFAULT_JDBC_DRIVER_CLASS_NAME

See Also:

Constant Field Values

VERTIGO_INSTANCE_SYSTEM_PROPERTY_KEY

public static final String VERTIGO_INSTANCE_SYSTEM_PROPERTY_KEY

See Also:

Constant Field Values

MULTITENANTED_DEV_MODE

public static final String MULTITENANTED_DEV_MODE

See Also:

Constant Field Values

DATABASE_PLUGINLOADER_DISABLED_PROPERTY_KEY

public static final String DATABASE_PLUGINLOADER_DISABLED_PROPERTY_KEY

See Also:

Constant Field Values

UNIFIED_USER_MANAGEMENT_KEY

public static final String UNIFIED_USER_MANAGEMENT_KEY

See Also:

Constant Field Values

IDENTITY_PLATFORM_ENABLED

public static final String IDENTITY_PLATFORM_ENABLED

See Also:

Constant Field Values

Constructor Detail

ConfluenceSystemProperties

public ConfluenceSystemProperties()

Method Detail

isDevMode

public static boolean isDevMode()

Returns:

true if Confluence development mode is enabled

isDisableCaches

public static boolean isDisableCaches()

isBundledPluginsDisabled

public static boolean isBundledPluginsDisabled()

Returns:

true if bundled plugins are disabled

isBackupPathSetAllowed

public static boolean isBackupPathSetAllowed()

Checks the confluence.backup.path.set.allowed property, to see if the backup path can be modified in the admin console.

Returns:

true iff the property is set to 'true'

isAjsLogRendered

public static boolean isAjsLogRendered()

isAjsLogVisible

public static boolean isAjsLogVisible()

isContextBatchingDisabled

public static boolean isContextBatchingDisabled()

getConfluenceFrontendServiceURL

@Nullable
public static String getConfluenceFrontendServiceURL()

getConfluenceFixedCDNPrefix

@Nullable
public static String getConfluenceFixedCDNPrefix()

getConfluenceBaseUrlCDNPrefix

@Nullable
public static String getConfluenceBaseUrlCDNPrefix()

isForceCacheExternalisationEnabled

public static boolean isForceCacheExternalisationEnabled()

All caches must be externalised to memcached in vertigo mode

getMemcachedHost

public static String getMemcachedHost()

getMemcachedPort

public static String getMemcachedPort()

getMemcachedAddress

public static String getMemcachedAddress()

getWebFragmentCacheDuration

public static int getWebFragmentCacheDuration()

Returns:

The soft TTL to be used for a web fragment cache, in minutes

getWebFragmentLocation

public static String getWebFragmentLocation()

Returns:

The URL of the bucket that web fragments are located in

isBandanaPrefetchLoggingEnabled

public static boolean isBandanaPrefetchLoggingEnabled()

isLocalBandanaPrefetchLoggingEnabled

public static boolean isLocalBandanaPrefetchLoggingEnabled()

isBandanaPrefixPrefetchingDisabled

public static boolean isBandanaPrefixPrefetchingDisabled()

isVertigoInstance

public static boolean isVertigoInstance()

Returns true if confluence is running as a vertigo instance. Vertigo mode is enabled by setting the system property "vertigo.instance" to true.

isUnicornInstance

public static boolean isUnicornInstance()

Returns true if confluence is running as a unicorn instance. Unicorn mode is enabled by setting the system property "unicorn.instance" to true.

isVertigoProvisioned

public static boolean isVertigoProvisioned()

Returns true if confluence is being provisioned in a vertigo world. This means we rely on the Cloud Provisioning Service and our entry point for provisioning is ProvisioningServlet. Vertigo provisioning mode is enabled by the presence of the system property "vertigo.provisioned".

isVertigoWebInterface

public static boolean isVertigoWebInterface()

Returns true if Confluence should use the vertigo web interface manager. This means Confluence will use a WebInterfaceManager implementation which allows Connect to inject per reqeust web fragments using the DynamicModuleProvider SPI.

Returns:

true iff we should use the VertigoWebInterfaceManager.

getDefaultJdbcDriverClassName

public static String getDefaultJdbcDriverClassName()

Returns the default Jdbc driver class name, it is needed as under tomcat and when tomcat starts, the JavaSE Service Provider mechanism will find, discover and register only Jdbc drivers that are located under the tomcat lib directory but not under the application WEB-INF/lib directory.

shouldPluginStateBeStoredInMemory

public static boolean shouldPluginStateBeStoredInMemory()

Ensures that the checking of plugin state doesn't use the database. Similar to how things will be in Vertigo.

Returns:

If plugin state should be stored in memory

isDatabasePluginLoaderDisabled

public static boolean isDatabasePluginLoaderDisabled()

getTcapiPrimaryEndpoint

public static String getTcapiPrimaryEndpoint()

getTcapiFallbackEndpoint

public static String getTcapiFallbackEndpoint()

isMultiTenantedDevMode

public static boolean isMultiTenantedDevMode()

Returns true if confluence is running in a multi-tenanted dev mode. Multi-tenanted dev mode is enabled by setting the system property "dev.mode.multitenanted" to true.

getVertigoProtocol

public static String getVertigoProtocol()

Return the vertigo transport/protocol.

isIdentityPlatformEnabled

public static boolean isIdentityPlatformEnabled()

Returns true if the identity platform is enabled

isExternalUserManagementEnabled

public static boolean isExternalUserManagementEnabled()

Returns true if external user management should be used instead of Confluence's internal user management. Internal UM is still useful for local dev and CI, while external UM should be used for real instances in Unicorn and Vertigo.