com.commercetools.sync.commons.helpers

Class BaseReferenceResolver<T,S extends BaseSyncOptions>

java.lang.Object

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

Type Parameters:

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:

CustomReferenceResolver, ProductReferenceResolver, VariantReferenceResolver

public abstract class BaseReferenceResolver<T,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.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BLANK_ID_VALUE_ON_RESOURCE_IDENTIFIER
protected S	options

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseReferenceResolver(S options)

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	getKeyFromResourceIdentifier(io.sphere.sdk.models.ResourceIdentifier resourceIdentifier, boolean allowUuidKeys) This method fetches the id value on the passed ResourceIdentifier, if valid.
abstract java.util.concurrent.CompletionStage<T>	resolveReferences(T draft) Given a draft this method attempts to resolve the all the references on the draft to return a CompletionStage which contains a new instance of the draft with the resolved references.

Methods inherited from class java.lang.Object

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

Field Detail

BLANK_ID_VALUE_ON_RESOURCE_IDENTIFIER

public static final java.lang.String BLANK_ID_VALUE_ON_RESOURCE_IDENTIFIER

See Also:

Constant Field Values

options

protected S extends BaseSyncOptions options

Constructor Detail

BaseReferenceResolver

protected BaseReferenceResolver(@Nonnull
                                S options)

Method Detail

resolveReferences

public abstract java.util.concurrent.CompletionStage<T> resolveReferences(@Nonnull
                                                                          T draft)

Given a draft this method attempts to resolve the all the references on the draft to return a CompletionStage which contains a new instance of the draft with the resolved references. The keys of the references are either taken from the expanded references or taken from the id field of the references.

Parameters:

draft - the productDraft to resolve it's references.

Returns:

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

getKeyFromResourceIdentifier

@Nonnull
protected static java.lang.String getKeyFromResourceIdentifier(@Nonnull
                                                                        io.sphere.sdk.models.ResourceIdentifier resourceIdentifier,
                                                                        boolean allowUuidKeys)
                                                                 throws ReferenceResolutionException

This method fetches the id value on the passed ResourceIdentifier, if valid. If it is not valid, a ReferenceResolutionException will be thrown. The validity checks are:

1. Checks if the id value has a UUID format and the allowUuidKeys flag set to true, or the id value doesn't have a UUID format.
2. Checks if the id value is not null or not empty.

If the above checks pass, the id value is returned. Otherwise a ReferenceResolutionException is thrown.

Note: Currently the key is expected to be set on the id field of the ResourceIdentifier. This is in order to make key setting consistent on both Reference and ResourceIdentifier. However, this will be changed when GITHUB ISSUE#138 is resolved.

Parameters:

resourceIdentifier - the reference from which the id value is validated and returned.

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

Returns:

the id value on the ResourceIdentifier

Throws:

ReferenceResolutionException - if any of the validation checks fail.