com.atlassian.plugin

Interface ScopeAware

All Known Subinterfaces:

ContainerManagedPlugin, ModuleDescriptor<T>, OsgiBackedPlugin, Plugin, PluginInternal

All Known Implementing Classes:

AbstractModuleDescriptor, AbstractPlugin, BaseServletModuleDescriptor, ComponentImportModuleDescriptor, ComponentModuleDescriptor, DefaultDynamicPlugin, DescribedModuleTypeModuleDescriptor, DownloadStrategyModuleDescriptor, DummyPlugin, EventListenerModuleDescriptor, ModuleTypeModuleDescriptor, OsgiBundlePlugin, OsgiPlugin, ServletContextListenerModuleDescriptor, ServletContextParamModuleDescriptor, ServletFilterModuleDescriptor, ServletModuleDescriptor, StaticPlugin, UnloadableModuleDescriptor, UnloadablePlugin, UnrecognisedModuleDescriptor, UnrecognisedModuleDescriptorRequiringRestart, XmlDynamicPlugin

Deprecated.

in 5.0 for removal in 6.0

@Deprecated
public interface ScopeAware

Makes class scope aware.

Intention of scope is to mark plugin or set of plugins as belonging to subset of product functionality which could be turned on/off in one go.

Given interface could be used in conjunction with ScopeManager which will take care about validating scope for current tenant.

Making plugin scope aware is done via adding <scope> element:

  <plugin-info><scope key = "/license/jira-service-desk"/></plugin-info>
 

once configured plugin itself and all modules will have that scope assigned.

Modules can opt out from scope by specifying `scope` attribute:

Since:

4.1

See Also:

ScopeManager

Method Summary

Modifier and Type	Method and Description
default Optional<String>	getScopeKey() Deprecated.

Method Detail

getScopeKey

default Optional<String> getScopeKey()

Deprecated.

Returns:

scope set or Optional.empty() if not defined