Package com.broadleafcommerce.data.tracking.core.mapping

Class ContextStateBuilder

java.lang.Object

com.broadleafcommerce.data.tracking.core.mapping.ContextStateBuilder

Direct Known Subclasses:

AlwaysMutableContextStateBuilder

public class ContextStateBuilder
extends Object

Author:

Nathan Moore (nathandmoore)

Field Summary

Fields

Modifier and Type	Field	Description
protected static Comparator<ChangeDetail>	DETAIL_LEVEL_COMPARATOR
protected static Comparator<ChangeDetail>	DETAIL_TIMESTAMP_COMPARATOR
protected static Comparator<FieldChange>	FIELD_LEVEL_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
ContextStateBuilder(com.broadleafcommerce.common.extension.TypeFactory factory, TrackableBehaviorUtil behaviorUtil, com.fasterxml.jackson.databind.ObjectMapper fieldChangeMapper, org.modelmapper.ModelMapper cloneMapper)

Method Summary

Modifier and Type	Method	Description
protected String	buildBusinessCollectionAccessorName(String fieldName, Object businessItem, String itemId)	Builds the name of the accessor of one of the businessItem's embedded collections to invoke in order to obtain the value of that field when setting ContextState on embedded collections of ContextStateAware entities.
ContextState	buildContextState(Trackable domain, ContextInfo contextInfo)	Builds ContextState information for a ContextStateAware business instance corresponding to the given Trackable domain instance that can be inspected for additional metadata around the entity in relation to the context of the requester.
protected List<FieldChange>	buildContextStateFieldChanges(Trackable domain)	Builds a list of FieldChanges for the ContextState of a ContextStateAware business instance corresponding to a given Trackable domain instance.
protected <T> List<T>	deserializeCollectionValue(String collectionName, Class<?> collectionType, com.fasterxml.jackson.databind.JavaType javaType, Class<?> parentType, String parentId, String serializedValue)	Deserializes either the afterValue or beforeValue of a ChangeDetail for an embedded collection field, depending on which is passed as the serializedValue param, when setting ContextState on embedded collections of ContextStateAware entities.
protected boolean	determineApplicationContextStateMutability(Trackable domain, ContextInfo contextInfo)	Determines whether the domain is mutable given the requesting context based on the application and tenancy state of the domain and context.
protected Boolean	determineArchived(Trackable domain)	Determines the ContextState.getArchived().
protected Integer	determineContextStateLevel(Trackable domain)	Determines the ContextState.getLevel().
protected boolean	determineContextStateMutability(Trackable domain, ContextInfo contextInfo)	Determines whether the domain is mutable given the requesting context.
protected com.fasterxml.jackson.databind.JavaType	determinePersistentCollectionJavaType(ChangeDetail detail, Class<?> collectionType, Class<?> memberType, Class<?> parentType, String parentId)	Determines the JavaType of collections on persistent domains that correspond to ContextStateAware entities when deserializing the before and after values of a ChangeDetail when setting ContextState on embedded collections of ContextStateAware entities.
protected boolean	determinePolicyContextStateMutability(Trackable domain, ContextInfo contextInfo)	Determines whether the domain is mutable given the requesting context based on permissions and policy validation.
protected String	determineSandboxChangeType(Trackable domain)	Returns the tracking's object's sandbox change type.
protected TrackableBehaviorUtil	getBehaviorUtil()
protected org.modelmapper.ModelMapper	getCloneMapper()
protected Field	getCollectionField(String fieldName, Class<?> parentType)
protected com.broadleafcommerce.common.extension.TypeFactory	getFactory()
protected com.fasterxml.jackson.databind.ObjectMapper	getFieldChangeMapper()
protected <T> List<T>	getOtherBusinessCollectionValue(String fieldName, Class<T> collectionMemberType, Object businessItem, String itemId)	Extension point for getting the values of an embedded collection not supported by default on a business item implementing ContextStateAware where the collection's members also implement ContextStateAware when setting ContextState on embedded collections of ContextStateAware entities.
protected Optional<Class<?>>	getOtherCollectionMemberType(String fieldName, Class<?> parentType, String parentId)	Extension point for determining the member type of a collection not supported by default when setting EmbeddedContextState on embedded collection member items of ContextStateAware entities.
protected PolicyUtils	getPolicyUtils()
protected boolean	isLatestChangeToFieldAtAnyLevel(ChangeDetail detail, Collection<? extends ChangeDetail> otherDetails)	Checks that the given ChangeDetail any of: The only change for a field The highest ChangeDetail.getLevel() of any change for a field The newest change for that field (comparing ChangeDetail.getTimestamp() All obsolete changes are automatically excluded (see ChangeDetail.getObsolete()).
protected boolean	isNotObsoleteChange(ChangeDetail detail)
protected boolean	isNotProductionChange(ChangeDetail detail)
protected boolean	isRebasedChange(ChangeDetail detail)
protected void	setApplicationInfo(Trackable domain, ContextState contextState, TrackableBehaviorPackage behavior)
protected void	setCatalogInfo(Trackable domain, ContextState contextState, TrackableBehaviorPackage behavior)
void	setChangeStateForEmbeddedCollections(Trackable domain, ContextStateAware businessItem, org.modelmapper.ModelMapper fromMeMapper)	Sets the EmbeddedContextState on a businessItem's embedded collections where the member items are EmbeddedContextStateAware.
protected void	setCollectionItemContextState(EmbeddedContextStateAware item, List<String> fieldsChanged)	Builds and sets a ContextState onto the given EmbeddedContextStateAware collection item.
protected void	setContextStateTrackingInfo(Trackable domain, ContextState contextState)	Adds additional info to a ContextState being built for a ContextStateAware business instance corresponding to a given Trackable domain instance.
protected void	setCustomerContext(Trackable domain, ContextState contextState, TrackableBehaviorPackage behavior)
void	setPolicyUtils(PolicyUtils policyUtils)
protected void	setTenant(Trackable domain, ContextState contextState, TrackableBehaviorPackage behavior)

Methods inherited from class java.lang.Object

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

Field Detail

DETAIL_LEVEL_COMPARATOR

protected static final Comparator<ChangeDetail> DETAIL_LEVEL_COMPARATOR

FIELD_LEVEL_COMPARATOR

protected static final Comparator<FieldChange> FIELD_LEVEL_COMPARATOR

DETAIL_TIMESTAMP_COMPARATOR

protected static final Comparator<ChangeDetail> DETAIL_TIMESTAMP_COMPARATOR

Constructor Detail

ContextStateBuilder

public ContextStateBuilder(com.broadleafcommerce.common.extension.TypeFactory factory,
                           TrackableBehaviorUtil behaviorUtil,
                           com.fasterxml.jackson.databind.ObjectMapper fieldChangeMapper,
                           org.modelmapper.ModelMapper cloneMapper)

Method Detail

setPolicyUtils

@Autowired(required=false)
public void setPolicyUtils(@Nullable
                           PolicyUtils policyUtils)

buildContextState

@NonNull
public ContextState buildContextState(@NonNull
                                      Trackable domain,
                                      @Nullable
                                      ContextInfo contextInfo)

Builds ContextState information for a ContextStateAware business instance corresponding to the given Trackable domain instance that can be inspected for additional metadata around the entity in relation to the context of the requester. This information can be used to make determination around mutability, as well as details around the nature of field change state (if any).

Parameters:

domain - A repository domain instance to use as the basis for the ContextState being built.

contextInfo - The context information used to determine sandbox and multitenant state in tracking

Returns:

The ContextState information for a ContextStateAware business instance corresponding to the given Trackable domain instance.

determineSandboxChangeType

@Nullable
protected String determineSandboxChangeType(Trackable domain)

Returns the tracking's object's sandbox change type.

Parameters:

domain - The Trackable instance to retrieve the sandbox change type from.

Returns:

The sandbox change type, or null if there is no sandbox change type.

See Also:

SandboxInfo.getChangeType(), Tracking.getSandbox()

setChangeStateForEmbeddedCollections

public void setChangeStateForEmbeddedCollections(@NonNull
                                                 Trackable domain,
                                                 @NonNull
                                                 ContextStateAware businessItem,
                                                 @Nullable
                                                 org.modelmapper.ModelMapper fromMeMapper)

Sets the EmbeddedContextState on a businessItem's embedded collections where the member items are EmbeddedContextStateAware.

By default, checks for ChangeDetails related to embedded collections on the businessItem. Then, deserializes and compares ChangeDetail.getBeforeValue() and ChangeDetail.getAfterValue() to determine which member items within the collections have changed. Then, updates their ContextState, assuming those items are EmbeddedContextStateAware. Filters out all changes that are obsolete or older than another change for the same field in the same or higher tracking level (e.g., if 2 changes are found to a 'name' field and both are in the USER level, the older one is filtered out).

Parameters:

domain - The Trackable instance representing the persistent entity from which to glean ChangeDetails

businessItem - The business item corresponding to the domain whose embedded collections should have their ContextStates set.

fromMeMapper - if domain is ModelMapperMappable, this should contain the result of ModelMapperMappable.fromMe(). This mapper is used to convert the embedded items from persisted instances to business instances. If domain is not ModelMapperMappable, then this should be left null.

Throws:

IllegalContextStateException - Thrown when a problem in the context state is found. This is normally because of one of the following scenarios:

• a collection is found on the businessItem but the corresponding field on the domain is not a collection.
• the accessor for a collection field on the businessItem cannot be invoked because of access security or the name of the accessor is unknown.

ContextStateProcessingException - Thrown when an error occurs when attempting to set the ContextState on the members of a businessItem's embedded collection. Some examples:

• when invoking (not finding) the correct accessor of a collection field on the businessItem encounters an error.
• when a ChangeDetail's before or after values cannot be deserialized once a change for a collection has been detected.

determineContextStateMutability

protected boolean determineContextStateMutability(Trackable domain,
                                                  @Nullable
                                                  ContextInfo contextInfo)

Determines whether the domain is mutable given the requesting context. Generally, factors such as permissions, application tenancy, and catalog mutability are considered.

Parameters:

domain - The Trackable domain instance under consideration for mutability

contextInfo - The context information used to determine sandbox and multitenant state in tracking

Returns:

whether the given domain instance is mutable in the current request context.

determineApplicationContextStateMutability

protected boolean determineApplicationContextStateMutability(Trackable domain,
                                                             @Nullable
                                                             ContextInfo contextInfo)

Determines whether the domain is mutable given the requesting context based on the application and tenancy state of the domain and context.

If the domain doesn't belong to the requesting context's application, then it should not be mutable.

Parameters:

domain - The Trackable domain instance under consideration for mutability

contextInfo - The context information used to determine sandbox and multitenant state in tracking

Returns:

whether the given domain instance is mutable in the current request context according to application tenancy

determinePolicyContextStateMutability

protected boolean determinePolicyContextStateMutability(Trackable domain,
                                                        @Nullable
                                                        ContextInfo contextInfo)

Determines whether the domain is mutable given the requesting context based on permissions and policy validation.

Parameters:

domain - The Trackable domain instance under consideration for mutability

contextInfo - The context information used to determine sandbox and multitenant state in tracking

Returns:

whether the given domain instance is mutable in the current request context according to permissions and policies

determineContextStateLevel

protected Integer determineContextStateLevel(Trackable domain)

Determines the ContextState.getLevel(). This is generally the same as the given Trackable domain instance's tracking level.

Parameters:

domain - A domain instance being used as the basis for building a ContextState.

Returns:

The TrackingLevel to set on the ContextState.

determineArchived

protected Boolean determineArchived(Trackable domain)

Determines the ContextState.getArchived(). This is generally the same as the given Trackable domain instance's tracking archived.

Parameters:

domain - A domain instance being used as the basis for building a ContextState.

Returns:

The archived status to set on the ContextState.

buildContextStateFieldChanges

protected List<FieldChange> buildContextStateFieldChanges(Trackable domain)

Builds a list of FieldChanges for the ContextState of a ContextStateAware business instance corresponding to a given Trackable domain instance.

Parameters:

domain - The Trackable domain instance being used as a basis for building a ContextState.

Returns:

A list of FieldChanges to set on a ContextState.

isRebasedChange

protected final boolean isRebasedChange(ChangeDetail detail)

isNotObsoleteChange

protected final boolean isNotObsoleteChange(ChangeDetail detail)

isNotProductionChange

protected final boolean isNotProductionChange(ChangeDetail detail)

setContextStateTrackingInfo

protected void setContextStateTrackingInfo(Trackable domain,
                                           ContextState contextState)

Adds additional info to a ContextState being built for a ContextStateAware business instance corresponding to a given Trackable domain instance. Such info usually includes SandboxInfo, CatalogInfo, and ApplicationInfo as applicable to the given trackable.

Parameters:

domain - A Trackable domain instance being used as the basis for building a ContextState.

contextState - A ContextState being built for a ContextStateAware business instance corresponding to the given trackable domain.

setTenant

protected void setTenant(Trackable domain,
                         ContextState contextState,
                         TrackableBehaviorPackage behavior)

setCustomerContext

protected void setCustomerContext(Trackable domain,
                                  ContextState contextState,
                                  TrackableBehaviorPackage behavior)

setApplicationInfo

protected void setApplicationInfo(Trackable domain,
                                  ContextState contextState,
                                  TrackableBehaviorPackage behavior)

setCatalogInfo

protected void setCatalogInfo(Trackable domain,
                              ContextState contextState,
                              TrackableBehaviorPackage behavior)

isLatestChangeToFieldAtAnyLevel

protected final boolean isLatestChangeToFieldAtAnyLevel(ChangeDetail detail,
                                                        Collection<? extends ChangeDetail> otherDetails)

Checks that the given ChangeDetail any of:

• The only change for a field
• The highest ChangeDetail.getLevel() of any change for a field
• The newest change for that field (comparing ChangeDetail.getTimestamp()

All obsolete changes are automatically excluded (see ChangeDetail.getObsolete()).

getCollectionField

protected Field getCollectionField(String fieldName,
                                   Class<?> parentType)

getOtherCollectionMemberType

protected Optional<Class<?>> getOtherCollectionMemberType(String fieldName,
                                                          Class<?> parentType,
                                                          String parentId)

Extension point for determining the member type of a collection not supported by default when setting EmbeddedContextState on embedded collection member items of ContextStateAware entities. Default supported collections are Iterable, Map, and arrays. The following should also be extended: deserializeCollectionValue(String, Class, JavaType, Class, String, String), getOtherBusinessCollectionValue(String, Class, Object, String), and determinePersistentCollectionJavaType(ChangeDetail, Class, Class, Class, String)

Parameters:

fieldName - Name of the field on an entity (business or persistent) that may be a collection for whose member items we need the type

parentType - The Class of the parent entity

parentId - Id of the parent entity

Returns:

the Class of the member items inside of an embedded collection or Optional.empty() if not a collection.

getOtherBusinessCollectionValue

protected <T> List<T> getOtherBusinessCollectionValue(String fieldName,
                                                      Class<T> collectionMemberType,
                                                      Object businessItem,
                                                      String itemId)

Extension point for getting the values of an embedded collection not supported by default on a business item implementing ContextStateAware where the collection's members also implement ContextStateAware when setting ContextState on embedded collections of ContextStateAware entities. Default supported collections are Iterable, Map, and arrays. For more, extend this method, deserializeCollectionValue(String, Class, JavaType, Class, String, String), getOtherCollectionMemberType(String, Class, String), and determinePersistentCollectionJavaType(ChangeDetail, Class, Class, Class, String)

Parameters:

fieldName - Name of the field on an business entity that is an unsupported type of collection

collectionMemberType - The Class of the collection's member item

businessItem - The business item that owns the embedded collection

itemId - The id of the business item that owns the embedded collection

Returns:

The values of an embedded collection on a business item that implements ContextStateAware where the collection's members also implement ContextStateAware and require their ContextStates to be set.

buildBusinessCollectionAccessorName

protected String buildBusinessCollectionAccessorName(String fieldName,
                                                     Object businessItem,
                                                     String itemId)

Builds the name of the accessor of one of the businessItem's embedded collections to invoke in order to obtain the value of that field when setting ContextState on embedded collections of ContextStateAware entities.

Parameters:

fieldName - Name of the embedded collection on the businessItem

businessItem - Business instance of a persistent entity that is having its embedded collections' ContextStates set.

itemId - ID of the businessItem

Returns:

name of the accessor of one of the businessItem's embedded collections

determinePersistentCollectionJavaType

protected com.fasterxml.jackson.databind.JavaType determinePersistentCollectionJavaType(ChangeDetail detail,
                                                                                        Class<?> collectionType,
                                                                                        Class<?> memberType,
                                                                                        Class<?> parentType,
                                                                                        String parentId)

Determines the JavaType of collections on persistent domains that correspond to ContextStateAware entities when deserializing the before and after values of a ChangeDetail when setting ContextState on embedded collections of ContextStateAware entities.

The JavaType returned is used to inform an ObjectMapper of how to read the serialized before or after value from the ChangeDetail: see ObjectMapper.readValue(String, JavaType).

Default supported collections are Iterable, Map, and arrays. If other types should be supported, extend this method, deserializeCollectionValue(String, Class, JavaType, Class, String, String), getOtherCollectionMemberType(String, Class, String), and getOtherBusinessCollectionValue(String, Class, Object, String)

Parameters:

detail - the ChangeDetail with info on the changes to an embedded collection that should be used to set the ContextState on a member of the corresponding business domain's collection.

collectionType - the Class of the persistent embedded collection to which the ChangeDetail belongs.

memberType - the Class of the member items within the embedded collection

parentType - The Class of the persistent entity that owns the embedded collection

parentId - The id of the persistent entity that owns the embedded collection

Returns:

The JavaType of the persistent collection required for deserialization.

deserializeCollectionValue

protected <T> List<T> deserializeCollectionValue(String collectionName,
                                                 Class<?> collectionType,
                                                 com.fasterxml.jackson.databind.JavaType javaType,
                                                 Class<?> parentType,
                                                 String parentId,
                                                 String serializedValue)

Deserializes either the afterValue or beforeValue of a ChangeDetail for an embedded collection field, depending on which is passed as the serializedValue param, when setting ContextState on embedded collections of ContextStateAware entities. If a collection type other than array, Map, or Iterable should be supported, extend this method, determinePersistentCollectionJavaType(ChangeDetail, Class, Class, Class, String), getOtherCollectionMemberType(String, Class, String), and getOtherBusinessCollectionValue(String, Class, Object, String)

Parameters:

collectionName - The name of the collection field to which values belong

collectionType - The Class of the collection

javaType - The JavaType to pass to the ObjectMapper into which to deserialize the serializedValue

parentType - The Class of the entity that owns the collection

parentId - The id of the entity that owns the collection

serializedValue - The before or after value from a ChangeDetail to deserialize

Returns:

A List representing the deserialized collection

Throws:

ContextStateProcessingException - Thrown if deserialization fails for any reason.

setCollectionItemContextState

protected void setCollectionItemContextState(EmbeddedContextStateAware item,
                                             List<String> fieldsChanged)

Builds and sets a ContextState onto the given EmbeddedContextStateAware collection item.

Parameters:

item - The EmbeddedContextStateAware collection item.

fieldsChanged - List of the names of the fields on the changed item that were actually changed

getFactory

@NonNull
protected com.broadleafcommerce.common.extension.TypeFactory getFactory()

getBehaviorUtil

@NonNull
protected TrackableBehaviorUtil getBehaviorUtil()

getFieldChangeMapper

@NonNull
protected com.fasterxml.jackson.databind.ObjectMapper getFieldChangeMapper()

getCloneMapper

@NonNull
protected org.modelmapper.ModelMapper getCloneMapper()

getPolicyUtils

@Nullable
protected PolicyUtils getPolicyUtils()