com.commercetools.sync.commons.helpers

Class BaseReferenceResolver<T extends io.sphere.sdk.types.CustomDraft,S extends BaseSyncOptions>

java.lang.Object

com.commercetools.sync.commons.helpers.BaseReferenceResolver<T,S>

Type Parameters:

T - the resource draft type for which reference resolution has to be done on.

S - a subclass implementation of BaseSyncOptions that is used to allow/deny some specific options, specified by the user, on reference resolution.

Direct Known Subclasses:

CategoryReferenceResolver, InventoryReferenceResolver

public abstract class BaseReferenceResolver<T extends io.sphere.sdk.types.CustomDraft,S extends BaseSyncOptions>
extends java.lang.Object

This class is responsible for providing an abstract implementation of reference resolution on different CTP resources. For concrete reference resolution implementation of the CTP resources, this class should be extended. It also provides utility methods that facilitate the reference resolution process.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseReferenceResolver(S options, TypeService typeService)

Method Summary

Modifier and Type	Method and Description
protected java.util.concurrent.CompletionStage<java.util.Optional<java.lang.String>>	getCustomTypeId(io.sphere.sdk.types.CustomFieldsDraft custom, java.lang.String referenceResolutionErrorMessage) Given a custom fields object this method fetches the custom type reference id.
protected static java.lang.String	getKeyFromExpansionOrReference(boolean shouldAllowUuidKeys, java.lang.String keyFromExpansion, io.sphere.sdk.models.Reference reference) Given a key value (keyFromExpansion) which is potentially fetched from the expansion of a reference.
protected S	getOptions() Returns the S, which is a subclass of BaseSyncOptions, instance of this instance.
protected static boolean	isReferenceExpanded(io.sphere.sdk.models.Reference reference) Helper method to check if passed Reference instance is expanded.
protected abstract java.util.concurrent.CompletionStage<T>	resolveCustomTypeReference(T draft) Given a draft of T (e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseReferenceResolver

protected BaseReferenceResolver(@Nonnull
                                S options,
                                @Nonnull
                                TypeService typeService)

Method Detail

getOptions

protected S getOptions()

Returns the S, which is a subclass of BaseSyncOptions, instance of this instance.

Returns:

the S, which is a subclass of BaseSyncOptions, instance of this instance.

resolveCustomTypeReference

protected abstract java.util.concurrent.CompletionStage<T> resolveCustomTypeReference(@Nonnull
                                                                                      T draft)

Given a draft of T (e.g. CategoryDraft) this method attempts to resolve it's custom type reference to return CompletionStage which contains a new instance of the draft with the resolved custom type reference. The key of the custom type is taken from the from the id field of the reference.

The method then tries to fetch the key of the custom type, optimistically from a cache. If the key is is not found, the resultant draft would remain exactly the same as the passed draft (without a custom type reference resolution).

Parameters:

draft - the draft to resolve it's references.

Returns:

a CompletionStage that contains as a result a new draft instance with resolved custom type references or, in case an error occurs during reference resolution, a ReferenceResolutionException.

getCustomTypeId

protected java.util.concurrent.CompletionStage<java.util.Optional<java.lang.String>> getCustomTypeId(@Nonnull
                                                                                                     io.sphere.sdk.types.CustomFieldsDraft custom,
                                                                                                     @Nonnull
                                                                                                     java.lang.String referenceResolutionErrorMessage)

Given a custom fields object this method fetches the custom type reference id.

Parameters:

custom - the custom fields object.

referenceResolutionErrorMessage - the message containing the information about the draft to attach to the ReferenceResolutionException in case it occurs.

Returns:

a CompletionStage that contains as a result an optional which either contains the custom type id if it exists or empty if it doesn't.

getKeyFromExpansionOrReference

@Nonnull
protected static java.lang.String getKeyFromExpansionOrReference(boolean shouldAllowUuidKeys,
                                                                          @Nullable
                                                                          java.lang.String keyFromExpansion,
                                                                          @Nonnull
                                                                          io.sphere.sdk.models.Reference reference)
                                                                   throws ReferenceResolutionException

Given a key value (keyFromExpansion) which is potentially fetched from the expansion of a reference. This method checks if this value is not blank (empty string/null), if it is, it tries to fetch the key value from the id field on the reference. If it's not blank it returns it. Whether the value is fetched from the expansion or from the reference's id field, this method makes sure the key is valid:

1. is not blank (empty/null).
2. can only have a UUID format if allowed by the options instance of this class.

If the key is not valid a ReferenceResolutionException will be thrown.

Parameters:

shouldAllowUuidKeys - flag that signals whether the key could be UUID format or not.

keyFromExpansion - the key value fetched after expansion of the reference.

reference - the reference object to get the key from.

Returns:

the key of the referenced object.

Throws:

ReferenceResolutionException - thrown if the key is not valid.

isReferenceExpanded

protected static boolean isReferenceExpanded(@Nonnull
                                             io.sphere.sdk.models.Reference reference)

Helper method to check if passed Reference instance is expanded.

Parameters:

reference - the reference to check.

Returns:

true if the Reference is expanded.