RestModuleDescriptor

Class Overview

The REST module descriptor.

Example configuration in your plugin descriptor:

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

Summary

[Expand] Inherited Fields
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor protected Class<T> moduleClass protected String moduleClassName protected final ModuleFactory moduleFactory protected Plugin plugin protected Resources resources protected boolean singleton

[Expand] Inherited Methods
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor final void assertModuleClassImplements(Class<T> arg0) void destroy(Plugin arg0) void disabled() void enabled() boolean equals(Object arg0) String getCompleteKey() String getDescription() String getDescriptionKey() String getI18nNameKey() String getKey() Float getMinJavaVersion() abstract T getModule() Class<T> getModuleClass() String getName() Map<String, String> getParams() Plugin getPlugin() String getPluginKey() ResourceDescriptor getResourceDescriptor(String arg0, String arg1) List<ResourceDescriptor> getResourceDescriptors() List<ResourceDescriptor> getResourceDescriptors(String arg0) ResourceLocation getResourceLocation(String arg0, String arg1) int hashCode() void init(Plugin arg0, Element arg1) boolean isEnabledByDefault() boolean isSingleton() boolean isSingletonByDefault() boolean isSystemModule() void loadClass(Plugin arg0, String arg1) void loadClass(Plugin arg0, Element arg1) void provideValidationRules(ValidationPattern arg0) boolean satisfiesMinJavaVersion() void setPlugin(Plugin arg0) String toString()
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface com.atlassian.plugin.ModuleDescriptor abstract void destroy(Plugin arg0) abstract boolean equals(Object arg0) abstract String getCompleteKey() abstract String getDescription() abstract String getDescriptionKey() abstract String getI18nNameKey() abstract String getKey() abstract Float getMinJavaVersion() abstract T getModule() abstract Class<T> getModuleClass() abstract String getName() abstract Map<String, String> getParams() abstract Plugin getPlugin() abstract String getPluginKey() abstract int hashCode() abstract void init(Plugin arg0, Element arg1) abstract boolean isEnabledByDefault() abstract boolean isSystemModule() abstract boolean satisfiesMinJavaVersion()
From interface com.atlassian.plugin.Resourced abstract ResourceDescriptor getResourceDescriptor(String arg0, String arg1) abstract List<ResourceDescriptor> getResourceDescriptors(String arg0) abstract List<ResourceDescriptor> getResourceDescriptors() abstract ResourceLocation getResourceLocation(String arg0, String arg1)
From interface com.atlassian.plugin.StateAware abstract void disabled() abstract void enabled()