com.commercetools.sync.services

Interface ChannelService

All Known Implementing Classes:

ChannelServiceImpl

public interface ChannelService

Method Summary

Modifier and Type	Method and Description
void	cacheChannel(io.sphere.sdk.channels.Channel channel) Adds a new mapping of key to id of the supplied channel to a cache map.
java.util.concurrent.CompletionStage<io.sphere.sdk.channels.Channel>	createAndCacheChannel(java.lang.String key) Creates a new channel with the supplied key and puts a new mapping of it's key to id in a cache map.
java.util.concurrent.CompletionStage<io.sphere.sdk.channels.Channel>	createChannel(java.lang.String key) Creates a new channel with the supplied key.
java.util.concurrent.CompletionStage<java.util.Optional<java.lang.String>>	fetchCachedChannelId(java.lang.String key) Given a key, this method first checks if a cached map of channel keys -> ids is not empty.

Method Detail

fetchCachedChannelId

@Nonnull
java.util.concurrent.CompletionStage<java.util.Optional<java.lang.String>> fetchCachedChannelId(@Nonnull
                                                                                                         java.lang.String key)

Given a key, this method first checks if a cached map of channel keys -> ids is not empty. If not, it returns a completed future that contains an optional that contains what this key maps to in the cache. If the cache is empty, the method populates the cache with the mapping of all channels' keys to ids in the CTP project, by querying the CTP project channels.

After that, the method returns a CompletionStage<Optional<String>> in which the result of it's completion could contain an Optional with the id inside of it or an empty Optional if no Channel was found in the CTP project with this key.

Parameters:

key - the key by which a Channel id should be fetched from the CTP project.

Returns:

CompletionStage<Optional<String>> in which the result of it's completion could contain an Optional with the id inside of it or an empty Optional if no Channel was found in the CTP project with this external id.

createChannel

@Nonnull
java.util.concurrent.CompletionStage<io.sphere.sdk.channels.Channel> createChannel(@Nonnull
                                                                                            java.lang.String key)

Creates a new channel with the supplied key.

Parameters:

key - key of supply channel.

Returns:

a future containing as a result the created Channel or a sphere exception.

createAndCacheChannel

@Nonnull
java.util.concurrent.CompletionStage<io.sphere.sdk.channels.Channel> createAndCacheChannel(@Nonnull
                                                                                                    java.lang.String key)

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

Parameters:

key - key of supply channel.

Returns:

a future containing as a result the created Channel or a sphere exception.

cacheChannel

void cacheChannel(@Nonnull
                  io.sphere.sdk.channels.Channel channel)

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

Parameters:

channel - key of supply channel