com.atlassian.plugins.rest.module

Class RestModuleDescriptor

java.lang.Object

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

com.atlassian.plugins.rest.module.RestModuleDescriptor

All Implemented Interfaces:

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

public class RestModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Object>

The REST module descriptor.

Example configuration in your plugin descriptor:

<rest key="module-key">
<url-pattern>/myapi/*</url-pattern>
</rest>

Your REST apis will then be available at /context/rest/myapi

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
RestModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory, RestServletModuleManager servletModuleManager, String restContext)

Method Summary

Modifier and Type	Method and Description
void	disabled()
void	enabled()
boolean	equals(Object o)
Object	getModule()
RestApiContext	getRestApiContext()
int	hashCode()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
String	toString()

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RestModuleDescriptor

public RestModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory,
                            RestServletModuleManager servletModuleManager,
                            String restContext)

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<Object>

Overrides:

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

Throws:

com.atlassian.plugin.PluginParseException

getRestApiContext

public RestApiContext getRestApiContext()

getModule

public Object getModule()

Specified by:

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

Specified by:

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

Returns:

null, the REST module descriptor doesn't instansiate any module.

equals

public boolean equals(Object o)

Specified by:

equals in interface com.atlassian.plugin.ModuleDescriptor<Object>

Overrides:

equals in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Object>

hashCode

public int hashCode()

Specified by:

hashCode in interface com.atlassian.plugin.ModuleDescriptor<Object>

Overrides:

hashCode in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Object>

toString

public String toString()

Overrides:

toString in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Object>

disabled

public void disabled()

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

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

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

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