Package com.broadleafcommerce.metadata.core.service.messaging.characteristic

Class MetadataCharacteristicModifiedHandler

java.lang.Object

com.broadleafcommerce.metadata.core.service.messaging.characteristic.MetadataCharacteristicModifiedHandler

@DataRouteByKey("metadata")
public class MetadataCharacteristicModifiedHandler
extends Object

Handles the CharacteristicModifiedEvent messages to create, update, or delete metadata augmentations based on the modified Characteristic.

Since:

2.4.x

Author:

Sunny Yu

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTAINER_KEY

Constructor Summary

Constructors

Constructor	Description
MetadataCharacteristicModifiedHandler(com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService idempotentConsumptionService, com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.broadleafcommerce.common.extension.TypeFactory typeFactory, AugmentationService<Augmentation> augmentationService)

Method Summary

Modifier and Type	Method	Description
protected boolean	augmentationIsSupported(@NonNull Characteristic characteristic)	Whether the Characteristic.getValueType() is supported for automatic Augmentation creation.
protected void	createNewAugmentationIfSupported(@NonNull CharacteristicModifiedEvent event)	Handles the creation of the Characteristic, if the Characteristic.getValueType() is supported.
AugmentationService<Augmentation>	getAugmentationService()
protected com.broadleafcommerce.data.tracking.core.context.ContextInfo	getContextInfo(@NonNull CharacteristicModifiedEvent payload, @NonNull com.broadleafcommerce.data.tracking.core.type.OperationType operationType)
protected com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService	getIdempotentConsumptionService()
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected void	handleDelete(@NonNull CharacteristicModifiedEvent event, @NonNull Optional<Augmentation> maybeAugmentation)	Handles the deletion of the Characteristic.
protected void	handleUpdate(@NonNull CharacteristicModifiedEvent event, @NonNull Optional<Augmentation> maybeAugmentation)	Handles the update of the Characteristic.
void	listen(org.springframework.messaging.Message<CharacteristicModifiedEvent> message)
protected void	populateJsonPayload(@NonNull Augmentation augmentation, @NonNull Characteristic characteristic)	Populates the Augmentation.getJsonPayload() based on the given Characteristic.
protected void	processMessage(@NonNull org.springframework.messaging.Message<CharacteristicModifiedEvent> message)
protected String	translateCustomValueType(@NonNull String customValueType)	Translates the custom Characteristic.getValueType() to FieldTypes.
protected String	translateValueType(@NonNull String valueType)	Translates the Characteristic.getValueType() to FieldTypes.
protected void	updateExistingAugmentation(@NonNull CharacteristicModifiedEvent event, @NonNull Augmentation augmentation)	Updates the existing Augmentation based on the updated Characteristic if applicable.

Methods inherited from class java.lang.Object

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

Field Details

CONTAINER_KEY

public static final String CONTAINER_KEY

See Also:

• Constant Field Values

Constructor Details

MetadataCharacteristicModifiedHandler

public MetadataCharacteristicModifiedHandler(com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService idempotentConsumptionService,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 AugmentationService<Augmentation> augmentationService)

Method Details

listen

@StreamListener("characteristicModifiedInputMetadata")
public void listen(org.springframework.messaging.Message<CharacteristicModifiedEvent> message)

processMessage

protected void processMessage(@NonNull
 @NonNull org.springframework.messaging.Message<CharacteristicModifiedEvent> message)

handleDelete

protected void handleDelete(@NonNull
 @NonNull CharacteristicModifiedEvent event,
 @NonNull
 @NonNull Optional<Augmentation> maybeAugmentation)

Handles the deletion of the Characteristic.

Parameters:

event - the CharacteristicModifiedEvent containing the event details

maybeAugmentation - an Optional of existing Augmentation

handleUpdate

protected void handleUpdate(@NonNull
 @NonNull CharacteristicModifiedEvent event,
 @NonNull
 @NonNull Optional<Augmentation> maybeAugmentation)

Handles the update of the Characteristic.

Parameters:

event - the CharacteristicModifiedEvent containing the event details

maybeAugmentation - an Optional of existing Augmentation

updateExistingAugmentation

protected void updateExistingAugmentation(@NonNull
 @NonNull CharacteristicModifiedEvent event,
 @NonNull
 @NonNull Augmentation augmentation)

Updates the existing Augmentation based on the updated Characteristic if applicable.

Parameters:

event - the CharacteristicModifiedEvent containing the event details

augmentation - the existing Augmentation to update

createNewAugmentationIfSupported

protected void createNewAugmentationIfSupported(@NonNull
 @NonNull CharacteristicModifiedEvent event)

Handles the creation of the Characteristic, if the Characteristic.getValueType() is supported.

Parameters:

event - the CharacteristicModifiedEvent containing the event details

augmentationIsSupported

protected boolean augmentationIsSupported(@NonNull
 @NonNull Characteristic characteristic)

Whether the Characteristic.getValueType() is supported for automatic Augmentation creation.

Parameters:

characteristic - the Characteristic to evaluate

translateValueType

protected String translateValueType(@NonNull
 @NonNull String valueType)

Translates the Characteristic.getValueType() to FieldTypes.

Parameters:

valueType - the Characteristic.getValueType() to translate

Returns:

the String of FieldTypes

translateCustomValueType

protected String translateCustomValueType(@NonNull
 @NonNull String customValueType)

Translates the custom Characteristic.getValueType() to FieldTypes.

Parameters:

customValueType - the Characteristic.getValueType() to translate

Returns:

the String of FieldTypes

Throws:

UnsupportedOperationException - if the value type is not recognized and this method is not overridden

populateJsonPayload

protected void populateJsonPayload(@NonNull
 @NonNull Augmentation augmentation,
 @NonNull
 @NonNull Characteristic characteristic)

Populates the Augmentation.getJsonPayload() based on the given Characteristic. .

Parameters:

augmentation - the Augmentation to populate

characteristic - the Characteristic to populate with

getContextInfo

@Nullable
protected com.broadleafcommerce.data.tracking.core.context.ContextInfo getContextInfo(@NonNull
 @NonNull CharacteristicModifiedEvent payload,
 @NonNull
 @NonNull com.broadleafcommerce.data.tracking.core.type.OperationType operationType)

getIdempotentConsumptionService

protected com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService getIdempotentConsumptionService()

getObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

getTypeFactory

public com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()

getAugmentationService

public AugmentationService<Augmentation> getAugmentationService()