com.atlassian.confluence.plugins.pluginstartuptest

Class PluginStartupTestResource

java.lang.Object

com.atlassian.confluence.plugins.pluginstartuptest.PluginStartupTestResource

public class PluginStartupTestResource
extends Object

For PluginStartupAcceptanceTest and PluginStartupCloudTest.

A resource to report plugin and module enablement state, and whether module descriptor's getModule() throws an exception.

Constructor Summary

Constructors

Constructor and Description
PluginStartupTestResource(com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getBrokenModules(String whitelist) Return a list of all broken plugin modules: enabled modules where descriptor.getModule() throws an exception other than UnsupportedOperationException
javax.ws.rs.core.Response	getDisabledModules(String whitelist) Return a list of all disabled plugin modules (only those in enabled plugins).
javax.ws.rs.core.Response	getDisabledPlugins(String whitelist) Return a list of all disabled plugins.
static boolean	moduleIsSupposedToBeDisabled(com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor)

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginStartupTestResource

public PluginStartupTestResource(com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Detail

getDisabledPlugins

public javax.ws.rs.core.Response getDisabledPlugins(String whitelist)

Return a list of all disabled plugins.

Parameters:

whitelist - optional: which whitelist to use:

• empty / unset (no whitelist) - default
• "acceptance-test" (PluginStartupAcceptanceTestWhitelist)
• "cloud-test" (PluginStartupCloudTestWhitelist)

Returns:

200 with a list of disabled plugin keys, after applying any whitelist

getDisabledModules

public javax.ws.rs.core.Response getDisabledModules(String whitelist)

Return a list of all disabled plugin modules (only those in enabled plugins).

Parameters:

whitelist - optional: which whitelist to use:

• empty / unset (no whitelist) - default
• "acceptance-test" (PluginStartupAcceptanceTestWhitelist)
• "cloud-test" (PluginStartupCloudTestWhitelist)

Returns:

200 with a list of disabled plugin module keys, after applying any whitelist

moduleIsSupposedToBeDisabled

public static boolean moduleIsSupposedToBeDisabled(com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor)

getBrokenModules

public javax.ws.rs.core.Response getBrokenModules(String whitelist)

Return a list of all broken plugin modules: enabled modules where descriptor.getModule() throws an exception other than UnsupportedOperationException

Parameters:

whitelist - optional: which whitelist to use:

• empty / unset (no whitelist) - default
• "acceptance-test" (PluginStartupAcceptanceTestWhitelist)
• "cloud-test" (PluginStartupCloudTestWhitelist)

Returns:

200 with a list of broken modules and their failures, after applying any whitelist