org.broadleafcommerce.core.extension

Class ExtensionManager<T extends ExtensionHandler>

java.lang.Object

org.broadleafcommerce.core.extension.ExtensionManager<T>

Type Parameters:

T -

All Implemented Interfaces:

java.lang.reflect.InvocationHandler

Direct Known Subclasses:

OfferServiceExtensionManager, OrderDaoExtensionManager, OrderServiceExtensionManager, SolrSearchServiceExtensionManager

public abstract class ExtensionManager<T extends ExtensionHandler>
extends java.lang.Object
implements java.lang.reflect.InvocationHandler

The ExtensionManager pattern is intended for out of box components to be extended by Broadleaf modules. Each component that needs an extension should define an interface which is a descendant of ExtensionHandler. The concrete ExtensionManager class will utilize that interface as a parameter (e.g. T below). The default extension manager pattern loops through all handlers and examines their ExtensionResultStatusType to determine whether or not to continue with other handlers.

Author:

bpolster

Constructor Summary

Constructors

Constructor and Description
ExtensionManager(java.lang.Class<T> _clazz) Should take in a className that matches the ExtensionHandler interface being managed.

Method Summary

Modifier and Type	Method and Description
boolean	continueOnHandled() Returns whether or not this extension manager continues on ExtensionResultStatusType.HANDLED.
java.util.List<T>	getHandlers()
int	getPriority() ExtensionManagers don't really need a priority but they pick up this property due to the fact that we want them to implement the same interface as the handlers they are managing.
T	getProxy()
java.lang.Object	invoke(java.lang.Object proxy, java.lang.reflect.Method method, java.lang.Object[] args)
void	setHandlers(java.util.List<T> handlers)
boolean	shouldContinue(ExtensionResultStatusType result, ExtensionHandler handler, java.lang.reflect.Method method, java.lang.Object[] args) Utility method that is useful for determining whether or not an ExtensionManager implementation should continue after processing a ExtensionHandler call.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExtensionManager

public ExtensionManager(java.lang.Class<T> _clazz)

Should take in a className that matches the ExtensionHandler interface being managed.

Parameters:

className -

Method Detail

getProxy

public T getProxy()

getHandlers

public java.util.List<T> getHandlers()

setHandlers

public void setHandlers(java.util.List<T> handlers)

shouldContinue

public boolean shouldContinue(ExtensionResultStatusType result,
                              ExtensionHandler handler,
                              java.lang.reflect.Method method,
                              java.lang.Object[] args)

Utility method that is useful for determining whether or not an ExtensionManager implementation should continue after processing a ExtensionHandler call. By default, returns true for CONTINUE

Returns:

continueOnHandled

public boolean continueOnHandled()

Returns whether or not this extension manager continues on ExtensionResultStatusType.HANDLED.

Returns:

getPriority

public int getPriority()

ExtensionManagers don't really need a priority but they pick up this property due to the fact that we want them to implement the same interface as the handlers they are managing.

Returns:

invoke

public java.lang.Object invoke(java.lang.Object proxy,
                               java.lang.reflect.Method method,
                               java.lang.Object[] args)
                        throws java.lang.Throwable

Specified by:

invoke in interface java.lang.reflect.InvocationHandler

Throws:

java.lang.Throwable