org.broadleafcommerce.common.persistence

Class EntityDuplicatorExtensionManager

java.lang.Object

org.broadleafcommerce.common.extension.ExtensionManager<EntityDuplicatorExtensionHandler>

org.broadleafcommerce.common.persistence.EntityDuplicatorExtensionManager

All Implemented Interfaces:

InvocationHandler, ExtensionHandler, EntityDuplicatorExtensionHandler

@Service(value="blEntityDuplicatorExtensionManager")
public class EntityDuplicatorExtensionManager
extends ExtensionManager<EntityDuplicatorExtensionHandler>
implements EntityDuplicatorExtensionHandler

Manage the interaction between a duplication operation and other modules that wish to contribute to that lifecycle

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionManagerOperation	addToSandbox
static ExtensionManagerOperation	getCatalogsForPropagation
static ExtensionManagerOperation	getClonesByCatalogs
static ExtensionManagerOperation	setupDuplicate
static ExtensionManagerOperation	tearDownDuplicate
static ExtensionManagerOperation	validateDuplicate

Fields inherited from class org.broadleafcommerce.common.extension.ExtensionManager

extensionHandler, handlers, handlersSorted, LOCK_OBJECT

Constructor Summary

Constructors

Constructor and Description
EntityDuplicatorExtensionManager()

Method Summary

Modifier and Type	Method and Description
ExtensionResultStatusType	addToSandbox(Object entity) Add duplication entity to the sandbox
ExtensionResultStatusType	getCatalogsForPropagation(MultiTenantCopyContext context, ExtensionResultHolder<List<MultiTenantCopyContext>> resultHolder)
ExtensionResultStatusType	getClonesByCatalogs(String tableName, Long id, MultiTenantCopyContext multiTenantCopyContext, ExtensionResultHolder<Map<Long,Map<Long,Long>>> resultHolder)
boolean	isEnabled() If false, the ExtensionManager should skip this Handler.
ExtensionResultStatusType	setupDuplicate(Object entity, ExtensionResultHolder<MultiTenantCopyContext> resultHolder) Perform any required context and state setup before commencing with the duplication
ExtensionResultStatusType	tearDownDuplicate() Tear down any expired context and state used during the duplication
ExtensionResultStatusType	validateDuplicate(Object entity, ExtensionResultHolder<Boolean> resultHolder) Confirm whether or not duplication operation is allowed

Methods inherited from class org.broadleafcommerce.common.extension.ExtensionManager

continueOnHandled, execute, getHandlers, getPriority, getProxy, invoke, registerHandler, setHandlers, shouldContinue, sortHandlers

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.broadleafcommerce.common.extension.ExtensionHandler

getPriority

Field Detail

validateDuplicate

public static final ExtensionManagerOperation validateDuplicate

setupDuplicate

public static final ExtensionManagerOperation setupDuplicate

tearDownDuplicate

public static final ExtensionManagerOperation tearDownDuplicate

addToSandbox

public static final ExtensionManagerOperation addToSandbox

getCatalogsForPropagation

public static final ExtensionManagerOperation getCatalogsForPropagation

getClonesByCatalogs

public static final ExtensionManagerOperation getClonesByCatalogs

Constructor Detail

EntityDuplicatorExtensionManager

public EntityDuplicatorExtensionManager()

Method Detail

validateDuplicate

public ExtensionResultStatusType validateDuplicate(Object entity,
                                                   ExtensionResultHolder<Boolean> resultHolder)

Description copied from interface: EntityDuplicatorExtensionHandler

Confirm whether or not duplication operation is allowed

Specified by:

validateDuplicate in interface EntityDuplicatorExtensionHandler

Returns:

setupDuplicate

public ExtensionResultStatusType setupDuplicate(Object entity,
                                                ExtensionResultHolder<MultiTenantCopyContext> resultHolder)

Description copied from interface: EntityDuplicatorExtensionHandler

Perform any required context and state setup before commencing with the duplication

Specified by:

setupDuplicate in interface EntityDuplicatorExtensionHandler

Returns:

addToSandbox

public ExtensionResultStatusType addToSandbox(Object entity)

Description copied from interface: EntityDuplicatorExtensionHandler

Add duplication entity to the sandbox

Specified by:

addToSandbox in interface EntityDuplicatorExtensionHandler

Returns:

tearDownDuplicate

public ExtensionResultStatusType tearDownDuplicate()

Description copied from interface: EntityDuplicatorExtensionHandler

Tear down any expired context and state used during the duplication

Specified by:

tearDownDuplicate in interface EntityDuplicatorExtensionHandler

Returns:

getCatalogsForPropagation

public ExtensionResultStatusType getCatalogsForPropagation(MultiTenantCopyContext context,
                                                           ExtensionResultHolder<List<MultiTenantCopyContext>> resultHolder)

Specified by:

getCatalogsForPropagation in interface EntityDuplicatorExtensionHandler

getClonesByCatalogs

public ExtensionResultStatusType getClonesByCatalogs(String tableName,
                                                     Long id,
                                                     MultiTenantCopyContext multiTenantCopyContext,
                                                     ExtensionResultHolder<Map<Long,Map<Long,Long>>> resultHolder)

Specified by:

getClonesByCatalogs in interface EntityDuplicatorExtensionHandler

isEnabled

public boolean isEnabled()

Description copied from interface: ExtensionHandler

If false, the ExtensionManager should skip this Handler.

Specified by:

isEnabled in interface ExtensionHandler

Returns:

boolean