org.broadleafcommerce.common.sandbox

Class DefaultSandBoxHelper

java.lang.Object

org.broadleafcommerce.common.sandbox.DefaultSandBoxHelper

All Implemented Interfaces:

SandBoxHelper

@Component(value="blSandBoxHelper")
public class DefaultSandBoxHelper
extends Object
implements SandBoxHelper

Author:

Jeff Fischer

See Also:

SandBoxHelper

Nested Class Summary

Nested classes/interfaces inherited from interface org.broadleafcommerce.common.sandbox.SandBoxHelper

SandBoxHelper.OriginalIdResponse, SandBoxHelper.QueryHints

Constructor Summary

Constructors

Constructor and Description
DefaultSandBoxHelper()

Method Summary

Methods

Modifier and Type	Method and Description
void	archiveObject(Object start, javax.persistence.EntityManager em) Archive an object so that it is no longer recognized by the sandbox support
SandBoxHelper.OriginalIdResponse	getOriginalId(javax.persistence.EntityManager em, Class<?> type, Long id) Return the original id for the requested id.
String[]	getSandBoxDiscriminatorFieldList() Retrieve the field names related to sandbox support
com.google.common.collect.BiMap<Long,Long>	getSandBoxToOriginalMap(javax.persistence.EntityManager em, Class<?> type, Long... originalIds) Retrieve a map keyed by sandbox id, with the value being the matching original item id for that sandbox item.
Long	getSandBoxVersionId(javax.persistence.EntityManager entityManager, Class<?> linkedObjectType, Long requestedParent) Return the sandbox version id for the requested original id.
Long	getSandBoxVersionId(javax.persistence.EntityManager entityManager, Class<?> linkedObjectType, Long requestedParent, Boolean includeSandBoxInheritance) Return the sandbox version id for the requested original id.
boolean	isPromote() Is the current thread involved in a promote operation?
boolean	isReject() Is the current thread involved in a reject operation?
boolean	isSandBoxable(String className) Whether or not the class is sandboxable
List<Long>	mergeCloneIds(javax.persistence.EntityManager em, Class<?> type, Long... originalIds) Retrieve a list of values that includes the the original ids passed in and any sandbox versions of those ids, if available.
void	optionallyIncludeDeletedItemsInQueriesAndCollections(Runnable runnable, boolean includeDeleted) For the passed in code block (Runnable), whether or not sandbox entities marked as deleted should be included in any results from queries or lazy collection retrievals.
void	setupSandBoxState(Object clone, javax.persistence.EntityManager em) Setup basic required fields for sandbox support

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSandBoxHelper

public DefaultSandBoxHelper()

Method Detail

getSandBoxVersionId

public Long getSandBoxVersionId(javax.persistence.EntityManager entityManager,
                       Class<?> linkedObjectType,
                       Long requestedParent)

Description copied from interface: SandBoxHelper

Return the sandbox version id for the requested original id. Will return null if no sandbox version is available.

Specified by:

getSandBoxVersionId in interface SandBoxHelper

Parameters:

entityManager - the Entity Manager

linkedObjectType - the type of the entity in question

requestedParent - the id to check

Returns:

the sandbox version, or null

getSandBoxVersionId

public Long getSandBoxVersionId(javax.persistence.EntityManager entityManager,
                       Class<?> linkedObjectType,
                       Long requestedParent,
                       Boolean includeSandBoxInheritance)

Description copied from interface: SandBoxHelper

Return the sandbox version id for the requested original id. Will return null if no sandbox version is available.

Specified by:

getSandBoxVersionId in interface SandBoxHelper

Parameters:

entityManager - the Entity Manager

linkedObjectType - the type of the entity in question

requestedParent - the id to check

includeSandBoxInheritance - override whether or not parent sandbox ids should be included in the query. Can be null - True by default.

Returns:

the sandbox version, or null

mergeCloneIds

public List<Long> mergeCloneIds(javax.persistence.EntityManager em,
                       Class<?> type,
                       Long... originalIds)

