com.atlassian.confluence.rss

Class FeedSupportModuleDescriptor

java.lang.Object

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

com.atlassian.confluence.rss.FeedSupportModuleDescriptor

All Implemented Interfaces:

PluginModuleFactory<RssRenderSupport>, com.atlassian.plugin.ModuleDescriptor<RssRenderSupport>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware

public class FeedSupportModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<RssRenderSupport>
implements PluginModuleFactory<RssRenderSupport>

Allows plugins to provide builders for items in an RSS/Atom feed served by Confluence. Necessary plugin parameters are:

• class: must implement RssRenderSupport.
• renders: the fully qualified class name of the entity type that the builder supports

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
FeedSupportModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

Modifier and Type	Method and Description
RssRenderSupport	createModule()
void	disabled()
void	enabled()
RssRenderSupport	getModule()
String	getRenders()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)

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

assertModuleClassImplements, checkPermissions, destroy, destroy, 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

FeedSupportModuleDescriptor

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

Method Detail

init

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

Specified by:

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

Overrides:

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

Throws:

com.atlassian.plugin.PluginParseException

getModule

public RssRenderSupport getModule()

Specified by:

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

Specified by:

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

createModule

public RssRenderSupport createModule()

Specified by:

createModule in interface PluginModuleFactory<RssRenderSupport>

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<RssRenderSupport>

disabled

public void disabled()

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

disabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<RssRenderSupport>

getRenders

public String getRenders()