org.broadleafcommerce.common.module

Interface BroadleafModuleRegistration

public interface BroadleafModuleRegistration

This is a non-functional 5.0 and 5.1-compatible version of this interface that only has functionality in Broadleaf 5.2. This was added into the 5.0 and 5.1 streams in order to allow 3rd-party integration modules to be compatible with Broadleaf 5.0, 5.1 and 5.2 all at the same time.

Provides the ability for modules to register themselves with Broadleaf to be used with org.broadleafcommerce.common.condition.ConditionalOnBroadleafModule and ModulePresentUtil in order to provide different behavior in inter-module dependencies.

Module implementations should be registered in a spring.factories file like so:

 org.broadleafcommerce.common.condition.BroadleafModuleRegistration=com.broadleafcommerce.mymodule.registration.MyModuleRegistration
 

In order to preserve compile-time checking, additional modules should be added to the BroadleafModuleRegistration.BroadleafModuleEnum. However, if they aren't, this can always be checked at runtime instead by just looking for the String-based module name.

Since:

5.0.12-GA, 5.1.5-GA, 5.2.0-GA

Author:

Phillip Verheyden (phillipuniverse)

See Also:

org.broadleafcommerce.common.condition.OnBroadleafModuleCondition}, org.broadleafcommerce.common.condition.ConditionalOnBroadleafModule}, ModuleLifecycleLoggingBean}, SpringFactoriesLoader}

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BroadleafModuleRegistration.BroadleafModuleEnum List of modules that are known to have declared a BroadleafModuleRegistration in their spring.factories.

Method Summary

Modifier and Type	Method and Description
String	getModuleName() The module name that is being registered.

Method Detail

getModuleName

String getModuleName()

The module name that is being registered. This should generally be the same as the logging information from a ModuleLifecycleLoggingBean.