com.atlassian.crowd.plugin.descriptors

Class DecoratorModuleDescriptor

java.lang.Object

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

com.atlassian.crowd.plugin.descriptors.DecoratorModuleDescriptor

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor<PluginProvidedDecoratorModule>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware

public final class DecoratorModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<PluginProvidedDecoratorModule>

Implements the <decorator> plugin module. Provide a decorator for urls that matches the given patterns.

 <decorator name="name-of-decorator" key="key-of-decorator" page="path/to/servlet">
   <description>description</description>
   <pattern>/admin/*</pattern>
   <pattern>/plugins/*</pattern>
 </decorator>
 

Field Summary

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

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

Constructor Summary

Constructors

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

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

getDisplayName

Constructor Detail

DecoratorModuleDescriptor

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

Method Detail

init

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

Specified by:

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

Overrides:

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

Throws:

com.atlassian.plugin.PluginParseException

getModule

public PluginProvidedDecoratorModule getModule()

Specified by:

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

Specified by:

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