Package eu.rarogsoftware.rarog.platform.api.plugins

Interface FeatureModule<T extends FeatureDescriptor>

Type Parameters:
T - type of supported FeatureDescriptor
All Known Subinterfaces:
PurgeableFeatureModule<T>
All Known Implementing Classes:
AbstractSimpleFeatureModule, AdminPanelRestController, DefaultI18NextService, DescriptorBasedResourceResolver, EventListenersFeatureModule, MyAccountRestController, PluginAwareDynamicAssetsLoaderFactory, PluginDatabaseMigrator, PluginFilterResolver, PluginMappingHandlerMapping, PluginModuleTemplateResolver, PluginModuleViewResolver, PluginSecurityFilterResolver, SmartSwitchingServlet, UiFragmentsController
public interface FeatureModule<T extends FeatureDescriptor>
Represents single pluggable functionality in system. Plugin can expose its functionality for other plugins with this interface. Plugin can configure and/or provide resources for module with FeatureDescriptor FeatureDescriptor are automatically plugged/unplugged from system. There is no option to manually manipulate FeatureModules.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    plugDescriptor(Plugin plugin, T descriptor)
    Registers new descriptor into module.
    void
    unplugDescriptor(Plugin plugin, T descriptor)
    Unregisters new descriptor into module.

  • Method Details

    • plugDescriptor

      void plugDescriptor(Plugin plugin, T descriptor)
      Registers new descriptor into module. Module will use resources represented by descriptor to provide its functionality as long as descriptor is unplugged.
      Parameters:
      plugin - plugin that is parent of descriptor
      descriptor - feature descriptor to plug

    • unplugDescriptor

      void unplugDescriptor(Plugin plugin, T descriptor)
      Unregisters new descriptor into module. Module will no longer use resources provided by specified descriptor
      Parameters:
      plugin - plugin that is parent of descriptor
      descriptor - feature descriptor to unplug