Description copied from interface: SandBoxHelper

Retrieve a list of values that includes the the original ids passed in and any sandbox versions of those ids, if available. This is useful for some queries that require search values for both the original id and the sandbox id.

Specified by:

mergeCloneIds in interface SandBoxHelper

Parameters:

em - the Entity Manager

type - the type of the entity in question

originalIds - one or more ids values for which sandbox versions should be included

Returns:

the merged id list

getSandBoxToOriginalMap

public com.google.common.collect.BiMap<Long,Long> getSandBoxToOriginalMap(javax.persistence.EntityManager em,
                                                                 Class<?> type,
                                                                 Long... originalIds)

Description copied from interface: SandBoxHelper

Retrieve a map keyed by sandbox id, with the value being the matching original item id for that sandbox item. Only members from the ids list passed in that have a sandbox counterpart are included.

Specified by:

getSandBoxToOriginalMap in interface SandBoxHelper

Parameters:

em - the Entity Manager

type - the type of the entity in question

originalIds - list of ids to check

Returns:

the map of sandbox to original ids

getOriginalId

public SandBoxHelper.OriginalIdResponse getOriginalId(javax.persistence.EntityManager em,
                                             Class<?> type,
                                             Long id)

Description copied from interface: SandBoxHelper

Return the original id for the requested id. Will return the passed in id if the type is not sandboxable. Will return null if the passed in id is not a sandbox record, or if it's a sandbox add.

Specified by:

getOriginalId in interface SandBoxHelper

Parameters:

em - the Entity Manager

type - the type of the entity in question

id - the id to check

Returns:

the original id for the requested sandbox id

setupSandBoxState

public void setupSandBoxState(Object clone,
                     javax.persistence.EntityManager em)

Description copied from interface: SandBoxHelper

Setup basic required fields for sandbox support

Specified by:

setupSandBoxState in interface SandBoxHelper

Parameters:

clone - the entity instance to setup

em - the Entity Manager

archiveObject

public void archiveObject(Object start,
                 javax.persistence.EntityManager em)

Description copied from interface: SandBoxHelper

Archive an object so that it is no longer recognized by the sandbox support

Specified by:

archiveObject in interface SandBoxHelper

Parameters:

start - the object to archive

em - the Entity Manager

getSandBoxDiscriminatorFieldList

public String[] getSandBoxDiscriminatorFieldList()

Description copied from interface: SandBoxHelper

Retrieve the field names related to sandbox support

Specified by:

getSandBoxDiscriminatorFieldList in interface SandBoxHelper

Returns:

the sandbox support fields

isSandBoxable

public boolean isSandBoxable(String className)

Description copied from interface: SandBoxHelper

Whether or not the class is sandboxable

Specified by:

isSandBoxable in interface SandBoxHelper

Parameters:

className - the classname to check

Returns:

whether or not it's sandboxable

isPromote

public boolean isPromote()

Description copied from interface: SandBoxHelper

Is the current thread involved in a promote operation?

Specified by:

isPromote in interface SandBoxHelper

Returns:

whether or not a promote is currently taking place

isReject

public boolean isReject()

Description copied from interface: SandBoxHelper

Is the current thread involved in a reject operation?

Specified by:

isReject in interface SandBoxHelper

Returns:

whether or not a reject is currently taking place

optionallyIncludeDeletedItemsInQueriesAndCollections

public void optionallyIncludeDeletedItemsInQueriesAndCollections(Runnable runnable,
                                                        boolean includeDeleted)

Description copied from interface: SandBoxHelper

For the passed in code block (Runnable), whether or not sandbox entities marked as deleted should be included in any results from queries or lazy collection retrievals.

Specified by:

optionallyIncludeDeletedItemsInQueriesAndCollections in interface SandBoxHelper

Parameters:

runnable - the block of code for which this setting should be in effect

includeDeleted - whether or not to include deleted sandbox items