com.atlassian.confluence.plugin.descriptor

Class WelcomeFileModuleDescriptor

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<String>

com.atlassian.confluence.plugin.descriptor.WelcomeFileModuleDescriptor

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor<String>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware, com.atlassian.plugin.web.descriptors.WeightedDescriptor

Deprecated.

since 5.9. welcome-file modules are no longer supported (and were never documented to begin with).

Note to any CQ devs reading this: this module type was added to support CQ Standalone, but that project seems to be dead, so this welcome-file infrastructure just adds complexity for no purpose. If we want to resurrect it, then we'll need to rethink.

@Deprecated
public class WelcomeFileModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<String>
implements com.atlassian.plugin.web.descriptors.WeightedDescriptor

Descriptor that allows additional <welcome-file> to be declared in web.xml.

See Also:

IndexAction

Field Summary

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources, singleton

Constructor Summary

Constructors

Constructor and Description
WelcomeFileModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory) Deprecated.

Method Summary

Modifier and Type	Method and Description
String	getModule() Deprecated.
int	getWeight() Deprecated.
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element) Deprecated.

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, checkPermissions, destroy, destroy, disabled, enabled, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setBroken, setPlugin, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WelcomeFileModuleDescriptor

public WelcomeFileModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Deprecated.

Method Detail

init

public void init(@Nonnull
                 com.atlassian.plugin.Plugin plugin,
                 @Nonnull
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException

Deprecated.

Specified by:

init in interface com.atlassian.plugin.ModuleDescriptor<String>

Overrides:

init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<String>

Throws:

com.atlassian.plugin.PluginParseException

getModule

public String getModule()

Deprecated.

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor<String>

Specified by:

getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<String>

getWeight

public int getWeight()

Deprecated.

Specified by:

getWeight in interface com.atlassian.plugin.web.descriptors.WeightedDescriptor