com.commercetools.sync.commons

Class BaseSyncOptions

java.lang.Object

com.commercetools.sync.commons.BaseSyncOptions

Direct Known Subclasses:

CategorySyncOptions, InventorySyncOptions, ProductSyncOptions

public class BaseSyncOptions
extends java.lang.Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseSyncOptions(io.sphere.sdk.client.SphereClient ctpClient, java.util.function.BiConsumer<java.lang.String,java.lang.Throwable> errorCallBack, java.util.function.Consumer<java.lang.String> warningCallBack, int batchSize, boolean removeOtherLocales, boolean removeOtherSetEntries, boolean removeOtherCollectionEntries, boolean removeOtherProperties, boolean allowUuid)

Method Summary

Modifier and Type	Method and Description
void	applyErrorCallback(java.lang.String errorMessage)
void	applyErrorCallback(java.lang.String errorMessage, java.lang.Throwable exception) Given an errorMessage and an exception, this method calls the errorCallBack function which is set to this instance of the BaseSyncOptions.
void	applyWarningCallback(java.lang.String warningMessage) Given a warningMessage string, this method calls the warningCallBack function which is set to this instance of the BaseSyncOptions.
int	getBatchSize() Gets the batch size used in the sync process.
io.sphere.sdk.client.SphereClient	getCtpClient() Returns the SphereClient responsible for interaction with the target CTP project.
java.util.function.BiConsumer<java.lang.String,java.lang.Throwable>	getErrorCallBack() Returns the errorCallBack BiConsumer<String, Throwable> function set to this BaseSyncOptions.
java.util.function.Consumer<java.lang.String>	getWarningCallBack() Returns the warningCallBack Consumer<String> function set to this BaseSyncOptions.
boolean	shouldAllowUuidKeys() The sync expects the user to pass the keys to references in the id field of References.
boolean	shouldRemoveOtherCollectionEntries() Returns a boolean flag which enables the sync module to add collection (e.g.
boolean	shouldRemoveOtherLocales() Returns a boolean flag which enables the sync module to add additional localizations without deleting existing ones, if set to false.
boolean	shouldRemoveOtherProperties() Returns a boolean flag which enables the sync module to add additional object properties (e.g.
boolean	shouldRemoveOtherSetEntries() Returns a boolean flag which enables the sync module to add additional Set entries without deleting existing ones, if set to false.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseSyncOptions

protected BaseSyncOptions(@Nonnull
                          io.sphere.sdk.client.SphereClient ctpClient,
                          java.util.function.BiConsumer<java.lang.String,java.lang.Throwable> errorCallBack,
                          java.util.function.Consumer<java.lang.String> warningCallBack,
                          int batchSize,
                          boolean removeOtherLocales,
                          boolean removeOtherSetEntries,
                          boolean removeOtherCollectionEntries,
                          boolean removeOtherProperties,
                          boolean allowUuid)

Method Detail

getCtpClient

public io.sphere.sdk.client.SphereClient getCtpClient()

Returns the SphereClient responsible for interaction with the target CTP project.

Returns:

the SphereClient responsible for interaction with the target CTP project.

getErrorCallBack

@Nullable
public java.util.function.BiConsumer<java.lang.String,java.lang.Throwable> getErrorCallBack()

Returns the errorCallBack BiConsumer<String, Throwable> function set to this BaseSyncOptions. It represents the callback that is called whenever an event occurs during the sync process that represents an error.

Returns:

the errorCallBack BiConsumer<String, Throwable> function set to this BaseSyncOptions

getWarningCallBack

@Nullable
public java.util.function.Consumer<java.lang.String> getWarningCallBack()

Returns the warningCallBack Consumer<String> function set to this BaseSyncOptions. It represents the callback that is called whenever an event occurs during the sync process that represents a warning.

Returns:

the warningCallBack Consumer<String> function set to this BaseSyncOptions

shouldRemoveOtherLocales

public boolean shouldRemoveOtherLocales()

Returns a boolean flag which enables the sync module to add additional localizations without deleting existing ones, if set to false. If set to true, which is the default value of the option, it deletes the existing object properties.

Returns:

a boolean flag which enables the sync module to add additional localizations without deleting existing ones, if set to false. If set to true, which is the default value of the option, it deletes the existing object properties.

shouldRemoveOtherSetEntries

public boolean shouldRemoveOtherSetEntries()

Returns a boolean flag which enables the sync module to add additional Set entries without deleting existing ones, if set to false. If set to true, which is the default value of the option, it deletes the existing Set entries.

Returns:

a boolean flag which enables the sync module to add additional Set entries without deleting existing ones, if set to false. If set to true, which is the default value of the option, it deletes the existing Set entries.

shouldRemoveOtherCollectionEntries

public boolean shouldRemoveOtherCollectionEntries()

Returns a boolean flag which enables the sync module to add collection (e.g. Assets, Images etc.) entries without deleting existing ones, if set to false. If set to true, which is the default value of the option, it deletes the existing collection entries.

Returns:

a boolean flag which enables the sync module to add collection (e.g. Assets, Images etc.) entries without deleting existing ones, if set to false. If set to true, which is the default value of the option, it deletes the existing collection entries.

shouldRemoveOtherProperties

public boolean shouldRemoveOtherProperties()

Returns a boolean flag which enables the sync module to add additional object properties (e.g. custom fields, product attributes, etc..) without deleting existing ones, if set to false. If set to true, which is the default value of the option, it deletes the existing object properties.

Returns:

a boolean flag which enables the sync module to add additional object properties (e.g. custom fields, product attributes, etc..) without deleting existing ones, if set to false. If set to true, which is the default value of the option, it deletes the existing object properties.

applyWarningCallback

public void applyWarningCallback(@Nonnull
                                 java.lang.String warningMessage)

Given a warningMessage string, this method calls the warningCallBack function which is set to this instance of the BaseSyncOptions. If there warningCallBack is null, this method does nothing.

Parameters:

warningMessage - the warning message to supply to the warningCallBack function.

applyErrorCallback

public void applyErrorCallback(@Nonnull
                               java.lang.String errorMessage,
                               @Nullable
                               java.lang.Throwable exception)

Given an errorMessage and an exception, this method calls the errorCallBack function which is set to this instance of the BaseSyncOptions. If there errorCallBack is null, this method does nothing.

Parameters:

errorMessage - the error message to supply as first param to the errorCallBack function.

exception - optional Throwable instance to supply to the errorCallBack function as a second param.

applyErrorCallback

public void applyErrorCallback(@Nonnull
                               java.lang.String errorMessage)

Parameters:

errorMessage - the error message to supply as first param to the errorCallBack function.

See Also:

applyErrorCallback(String, Throwable)

shouldAllowUuidKeys

public boolean shouldAllowUuidKeys()

The sync expects the user to pass the keys to references in the id field of References. If the key values are in UUID format, then this flag must be set to true, otherwise the sync will fail to resolve the reference. This flag, if set to true, enables the user to use keys with UUID format. By default, it is set to false.

Returns:

a boolean flag, if set to true, enables the user to use keys with UUID format for references. By default, it is set to false.

getBatchSize

public int getBatchSize()

Gets the batch size used in the sync process. During the sync there is a need for fetching existing resources so that they can be compared with the new resource drafts. That's why the input is sliced into batches and then processed. It allows to reduce the query size for fetching all resources processed in one batch. E.g. value of 30 means that 30 entries from input list would be accumulated and one API call will be performed for fetching entries responding to them. Then comparision and sync are performed.

This batch size is set to 30 by default.

Returns:

option that indicates capacity of batch of resources to process.