A B C E F G H I O P Q R S T U W

A

allowUuid - Variable in class com.commercetools.sync.commons.BaseSyncOptionsBuilder

applyErrorCallback(String, Throwable) - Method in class com.commercetools.sync.commons.BaseSyncOptions

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

applyWarningCallback(String) - Method in class com.commercetools.sync.commons.BaseSyncOptions

Given a warningMessage string, this method calls the warningCallBack function which is set to this instance of the BaseSyncOptions.

B

BaseReferenceResolver<T extends io.sphere.sdk.types.CustomDraft,S extends BaseSyncOptions> - Class in com.commercetools.sync.commons.helpers

This class is responsible for providing an abstract implementation of reference resolution on different CTP resources.

BaseReferenceResolver(S, TypeService) - Constructor for class com.commercetools.sync.commons.helpers.BaseReferenceResolver

BaseSync<T,U extends BaseSyncStatistics,V extends BaseSyncOptions> - Class in com.commercetools.sync.commons

BaseSync(U, V) - Constructor for class com.commercetools.sync.commons.BaseSync

BaseSyncOptions - Class in com.commercetools.sync.commons

BaseSyncOptions(SphereClient, BiConsumer<String, Throwable>, Consumer<String>, int, boolean, boolean, boolean, boolean, boolean) - Constructor for class com.commercetools.sync.commons.BaseSyncOptions

BaseSyncOptionsBuilder<T extends BaseSyncOptionsBuilder<T,S>,S extends BaseSyncOptions> - Class in com.commercetools.sync.commons

BaseSyncOptionsBuilder() - Constructor for class com.commercetools.sync.commons.BaseSyncOptionsBuilder

BaseSyncStatistics - Class in com.commercetools.sync.commons.helpers

BaseSyncStatistics() - Constructor for class com.commercetools.sync.commons.helpers.BaseSyncStatistics

BATCH_SIZE_DEFAULT - Static variable in class com.commercetools.sync.categories.CategorySyncOptionsBuilder

batchDrafts(List<T>, int) - Static method in class com.commercetools.sync.commons.utils.SyncUtils

Given a list of resource (e.g.

batchSize - Variable in class com.commercetools.sync.commons.BaseSyncOptionsBuilder

build() - Method in class com.commercetools.sync.categories.CategorySyncOptionsBuilder

Creates new instance of CategorySyncOptions enriched with all attributes provided to this builder.

build() - Method in class com.commercetools.sync.commons.BaseSyncOptionsBuilder

Creates new instance of S which extends BaseSyncOptions enriched with all attributes provided to this builder.

build() - Method in class com.commercetools.sync.inventories.InventorySyncOptionsBuilder

Returns new instance of InventorySyncOptions, enriched with all attributes provided to this builder.

buildActions(Category, CategoryDraft, CategorySyncOptions) - Static method in class com.commercetools.sync.categories.utils.CategorySyncUtils

Compares the Name, Slug, Description, Parent, OrderHint, MetaTitle, MetaDescription, MetaKeywords and Custom fields/ type fields and assets of a Category and a CategoryDraft.

buildActions(InventoryEntry, InventoryEntryDraft, InventorySyncOptions) - Static method in class com.commercetools.sync.inventories.utils.InventorySyncUtils

Compares the quantityOnStock, the restockableInDays, the expectedDelivery, the supply channel and Custom fields/ type fields of an InventoryEntry and an InventoryEntryDraft.

buildChangeNameUpdateAction(Category, CategoryDraft) - Static method in class com.commercetools.sync.categories.utils.CategoryUpdateActionUtils

Compares the LocalizedString names of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional.

buildChangeOrderHintUpdateAction(Category, CategoryDraft, CategorySyncOptions) - Static method in class com.commercetools.sync.categories.utils.CategoryUpdateActionUtils

Compares the orderHint values of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional.

buildChangeParentUpdateAction(Category, CategoryDraft, CategorySyncOptions) - Static method in class com.commercetools.sync.categories.utils.CategoryUpdateActionUtils

Compares the parents Reference<Category> of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional.

buildChangeQuantityAction(InventoryEntry, InventoryEntryDraft) - Static method in class com.commercetools.sync.inventories.utils.InventoryUpdateActionUtils

Compares the quantityOnStock values of an InventoryEntry and an InventoryEntryDraft and returns an Optional of update action, which would contain the "changeQuantity" UpdateAction.

buildChangeSlugUpdateAction(Category, CategoryDraft) - Static method in class com.commercetools.sync.categories.utils.CategoryUpdateActionUtils

Compares the LocalizedString slugs of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional.

buildCoreActions(Category, CategoryDraft, CategorySyncOptions) - Static method in class com.commercetools.sync.categories.utils.CategorySyncUtils

Compares the Name, Slug, externalID, Description, Parent, OrderHint, MetaTitle, MetaDescription, MetaKeywords and Custom fields/ type fields of a Category and a CategoryDraft.

buildCustomUpdateActions(T, S, BaseSyncOptions) - Static method in class com.commercetools.sync.commons.utils.CustomUpdateActionUtils

Compares the CustomFields of an old resource T (for example Category, Product, etc..), to the CustomFieldsDraft, of a new resource draft S (for example CategoryDraft, ProductVariantDraft, etc..), and returns a List<UpdateAction> as a result.

buildRemoveCustomTypeAction() - Method in class com.commercetools.sync.categories.helpers.CategoryCustomActionBuilder

buildRemoveCustomTypeAction() - Method in class com.commercetools.sync.channels.helpers.ChannelCustomActionBuilder

buildRemoveCustomTypeAction() - Method in class com.commercetools.sync.commons.helpers.GenericCustomActionBuilder

Creates a CTP "setCustomType" update action on the given resource T that removes the custom type set on the given resource T (which currently could either be a Category or a Channel).

buildRemoveCustomTypeAction() - Method in class com.commercetools.sync.inventories.helpers.InventoryCustomActionBuilder

buildSetCustomFieldAction(String, JsonNode) - Method in class com.commercetools.sync.categories.helpers.CategoryCustomActionBuilder

buildSetCustomFieldAction(String, JsonNode) - Method in class com.commercetools.sync.channels.helpers.ChannelCustomActionBuilder

buildSetCustomFieldAction(String, JsonNode) - Method in class com.commercetools.sync.commons.helpers.GenericCustomActionBuilder

Creates a CTP "setCustomField" update action on the given resource T that updates a custom field with customFieldName and a customFieldValue on the given resource T (which currently could either be a Category or a Channel).

buildSetCustomFieldAction(String, JsonNode) - Method in class com.commercetools.sync.inventories.helpers.InventoryCustomActionBuilder

buildSetCustomTypeAction(String, Map<String, JsonNode>) - Method in class com.commercetools.sync.categories.helpers.CategoryCustomActionBuilder

buildSetCustomTypeAction(String, Map<String, JsonNode>) - Method in class com.commercetools.sync.channels.helpers.ChannelCustomActionBuilder

buildSetCustomTypeAction(String, Map<String, JsonNode>) - Method in class com.commercetools.sync.commons.helpers.GenericCustomActionBuilder

Creates a CTP "setCustomType" update action on the given resource T (which currently could either be a Category or a Channel).

buildSetCustomTypeAction(String, Map<String, JsonNode>) - Method in class com.commercetools.sync.inventories.helpers.InventoryCustomActionBuilder

buildSetDescriptionUpdateAction(Category, CategoryDraft) - Static method in class com.commercetools.sync.categories.utils.CategoryUpdateActionUtils

Compares the LocalizedString descriptions of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional.

buildSetExpectedDeliveryAction(InventoryEntry, InventoryEntryDraft) - Static method in class com.commercetools.sync.inventories.utils.InventoryUpdateActionUtils

Compares the expectedDelivery values of an InventoryEntry and an InventoryEntryDraft and returns an Optional of update action, which would contain the "setExpectedDelivery" UpdateAction.

buildSetExternalIdUpdateAction(Category, CategoryDraft) - Static method in class com.commercetools.sync.categories.utils.CategoryUpdateActionUtils

Compares the externalId values of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional.

buildSetMetaDescriptionUpdateAction(Category, CategoryDraft) - Static method in class com.commercetools.sync.categories.utils.CategoryUpdateActionUtils

Compares the LocalizedString meta description of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional.

buildSetMetaKeywordsUpdateAction(Category, CategoryDraft) - Static method in class com.commercetools.sync.categories.utils.CategoryUpdateActionUtils

Compares the LocalizedString meta keywords of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional.

buildSetMetaTitleUpdateAction(Category, CategoryDraft) - Static method in class com.commercetools.sync.categories.utils.CategoryUpdateActionUtils

Compares the LocalizedString meta title of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional.

buildSetRestockableInDaysAction(InventoryEntry, InventoryEntryDraft) - Static method in class com.commercetools.sync.inventories.utils.InventoryUpdateActionUtils

Compares the restockableInDays values of an InventoryEntry and an InventoryEntryDraft and returns an Optional of update action, which would contain the "setRestockableInDays" UpdateAction.

buildSetSupplyChannelAction(InventoryEntry, InventoryEntryDraft) - Static method in class com.commercetools.sync.inventories.utils.InventoryUpdateActionUtils

Compares the supplyChannel references of an InventoryEntry and an InventoryEntryDraft and returns an Optional of update action, which would contain the "setSupplyChannel" UpdateAction.

buildUpdateAction(Object, Object, Supplier<UpdateAction<T>>) - Static method in class com.commercetools.sync.commons.utils.CommonTypeUpdateActionUtils

Compares two Object and returns a supplied UpdateAction as a result in an Optional.

BuildUpdateActionException - Exception in com.commercetools.sync.commons.exceptions

BuildUpdateActionException(String) - Constructor for exception com.commercetools.sync.commons.exceptions.BuildUpdateActionException

C

cacheChannel(Channel) - Method in interface com.commercetools.sync.services.ChannelService

Adds a new mapping of key to id of the supplied channel to a cache map.

cacheChannel(Channel) - Method in class com.commercetools.sync.services.impl.ChannelServiceImpl

cacheKeysToIds() - Method in interface com.commercetools.sync.services.CategoryService

If not already done once before, it fetches all the category keys from the CTP project defined in a potentially injected SphereClient and stores a mapping for every category to id in Map and returns this cached map.

cacheKeysToIds() - Method in class com.commercetools.sync.services.impl.CategoryServiceImpl

calculateProcessingTime() - Method in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

Calculates the processing time taken by the subtracting the time, when the BaseSyncStatistics.startTimer() method of this instance was called, from the current time in Milliseconds.

CategoryCustomActionBuilder - Class in com.commercetools.sync.categories.helpers

CategoryCustomActionBuilder() - Constructor for class com.commercetools.sync.categories.helpers.CategoryCustomActionBuilder

CategoryReferenceResolver - Class in com.commercetools.sync.categories.helpers

CategoryReferenceResolver(CategorySyncOptions, TypeService, CategoryService) - Constructor for class com.commercetools.sync.categories.helpers.CategoryReferenceResolver

CategoryService - Interface in com.commercetools.sync.services

CategoryServiceImpl - Class in com.commercetools.sync.services.impl

Implementation of CategoryService interface.

CategoryServiceImpl(CategorySyncOptions) - Constructor for class com.commercetools.sync.services.impl.CategoryServiceImpl

CategorySync - Class in com.commercetools.sync.categories

CategorySync(CategorySyncOptions) - Constructor for class com.commercetools.sync.categories.CategorySync

Takes a CategorySyncOptions instance to instantiate a new CategorySync instance that could be used to sync category drafts with the given categories in the CTP project specified in the injected CategorySyncOptions instance.

CategorySyncOptions - Class in com.commercetools.sync.categories

CategorySyncOptionsBuilder - Class in com.commercetools.sync.categories

CategorySyncStatistics - Class in com.commercetools.sync.categories.helpers

CategorySyncStatistics() - Constructor for class com.commercetools.sync.categories.helpers.CategorySyncStatistics

CategorySyncUtils - Class in com.commercetools.sync.categories.utils

CategorySyncUtils() - Constructor for class com.commercetools.sync.categories.utils.CategorySyncUtils

CategoryUpdateActionUtils - Class in com.commercetools.sync.categories.utils

CategoryUpdateActionUtils() - Constructor for class com.commercetools.sync.categories.utils.CategoryUpdateActionUtils

ChannelCustomActionBuilder - Class in com.commercetools.sync.channels.helpers

ChannelCustomActionBuilder() - Constructor for class com.commercetools.sync.channels.helpers.ChannelCustomActionBuilder

ChannelService - Interface in com.commercetools.sync.services

ChannelServiceImpl - Class in com.commercetools.sync.services.impl

ChannelServiceImpl(SphereClient, Set<ChannelRole>) - Constructor for class com.commercetools.sync.services.impl.ChannelServiceImpl

ClientConfigurationUtils - Class in com.commercetools.sync.commons.utils

ClientConfigurationUtils() - Constructor for class com.commercetools.sync.commons.utils.ClientConfigurationUtils

com.commercetools.sync.categories - package com.commercetools.sync.categories

com.commercetools.sync.categories.helpers - package com.commercetools.sync.categories.helpers

com.commercetools.sync.categories.utils - package com.commercetools.sync.categories.utils

com.commercetools.sync.channels.helpers - package com.commercetools.sync.channels.helpers

com.commercetools.sync.commons - package com.commercetools.sync.commons

com.commercetools.sync.commons.exceptions - package com.commercetools.sync.commons.exceptions

com.commercetools.sync.commons.helpers - package com.commercetools.sync.commons.helpers

com.commercetools.sync.commons.utils - package com.commercetools.sync.commons.utils

com.commercetools.sync.inventories - package com.commercetools.sync.inventories

com.commercetools.sync.inventories.helpers - package com.commercetools.sync.inventories.helpers

com.commercetools.sync.inventories.utils - package com.commercetools.sync.inventories.utils

com.commercetools.sync.products - package com.commercetools.sync.products

com.commercetools.sync.services - package com.commercetools.sync.services

com.commercetools.sync.services.impl - package com.commercetools.sync.services.impl

CommonTypeUpdateActionUtils - Class in com.commercetools.sync.commons.utils

CommonTypeUpdateActionUtils() - Constructor for class com.commercetools.sync.commons.utils.CommonTypeUpdateActionUtils

createAndCacheChannel(String) - Method in interface com.commercetools.sync.services.ChannelService

Creates a new channel with the supplied key and puts a new mapping of it's key to id in a cache map.

createAndCacheChannel(String) - Method in class com.commercetools.sync.services.impl.ChannelServiceImpl

createCategories(Set<CategoryDraft>) - Method in interface com.commercetools.sync.services.CategoryService

Given a Set of categoryDrafts, this method creates Categories corresponding to them in the CTP project defined in a potentially injected SphereClient.

createCategories(Set<CategoryDraft>) - Method in class com.commercetools.sync.services.impl.CategoryServiceImpl

createCategory(CategoryDraft) - Method in interface com.commercetools.sync.services.CategoryService

Given a CategoryDraft, this method creates a Category based on it in the CTP project defined in a potentially injected SphereClient.

createCategory(CategoryDraft) - Method in class com.commercetools.sync.services.impl.CategoryServiceImpl

createChannel(String) - Method in interface com.commercetools.sync.services.ChannelService

Creates a new channel with the supplied key.

createChannel(String) - Method in class com.commercetools.sync.services.impl.ChannelServiceImpl

createClient(SphereClientConfig, long, TimeUnit) - Static method in class com.commercetools.sync.commons.utils.ClientConfigurationUtils

Creates a BlockingSphereClient with a custom timeout with a custom TimeUnit.

createClient(SphereClientConfig) - Static method in class com.commercetools.sync.commons.utils.ClientConfigurationUtils

Creates a BlockingSphereClient with a default timeout value of 30 seconds.

createInventoryEntry(InventoryEntryDraft) - Method in class com.commercetools.sync.services.impl.InventoryServiceImpl

createInventoryEntry(InventoryEntryDraft) - Method in interface com.commercetools.sync.services.InventoryService

Creates new inventory entry from inventoryEntryDraft.

ctpClient - Variable in class com.commercetools.sync.commons.BaseSyncOptionsBuilder

CtpQueryUtils - Class in com.commercetools.sync.commons.utils

CustomUpdateActionUtils - Class in com.commercetools.sync.commons.utils

CustomUpdateActionUtils() - Constructor for class com.commercetools.sync.commons.utils.CustomUpdateActionUtils

E

ensureChannels(boolean) - Method in class com.commercetools.sync.inventories.InventorySyncOptionsBuilder

Set option that indicates whether sync process should create supply channel of given key when it doesn't exists in a target project yet.

equals(Object) - Method in class com.commercetools.sync.inventories.helpers.InventoryEntryIdentifier

errorCallBack - Variable in class com.commercetools.sync.commons.BaseSyncOptionsBuilder

F

fetchCachedCategoryId(String) - Method in interface com.commercetools.sync.services.CategoryService

Given a key, this method first checks if cached map of category keys -> ids is not empty.

fetchCachedCategoryId(String) - Method in class com.commercetools.sync.services.impl.CategoryServiceImpl

fetchCachedChannelId(String) - Method in interface com.commercetools.sync.services.ChannelService

Given a key, this method first checks if a cached map of channel keys -> ids is not empty.

fetchCachedChannelId(String) - Method in class com.commercetools.sync.services.impl.ChannelServiceImpl

fetchCachedTypeId(String) - Method in class com.commercetools.sync.services.impl.TypeServiceImpl

fetchCachedTypeId(String) - Method in interface com.commercetools.sync.services.TypeService

Given a key, this method first checks if a cached map of Type keys -> ids is not empty.

fetchInventoryEntriesBySkus(Set<String>) - Method in class com.commercetools.sync.services.impl.InventoryServiceImpl

fetchInventoryEntriesBySkus(Set<String>) - Method in interface com.commercetools.sync.services.InventoryService

Queries existing InventoryEntry's against set of skus.

fetchMatchingCategoriesByKeys(Set<String>) - Method in interface com.commercetools.sync.services.CategoryService

Given a Set of category keys, this method fetches a set of all the categories matching this given set of keys in the CTP project defined in a potentially injected SphereClient.

fetchMatchingCategoriesByKeys(Set<String>) - Method in class com.commercetools.sync.services.impl.CategoryServiceImpl

G

GenericCustomActionBuilder<T extends io.sphere.sdk.types.Custom & io.sphere.sdk.models.Resource<T>> - Class in com.commercetools.sync.commons.helpers

A Generic Custom update action builder that creates update actions that are of the same type as the Generic type T provided by the subclass of this abstract class.

GenericCustomActionBuilder() - Constructor for class com.commercetools.sync.commons.helpers.GenericCustomActionBuilder

GenericCustomActionBuilderFactory<T extends io.sphere.sdk.types.Custom & io.sphere.sdk.models.Resource<T>,S extends GenericCustomActionBuilder<T>> - Class in com.commercetools.sync.commons.helpers

Factory class that has the main objective of creating an instance of the of a concrete implementation of the GenericCustomActionBuilder, which is responsible for building custom update actions, according to the type of the resource instance provided to the GenericCustomActionBuilderFactory.of(Custom) function.

GenericCustomActionBuilderFactory() - Constructor for class com.commercetools.sync.commons.helpers.GenericCustomActionBuilderFactory

getBatchSize() - Method in class com.commercetools.sync.commons.BaseSyncOptions

Gets the batch size used in the sync process.

getCategoryKeysWithMissingParents() - Method in class com.commercetools.sync.categories.helpers.CategorySyncStatistics

getCreated() - Method in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

Gets the total number of resources that were created.

getCtpClient() - Method in class com.commercetools.sync.commons.BaseSyncOptions

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

getCustomTypeId(CustomFieldsDraft, String) - Method in class com.commercetools.sync.commons.helpers.BaseReferenceResolver

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

getErrorCallBack() - Method in class com.commercetools.sync.commons.BaseSyncOptions

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

getFailed() - Method in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

Gets the total number of resources that failed to sync.

getInventoryEntryChannelId() - Method in class com.commercetools.sync.inventories.helpers.InventoryEntryIdentifier

getInventoryEntrySku() - Method in class com.commercetools.sync.inventories.helpers.InventoryEntryIdentifier

getKeyFromExpansionOrReference(boolean, String, Reference) - Static method in class com.commercetools.sync.commons.helpers.BaseReferenceResolver

Given a key value (keyFromExpansion) which is potentially fetched from the expansion of a reference.

getLatestBatchHumanReadableProcessingTime() - Method in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

Gets the human readable processing time in the following format @{code "0d, 0h, 0m, 2s, 545ms"}.

getLatestBatchProcessingTimeInDays() - Method in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

Gets the number of days it took to process.

getLatestBatchProcessingTimeInHours() - Method in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

Gets the number of hours it took to process.

getLatestBatchProcessingTimeInMillis() - Method in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

Gets the number of milliseconds it took to process.

getLatestBatchProcessingTimeInMinutes() - Method in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

Gets the number of minutes it took to process.

getLatestBatchProcessingTimeInSeconds() - Method in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

Gets the number of seconds it took to process.

getOptions() - Method in class com.commercetools.sync.commons.helpers.BaseReferenceResolver

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

getParentCategoryKey(CategoryDraft, boolean) - Static method in class com.commercetools.sync.categories.helpers.CategoryReferenceResolver

Given a categoryDraft, this method first checks if there is a parent category reference set.

getProcessed() - Method in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

Gets the total number of resources that were processed/synced.

getReportMessage() - Method in class com.commercetools.sync.categories.helpers.CategorySyncStatistics

Builds a summary of the category sync statistics instance that looks like the following example:

getReportMessage() - Method in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

Gets a summary message of the statistics report.

getReportMessage() - Method in class com.commercetools.sync.inventories.helpers.InventorySyncStatistics

Builds a summary of the inventory sync statistics instance that looks like the following example:

getStatistics() - Method in class com.commercetools.sync.commons.BaseSync

Returns an instance of type U which is a subclass of BaseSyncStatistics containing all the stats of the sync process; which includes a report message, the total number of update, created, failed, processed resources and the processing time of the sync in different time units and in a human readable format.

getThis() - Method in class com.commercetools.sync.categories.CategorySyncOptionsBuilder

Returns an instance of this class to be used in the super class generic methods.

getThis() - Method in class com.commercetools.sync.commons.BaseSyncOptionsBuilder

Returns this instance of T, which extends BaseSyncOptionsBuilder.

getThis() - Method in class com.commercetools.sync.inventories.InventorySyncOptionsBuilder

Returns this instance of InventorySyncOptionsBuilder.

getUpdateActionsFilter() - Method in class com.commercetools.sync.categories.CategorySyncOptions

Returns the updateActionsFilter Function<List<UpdateAction< Category>>, List<UpdateAction<Category>>> function set to this CategorySyncOptions.

getUpdated() - Method in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

Gets the total number of resources that were updated.

getWarningCallBack() - Method in class com.commercetools.sync.commons.BaseSyncOptions

Returns the warningCallBack Consumer<String> function set to this BaseSyncOptions.

H

hashCode() - Method in class com.commercetools.sync.inventories.helpers.InventoryEntryIdentifier

I

incrementCreated() - Method in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

Increments the total number of resource that were created.

incrementCreated(int) - Method in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

Increments the total number of resources that were created by the supplied times.

incrementFailed() - Method in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

Increments the total number of resources that failed to sync.

incrementFailed(int) - Method in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

Increments the total number of resources that failed to sync by the supplied times.

incrementProcessed() - Method in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

Increments the total number of resources that were processed/synced.

incrementProcessed(int) - Method in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

Increments the total number of resources that were processed/synced by the supplied times.

incrementUpdated() - Method in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

Increments the total number of resource that were updated.

incrementUpdated(int) - Method in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

Increments the total number of resources that were updated by the supplied times.

invalidateCache() - Method in interface com.commercetools.sync.services.ChannelService

Invalidates the state of the cache so that on the next fetch a fresh copy is fetched and cached.

invalidateCache() - Method in class com.commercetools.sync.services.impl.ChannelServiceImpl

invalidateCache() - Method in class com.commercetools.sync.services.impl.TypeServiceImpl

invalidateCache() - Method in interface com.commercetools.sync.services.TypeService

Invalidates the state of the cache so that on the next fetch a fresh copy is fetched and cached.

InventoryCustomActionBuilder - Class in com.commercetools.sync.inventories.helpers

InventoryCustomActionBuilder() - Constructor for class com.commercetools.sync.inventories.helpers.InventoryCustomActionBuilder

InventoryEntryIdentifier - Class in com.commercetools.sync.inventories.helpers

This class provides as a container of the unique identifier of an InventoryEntry for the sync which is a combination of both the SKU of the inventory entry and the supply channel if of this inventory entry.

InventoryReferenceResolver - Class in com.commercetools.sync.inventories.helpers

InventoryReferenceResolver(InventorySyncOptions, TypeService, ChannelService) - Constructor for class com.commercetools.sync.inventories.helpers.InventoryReferenceResolver

InventoryService - Interface in com.commercetools.sync.services

InventoryServiceImpl - Class in com.commercetools.sync.services.impl

InventoryServiceImpl(SphereClient) - Constructor for class com.commercetools.sync.services.impl.InventoryServiceImpl

InventorySync - Class in com.commercetools.sync.inventories

Default implementation of inventories sync process.

InventorySync(InventorySyncOptions) - Constructor for class com.commercetools.sync.inventories.InventorySync

Takes a InventorySyncOptions instance to instantiate a new InventorySync instance that could be used to sync inventory drafts with the given inventory entries in the CTP project specified in the injected InventorySyncOptions instance.

InventorySyncOptions - Class in com.commercetools.sync.inventories

InventorySyncOptionsBuilder - Class in com.commercetools.sync.inventories

Builder for creation of InventorySyncOptions.

InventorySyncStatistics - Class in com.commercetools.sync.inventories.helpers

InventorySyncStatistics() - Constructor for class com.commercetools.sync.inventories.helpers.InventorySyncStatistics

InventorySyncUtils - Class in com.commercetools.sync.inventories.utils

This class provides factory methods for assembling update actions of inventory entries.

InventoryUpdateActionUtils - Class in com.commercetools.sync.inventories.utils

This class provides static utility methods for building update actions related to inventories.

isReferenceExpanded(Reference) - Static method in class com.commercetools.sync.commons.helpers.BaseReferenceResolver

Helper method to check if passed Reference instance is expanded.

O

of(SphereClient) - Static method in class com.commercetools.sync.categories.CategorySyncOptionsBuilder

Creates a new instance of CategorySyncOptionsBuilder given a SphereClient responsible for interaction with the target CTP project, with the dafult batch size (BATCH_SIZE_DEFAULT = 50).

of(U) - Static method in class com.commercetools.sync.commons.helpers.GenericCustomActionBuilderFactory

Given a resource of the type U which represents a CTP resource (currently either Category or Channel) creates an instance of the concrete implementation of the GenericCustomActionBuilder, which is responsible for building custom update actions, according to the type of the resource instance provided.

of(InventoryEntryDraft) - Static method in class com.commercetools.sync.inventories.helpers.InventoryEntryIdentifier

Builds an InventoryEntryIdentifier instance given an InventoryEntryDraft using it's sku and supply channel id.

of(InventoryEntry) - Static method in class com.commercetools.sync.inventories.helpers.InventoryEntryIdentifier

Builds an InventoryEntryIdentifier instance given an InventoryEntry using it's sku and supply channel id.

of(String, String) - Static method in class com.commercetools.sync.inventories.helpers.InventoryEntryIdentifier

Builds an InventoryEntryIdentifier instance given an sku and supply channel id.

of(SphereClient) - Static method in class com.commercetools.sync.inventories.InventorySyncOptionsBuilder

Creates a new instance of InventorySyncOptionsBuilder given a SphereClient responsible for interaction with the target CTP project, with the dafult batch size (BATCH_SIZE_DEFAULT = 150).

P

process(List<CategoryDraft>) - Method in class com.commercetools.sync.categories.CategorySync

Given a list of CategoryDraft that represent a batch of category drafts, this method for the first batch only caches a list of all the categories in the CTP project in a cached map that representing each category's key to the id.

process(List<T>) - Method in class com.commercetools.sync.commons.BaseSync

Given a list of resource (e.g.

process(List<InventoryEntryDraft>) - Method in class com.commercetools.sync.inventories.InventorySync

Iterates through the whole inventories list and accumulates its valid drafts to batches.

processBatch(List<CategoryDraft>) - Method in class com.commercetools.sync.categories.CategorySync

Given a list of CategoryDraft that represent a batch of category drafts, this method for the first batch only caches a list of all the categories in the CTP project in a cached map that representing each category's key to the id.

processBatch(List<T>) - Method in class com.commercetools.sync.commons.BaseSync

processBatch(List<InventoryEntryDraft>) - Method in class com.commercetools.sync.inventories.InventorySync

Fetches existing InventoryEntry objects from CTP project that correspond to passed batchOfDrafts.

ProductSyncOptions - Class in com.commercetools.sync.products

This Class is a WIP and should be reimplemented when the Product Sync module is implemented.

Q

queryAll(SphereClient, QueryDsl<T, C>, Function<List<T>, S>) - Static method in class com.commercetools.sync.commons.utils.CtpQueryUtils

Queries all elements matching a query by using an offset based pagination with page size 500.

queryAll(SphereClient, QueryDsl<T, C>, Consumer<List<T>>) - Static method in class com.commercetools.sync.commons.utils.CtpQueryUtils

Queries all elements matching a query by using an offset based pagination with page size 500.

queryAll(SphereClient, QueryDsl<T, C>, Function<List<T>, S>, int) - Static method in class com.commercetools.sync.commons.utils.CtpQueryUtils

Queries all elements matching a query by using an offset based pagination.

queryAll(SphereClient, QueryDsl<T, C>, Consumer<List<T>>, int) - Static method in class com.commercetools.sync.commons.utils.CtpQueryUtils

Queries all elements matching a query by using an offset based pagination.

R

ReferenceResolutionException - Exception in com.commercetools.sync.commons.exceptions

ReferenceResolutionException(String) - Constructor for exception com.commercetools.sync.commons.exceptions.ReferenceResolutionException

ReferenceResolutionException(String, Throwable) - Constructor for exception com.commercetools.sync.commons.exceptions.ReferenceResolutionException

removeOtherCollectionEntries - Variable in class com.commercetools.sync.commons.BaseSyncOptionsBuilder

removeOtherLocales - Variable in class com.commercetools.sync.commons.BaseSyncOptionsBuilder

removeOtherProperties - Variable in class com.commercetools.sync.commons.BaseSyncOptionsBuilder

removeOtherSetEntries - Variable in class com.commercetools.sync.commons.BaseSyncOptionsBuilder

replaceCategoriesReferenceIdsWithKeys(List<Category>) - Static method in class com.commercetools.sync.commons.utils.SyncUtils

Takes a list of Categories that are supposed to have their custom type and parent category reference expanded in order to be able to fetch the keys and replace the reference ids with the corresponding keys and then return a new list of category drafts with their references containing keys instead of the ids.

replaceInventoriesReferenceIdsWithKeys(List<InventoryEntry>) - Static method in class com.commercetools.sync.commons.utils.SyncUtils

Takes a list of inventoryEntries that are supposed to have their custom type reference expanded in order to be able to fetch the keys and replace the reference ids with the corresponding keys and then return a new list of inventory entry drafts with their references containing keys instead of the ids.

reportMessage - Variable in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

resolveCustomTypeReference(CategoryDraft) - Method in class com.commercetools.sync.categories.helpers.CategoryReferenceResolver

resolveCustomTypeReference(T) - Method in class com.commercetools.sync.commons.helpers.BaseReferenceResolver

Given a draft of T (e.g.

resolveCustomTypeReference(InventoryEntryDraft) - Method in class com.commercetools.sync.inventories.helpers.InventoryReferenceResolver

resolveReferences(CategoryDraft) - Method in class com.commercetools.sync.categories.helpers.CategoryReferenceResolver

Given a CategoryDraft this method attempts to resolve the custom type and parent category references to return a CompletionStage which contains a new instance of the draft with the resolved references.

resolveReferences(InventoryEntryDraft) - Method in class com.commercetools.sync.inventories.helpers.InventoryReferenceResolver

Given a InventoryEntryDraft this method attempts to resolve the custom type and supply channel references to return a CompletionStage which contains a new instance of the draft with the resolved references.

S

setAllowUuidKeys(boolean) - Method in class com.commercetools.sync.commons.BaseSyncOptionsBuilder

The sync expects the user to pass the keys to references in the id field of References.

setBatchSize(int) - Method in class com.commercetools.sync.commons.BaseSyncOptionsBuilder

Set option that indicates batch size for sync process.

setCategoryKeysWithMissingParents(Map<String, ArrayList<String>>) - Method in class com.commercetools.sync.categories.helpers.CategorySyncStatistics

setErrorCallBack(BiConsumer<String, Throwable>) - Method in class com.commercetools.sync.commons.BaseSyncOptionsBuilder

Sets the errorCallBack function of the sync module.

setRemoveOtherCollectionEntries(boolean) - Method in class com.commercetools.sync.commons.BaseSyncOptionsBuilder

Sets the removeOtherSetEntries boolean flag which adds collection (e.g.

setRemoveOtherLocales(boolean) - Method in class com.commercetools.sync.commons.BaseSyncOptionsBuilder

Sets the removeOtherLocales boolean flag which adds additional localizations without deleting existing ones.

setRemoveOtherProperties(boolean) - Method in class com.commercetools.sync.commons.BaseSyncOptionsBuilder

Sets the removeOtherProperties boolean flag which adds additional object properties (e.g.

setRemoveOtherSetEntries(boolean) - Method in class com.commercetools.sync.commons.BaseSyncOptionsBuilder

Sets the removeOtherSetEntries boolean flag which adds additional Set entries without deleting existing ones.

setUpdateActionsFilter(Function<List<UpdateAction<Category>>, List<UpdateAction<Category>>>) - Method in class com.commercetools.sync.categories.CategorySyncOptionsBuilder

Sets the updateActions filter function which can be applied on generated list of update actions to produce a resultant list after the filter function has been applied.

setWarningCallBack(Consumer<String>) - Method in class com.commercetools.sync.commons.BaseSyncOptionsBuilder

Sets the warningCallBack function of the sync module.

shouldAllowUuidKeys() - Method in class com.commercetools.sync.commons.BaseSyncOptions

The sync expects the user to pass the keys to references in the id field of References.

shouldEnsureChannels() - Method in class com.commercetools.sync.inventories.InventorySyncOptions

shouldRemoveOtherCollectionEntries() - Method in class com.commercetools.sync.commons.BaseSyncOptions

Returns a boolean flag which enables the sync module to add collection (e.g.

shouldRemoveOtherLocales() - Method in class com.commercetools.sync.commons.BaseSyncOptions

Returns a boolean flag which enables the sync module to add additional localizations without deleting existing ones, if set to false.

shouldRemoveOtherProperties() - Method in class com.commercetools.sync.commons.BaseSyncOptions

Returns a boolean flag which enables the sync module to add additional object properties (e.g.

shouldRemoveOtherSetEntries() - Method in class com.commercetools.sync.commons.BaseSyncOptions

Returns a boolean flag which enables the sync module to add additional Set entries without deleting existing ones, if set to false.

startTimer() - Method in class com.commercetools.sync.commons.helpers.BaseSyncStatistics

Stores the current time of instantiation in the latestBatchStartTime instance variable that will be used later when BaseSyncStatistics.calculateProcessingTime() is called to calculate the total time of processing.

statistics - Variable in class com.commercetools.sync.commons.BaseSync

sync(List<T>) - Method in class com.commercetools.sync.commons.BaseSync

Given a list of resource (e.g.

syncBatches(List<List<CategoryDraft>>, CompletionStage<CategorySyncStatistics>) - Method in class com.commercetools.sync.categories.CategorySync

syncBatches(List<List<T>>, CompletionStage<U>) - Method in class com.commercetools.sync.commons.BaseSync

Given a list of resource (e.g.

syncBatches(List<List<InventoryEntryDraft>>, CompletionStage<InventorySyncStatistics>) - Method in class com.commercetools.sync.inventories.InventorySync

syncOptions - Variable in class com.commercetools.sync.commons.BaseSync

SyncUtils - Class in com.commercetools.sync.commons.utils

SyncUtils() - Constructor for class com.commercetools.sync.commons.utils.SyncUtils

T

TypeService - Interface in com.commercetools.sync.services

TypeServiceImpl - Class in com.commercetools.sync.services.impl

Implementation of TypeService interface.

TypeServiceImpl(SphereClient) - Constructor for class com.commercetools.sync.services.impl.TypeServiceImpl

U

updateCategory(Category, List<UpdateAction<Category>>) - Method in interface com.commercetools.sync.services.CategoryService

Given a Category and a List<UpdateAction<Category>>, this method issues an update request with these update actions on this Category in the CTP project defined in a potentially injected SphereClient.

updateCategory(Category, List<UpdateAction<Category>>) - Method in class com.commercetools.sync.services.impl.CategoryServiceImpl

updateInventoryEntry(InventoryEntry, List<UpdateAction<InventoryEntry>>) - Method in class com.commercetools.sync.services.impl.InventoryServiceImpl

updateInventoryEntry(InventoryEntry, List<UpdateAction<InventoryEntry>>) - Method in interface com.commercetools.sync.services.InventoryService

Updates existing inventory entry with updateActions.

W

warningCallBack - Variable in class com.commercetools.sync.commons.BaseSyncOptionsBuilder

A B C E F G H I O P Q R S T U W